Part No. 060394-10, Rev.

B
November 2015

OmniSwitch AOS Release 8

CLI Reference Guide

enterprise.alcatel-lucent.com
 This user guide documents AOS Release 8 for the OmniSwitch 6860 and OmniSwitch 6860E.
The functionality described in this guide is subject to change without notice.

enterprise.alcatel-lucent.com Alcatel-Lucent and the Alcatel-Lucent Enterprise logo are trademarks of

Alcatel-Lucent. To view other trademarks used by affiliated companies of ALE Holding, visit: enter-
prise.alcatel-lucent.com/trademarks. All other trademarks are the property of their respective owners. The
information presented is subject to change without notice. Neither ALE Holding nor any of its affiliates
assumes any responsibility for inaccuracies contained herein. (July 2015)

26801 West Agoura Road

Calabasas, CA 91301
(818) 880-3500 FAX (818) 880-3505
support@ind.alcatel.com

Service & Support Contact Information

North America: 800-995-2696
Latin America : 877-919-9526
EMEA : +800 00200100 (Toll Free) or +1(650)385-2193
Asia Pacific: +65 6240 8484
Web: service.esd.alcatel-lucent.com
Email: esd.support@alcatel-lucent.com
Contents

About This Guide ......................................................................................................... xli

Supported Platforms ......................................................................................................... xli
Who Should Read this Manual? ....................................................................................... xli
When Should I Read this Manual? ................................................................................... xli
What is in this Manual? ...................................................................................................xlii
What is Not in this Manual? ............................................................................................xlii
How is the Information Organized? ................................................................................xlii
Text Conventions ...........................................................................................................xliii
Documentation Roadmap ............................................................................................... xliv
Related Documentation .................................................................................................. xlvi
Technical Support .........................................................................................................xlvii

Chapter 1 Ethernet Port Commands ......................................................................................... 1-1

interfaces ..................................................................................................................1-3
interfaces speed ........................................................................................................1-5
interfaces duplex ......................................................................................................1-7
interfaces alias ..........................................................................................................1-9
clear interfaces ........................................................................................................1-10
interfaces max-frame-size ......................................................................................1-11
interfaces flood-limit ..............................................................................................1-12
interfaces flood-limit action ...................................................................................1-14
interfaces ingress-bandwidth ..................................................................................1-16
interfaces pause ......................................................................................................1-17
interfaces link-trap ..................................................................................................1-19
interfaces ddm ........................................................................................................1-20
interfaces ddm-trap .................................................................................................1-21
interfaces wait-to-restore ........................................................................................1-22
interfaces wait-to-shutdown ...................................................................................1-24
interfaces eee ..........................................................................................................1-26
clear violation .........................................................................................................1-27
violation recovery-maximum .................................................................................1-29
violation recovery-time ..........................................................................................1-31
violation recovery-trap ...........................................................................................1-33
show interfaces .......................................................................................................1-34
show interfaces alias ...............................................................................................1-38
show interfaces status .............................................................................................1-40
show interfaces capability ......................................................................................1-42
show interfaces accounting ....................................................................................1-44
show interfaces counters ........................................................................................1-46
show interfaces counters errors ..............................................................................1-48

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 iii

 Contents

show interfaces flood-rate ......................................................................................1-50

show interfaces traffic ............................................................................................1-52
show interfaces ingress-rate-limit ..........................................................................1-54
show interfaces ddm ...............................................................................................1-56
show transceivers ...................................................................................................1-59
show violation ........................................................................................................1-61
show violation-recovery-configuration ..................................................................1-63
interfaces link-monitoring admin-status .................................................................1-65
interfaces link-monitoring time-window ................................................................1-67
interfaces link-monitoring link-flap-threshold .......................................................1-69
interfaces link-monitoring link-error-threshold .....................................................1-71
interfaces clear-link-monitoring-stats ....................................................................1-73
show interfaces link-monitoring config .................................................................1-75
show interfaces link-monitoring statistics ..............................................................1-78
link-fault-propagation group ..................................................................................1-80
link-fault-propagation group source .......................................................................1-82
link-fault-propagation group destination ................................................................1-84
link-fault-propagation group wait-to-shutdown .....................................................1-86
show link-fault-propagation group .........................................................................1-87
interfaces tdr ...........................................................................................................1-89
show interfaces tdr-statistics ..................................................................................1-90

Chapter 2 Power over Ethernet (PoE) Commands ................................................................ 2-1

lanpower slot service ................................................................................................2-3
lanpower port admin-state ........................................................................................2-4
lanpower type ...........................................................................................................2-5
lanpower power ........................................................................................................2-6
lanpower power ........................................................................................................2-6
lanpower slot maxpower ..........................................................................................2-8
lanpower priority ....................................................................................................2-10
lanpower slot priority-disconnect ...........................................................................2-12
lanpower power-rule ..............................................................................................2-14
lanpower power-policy ...........................................................................................2-17
lanpower slot class-detection .................................................................................2-19
lanpower capacitor-detection .................................................................................2-20
lanpower slot usage-threshold ................................................................................2-21
lanpower slot update-from .....................................................................................2-22
show lanpower slot .................................................................................................2-23
show lanpower power-rule .....................................................................................2-26
show lanpower power-policy .................................................................................2-28
show lanpower slot class-detection ........................................................................2-30
show lanpower slot capacitor-detection .................................................................2-31
show lanpower slot priority-disconnect .................................................................2-32
show lanpower slot usage-threshold ......................................................................2-33
show lanpower slot update-from ............................................................................2-34

Chapter 3 UDLD Commands ....................................................................................................... 3-1

udld ...........................................................................................................................3-2
udld port ...................................................................................................................3-3
udld mode .................................................................................................................3-5
udld probe-timer .......................................................................................................3-7
udld echo-wait-timer ................................................................................................3-9

iv OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Contents

clear udld statistics port ..........................................................................................3-11

show udld configuration .........................................................................................3-12
show udld configuration port .................................................................................3-14
show udld statistics port .........................................................................................3-16
show udld neighbor port .........................................................................................3-18
show udld status port ..............................................................................................3-20

Chapter 4 Source Learning Commands ................................................................................... 4-1

mac-learning .............................................................................................................4-2
mac-learning flush ....................................................................................................4-4
mac-learning flush domain .......................................................................................4-5
mac-learning static mac-address ..............................................................................4-7
mac-learning multicast mac-address ........................................................................4-9
mac-learning aging-time ........................................................................................4-11
mac-learning mode .................................................................................................4-13
show mac-learning .................................................................................................4-14
show mac-learning domain ....................................................................................4-18
show mac-learning remote .....................................................................................4-22
show mac-learning aging-time ...............................................................................4-25
show mac-learning learning-state ...........................................................................4-26
show mac-learning mode .......................................................................................4-28
mac-ping .................................................................................................................4-29

Chapter 5 VLAN Management Commands ............................................................................. 5-1

vlan ...........................................................................................................................5-2
vlan members untagged ............................................................................................5-4
vlan members tagged ................................................................................................5-6
vlan mtu-ip ...............................................................................................................5-8
show vlan ................................................................................................................5-10
show vlan members ................................................................................................5-13

Chapter 6 High Availability VLAN Commands ...................................................................... 6-1

server-cluster ............................................................................................................6-2
server-cluster vlan ....................................................................................................6-4
server-cluster mac-address .......................................................................................6-6
server-cluster ip ........................................................................................................6-8
server-cluster igmp mode .......................................................................................6-10
server-cluster ip-multicast ......................................................................................6-12
server-cluster port ...................................................................................................6-14
server-cluster linkagg .............................................................................................6-16
show server-cluster .................................................................................................6-18

Chapter 7 Distributed Spanning Tree Commands ................................................................ 7-1

spantree mode ...........................................................................................................7-3
spantree protocol ......................................................................................................7-5
spantree vlan admin-state .........................................................................................7-7
spantree mst region name .........................................................................................7-8
spantree mst region revision-level ..........................................................................7-10
spantree mst region max-hops ................................................................................7-11
spantree msti ...........................................................................................................7-13
spantree msti vlan ...................................................................................................7-15
spantree priority ......................................................................................................7-17

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 v

 Contents

spantree hello-time .................................................................................................7-20

spantree max-age ....................................................................................................7-22
spantree forward-delay ...........................................................................................7-24
spantree bpdu-switching .........................................................................................7-26
spantree path-cost-mode .........................................................................................7-28
spantree pvst+compatibility ...................................................................................7-30
spantree auto-vlan-containment .............................................................................7-32
spantree cist ............................................................................................................7-34
spantree vlan ...........................................................................................................7-36
spantree cist path-cost ............................................................................................7-38
spantree msti path-cost ...........................................................................................7-41
spantree vlan path-cost ...........................................................................................7-44
spantree cist mode ..................................................................................................7-47
spantree loop-guard ................................................................................................7-49
spantree vlan mode .................................................................................................7-51
spantree cist connection .........................................................................................7-53
spantree vlan connection ........................................................................................7-55
spantree cist admin-edge ........................................................................................7-57
spantree vlan admin-edge .......................................................................................7-59
spantree cist auto-edge ...........................................................................................7-61
spantree vlan auto-edge ..........................................................................................7-63
spantree cist restricted-role .....................................................................................7-65
spantree vlan restricted-role ...................................................................................7-67
spantree cist restricted-tcn ......................................................................................7-69
spantree vlan restricted-tcn .....................................................................................7-71
spantree cist txholdcount ........................................................................................7-73
spantree vlan txholdcount .......................................................................................7-74
show spantree .........................................................................................................7-75
show spantree cist ...................................................................................................7-78
show spantree msti .................................................................................................7-82
show spantree vlan .................................................................................................7-87
show spantree ports ................................................................................................7-91
show spantree cist ports ..........................................................................................7-95
show spantree msti ports ........................................................................................7-99
show spantree vlan ports ......................................................................................7-104
show spantree mode .............................................................................................7-110
show spantree mst ................................................................................................7-112
show spantree msti vlan-map ...............................................................................7-115
show spantree cist vlan-map ................................................................................7-117
show spantree map-msti .......................................................................................7-119

Chapter 8 Shortest Path Bridging Commands ....................................................................... 8-1

spb bvlan ..................................................................................................................8-3
spb isis bvlan ect-id ..................................................................................................8-5
spb isis control-bvlan ...............................................................................................8-6
spb isis bvlan tandem-multicast-mode .....................................................................8-7
spb isis bridge-priority .............................................................................................8-8
spb isis interface .......................................................................................................8-9
spb ipvpn bind ........................................................................................................8-11
spb ipvpn redist ......................................................................................................8-13
show spb ipvpn bind ...............................................................................................8-15
show spb ipvpn redist .............................................................................................8-17

vi OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Contents

show spb ipvpn route-table ....................................................................................8-19

spb isis admin-state ................................................................................................8-21
spb isis area-address ...............................................................................................8-22
spb isis source-id ....................................................................................................8-23
spb isis control-address ..........................................................................................8-24
spb isis spf-wait ......................................................................................................8-25
spb isis lsp-wait ......................................................................................................8-27
spb isis overload .....................................................................................................8-29
spb isis overload-on-boot .......................................................................................8-31
spb isis graceful-restart ...........................................................................................8-33
spb isis graceful-restart helper ................................................................................8-34
show spb isis info ...................................................................................................8-35
show spb isis bvlans ...............................................................................................8-38
show spb isis interface ............................................................................................8-40
show spb isis adjacency ..........................................................................................8-42
show spb isis database ............................................................................................8-45
show spb isis nodes ................................................................................................8-48
show spb isis unicast-table .....................................................................................8-50
show spb isis services .............................................................................................8-52
show spb isis spf .....................................................................................................8-54
show spb isis multicast-table ..................................................................................8-56
show spb isis multicast-sources ..............................................................................8-58
show spb isis multicast-sources-spf .......................................................................8-60
show spb isis ingress-mac-filter .............................................................................8-62

Chapter 9 Loopback Detection Commands ............................................................................ 9-1

loopback-detection ...................................................................................................9-2
loopback-detection port ............................................................................................9-4
loopback-detection service-access ...........................................................................9-6
loopback-detection transmission-timer ....................................................................9-8
loopback-detection autorecovery-timer ....................................................................9-9
show loopback-detection ........................................................................................9-10
show loopback-detection port ................................................................................9-12
show loopback-detection statistics port ..................................................................9-15

Chapter 10 Link Aggregation Commands ............................................................................... 10-1

linkagg static agg size ............................................................................................10-3
linkagg static agg name ..........................................................................................10-6
linkagg static agg admin-state ................................................................................10-8
linkagg static port agg ............................................................................................10-9
linkagg lacp agg size ............................................................................................10-11
linkagg lacp agg name ..........................................................................................10-14
linkagg lacp agg admin-state ................................................................................10-16
linkagg lacp agg actor admin-key ........................................................................10-18
linkagg lacp agg actor system-priority .................................................................10-19
linkagg lacp agg actor system-id ..........................................................................10-21
linkagg lacp agg partner system-id .......................................................................10-23
linkagg lacp agg partner system-priority ..............................................................10-25
linkagg lacp agg partner admin-key .....................................................................10-27
linkagg lacp port actor admin-key ........................................................................10-29
linkagg lacp port actor admin-state ......................................................................10-32
linkagg lacp port actor system-id .........................................................................10-34

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 vii

 Contents

linkagg lacp port actor system-priority ................................................................10-36

linkagg lacp agg partner admin-state ...................................................................10-38
linkagg lacp port partner admin system-id ...........................................................10-40
linkagg lacp port partner admin-key ....................................................................10-42
linkagg lacp port partner admin system-priority ..................................................10-44
linkagg lacp port actor port priority .....................................................................10-46
linkagg lacp port partner admin-port ....................................................................10-48
linkagg lacp port partner admin port-priority .......................................................10-50
dhl name ...............................................................................................................10-52
dhl num linka linkb ..............................................................................................10-54
dhl num admin-state .............................................................................................10-56
dhl num vlan-map linkb .......................................................................................10-57
dhl num pre-emption-time ....................................................................................10-59
dhl num mac-flushing ...........................................................................................10-61
show dhl ...............................................................................................................10-63
show dhl num .......................................................................................................10-65
show dhl num link ................................................................................................10-68
linkagg range ........................................................................................................10-70
show linkagg ........................................................................................................10-72
show linkagg port .................................................................................................10-77
show linkagg range ...............................................................................................10-83

Chapter 11 Virtual Chassis Commands .................................................................................... 11-1

virtual-chassis configured-chassis-id .....................................................................11-2
virtual-chassis chassis-group ..................................................................................11-4
virtual-chassis configured-chassis-priority ............................................................11-6
virtual-chassis configured-control-vlan ..................................................................11-8
virtual-chassis hello-interval ..................................................................................11-9
virtual-chassis vf-link-mode .................................................................................11-11
virtual-chassis auto-vf-link-port ...........................................................................11-12
virtual-chassis shutdown ......................................................................................11-13
vc-takeover ...........................................................................................................11-14
show virtual-chassis topology ..............................................................................11-15
show virtual-chassis consistency ..........................................................................11-20
show virtual-chassis vf-link .................................................................................11-23
show virtual-chassis auto-vf-link-port .................................................................11-25
show virtual-chassis chassis-reset-list ..................................................................11-27
show virtual-chassis slot-reset-list .......................................................................11-29
show virtual-chassis neighbors .............................................................................11-31
show configuration vcm-snapshot chassis-id .......................................................11-33
virtual-chassis split-protection admin-state ..........................................................11-34
virtual-chassis split-protection linkagg ................................................................11-35
virtual-chassis split-protection guard-timer .........................................................11-36
virtual-chassis split-protection helper admin-state ...............................................11-37
virtual-chassis split-protection helper linkagg .....................................................11-38
show virtual-chassis split-protection status ..........................................................11-39
show virtual-chassis split-protection vc-units ......................................................11-40
show virtual-chassis split-protection helper status ...............................................11-41

Chapter 12 Ethernet Ring Protection Commands .................................................................. 12-1

erp-ring ...................................................................................................................12-2
erp-ring rpl-node ....................................................................................................12-5

viii OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Contents

erp-ring wait-to-restore ..........................................................................................12-7

erp-ring enable ........................................................................................................12-8
erp-ring guard-timer ...............................................................................................12-9
erp-ring sub-ring ...................................................................................................12-10
erp-ring virtual-channel ........................................................................................12-12
erp-ring revertive ..................................................................................................12-14
erp-ring clear ........................................................................................................12-16
erp-ring ethoam-event ..........................................................................................12-17
clear erp statistics .................................................................................................12-19
show erp ...............................................................................................................12-21
show erp statistics .................................................................................................12-24

Chapter 13 MVRP Commands ..................................................................................................... 13-1

mvrp .......................................................................................................................13-2
mvrp port ................................................................................................................13-3
mvrp linkagg ..........................................................................................................13-5
mvrp maximum-vlan ..............................................................................................13-7
mvrp registration ....................................................................................................13-8
mvrp applicant ......................................................................................................13-10
mvrp timer join .....................................................................................................13-12
mvrp timer leave ...................................................................................................13-14
mvrp timer leaveall ...............................................................................................13-16
mvrp timer periodic-timer ....................................................................................13-18
mvrp periodic-transmission ..................................................................................13-20
mvrp restrict-vlan-registration ..............................................................................13-21
mvrp restrict-vlan-advertisement .........................................................................13-23
mvrp static-vlan-restrict ......................................................................................13-25
show mvrp configuration .....................................................................................13-27
show mvrp port .....................................................................................................13-28
show mvrp linkagg ...............................................................................................13-31
show mvrp timer ...................................................................................................13-33
show mvrp statistics .............................................................................................13-36
show mvrp last-pdu-origin ...................................................................................13-39
show mvrp vlan-restrictions .................................................................................13-41
mvrp clear-statistics .............................................................................................13-43

Chapter 14 802.1AB Commands ................................................................................................ 14-1

lldp nearest-edge mode ...........................................................................................14-3
lldp transmit ............................................................................................................14-4
lldp transmit hold-multiplier ..................................................................................14-6
lldp reinit delay .......................................................................................................14-7
lldp notification interval .........................................................................................14-8
lldp lldpdu ..............................................................................................................14-9
lldp notification ....................................................................................................14-11
lldp network-policy ..............................................................................................14-13
lldp med network-policy ......................................................................................14-15
lldp tlv management .............................................................................................14-17
lldp tlv dot1 ..........................................................................................................14-19
lldp tlv dot3 ..........................................................................................................14-21
lldp tlv med ...........................................................................................................14-23
show lldp system-statistics ...................................................................................14-25
show lldp statistics ...............................................................................................14-27

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 ix

 Contents

show lldp local-system .........................................................................................14-29

show lldp local-port ..............................................................................................14-31
show lldp local-management-address ..................................................................14-33
show lldp config ...................................................................................................14-34
show lldp network-policy .....................................................................................14-36
show lldp med network-policy .............................................................................14-38
show lldp agent-destination-address ....................................................................14-40
show lldp remote-system ......................................................................................14-41
show lldp remote-system med ..............................................................................14-46
show lldp remote-system application-tlv .............................................................14-49

Chapter 15 SIP Commands .......................................................................................................... 15-1

sip-snooping admin-state ........................................................................................15-2
sip-snooping port admin-state ................................................................................15-3
sip-snooping mode .................................................................................................15-5
sip-snooping trusted server .....................................................................................15-7
sip-snooping sip-control .........................................................................................15-9
sip-snooping sos-call number ...............................................................................15-10
sip-snooping sos-call dscp ....................................................................................15-11
sip-snooping udp port ...........................................................................................15-12
sip-snooping tcp port ............................................................................................15-13
sip-snooping threshold .........................................................................................15-15
sip-snooping logging-threshold num-of-calls ......................................................15-17
show sip-snooping call-records ............................................................................15-18
clear sip-snooping statistics ..................................................................................15-21
show sip-snooping config .....................................................................................15-22
show sip-snooping ports .......................................................................................15-24
show sip-snooping statistics .................................................................................15-25
show sip-snooping registered-clients ...................................................................15-28

Chapter 16 IP Commands ............................................................................................................ 16-1

ip interface ..............................................................................................................16-4
ip interface tunnel ...................................................................................................16-7
ip router primary-address .......................................................................................16-9
ip router router-id .................................................................................................16-10
ip static-route ........................................................................................................16-11
ip route-pref ..........................................................................................................16-13
ip default-ttl ..........................................................................................................16-15
ping .......................................................................................................................16-16
traceroute ..............................................................................................................16-18
ip directed-broadcast ............................................................................................16-20
ip service ..............................................................................................................16-21
ip service port .......................................................................................................16-23
ip service source-ip ...............................................................................................16-25
ip redist .................................................................................................................16-27
ip access-list .........................................................................................................16-29
ip access-list address ............................................................................................16-30
ip route-map action ...............................................................................................16-32
ip route-map match ip address .............................................................................16-34
ip route-map match ipv6 address .........................................................................16-36
ip route-map match ip-nexthop ............................................................................16-38
ip route-map match ipv6-nexthop ........................................................................16-40

x OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Contents

ip route-map match tag .........................................................................................16-42

ip route-map match ipv4-interface .......................................................................16-44
ip route-map match ipv6-interface .......................................................................16-46
ip route-map match metric ...................................................................................16-48
ip route-map match route-type .............................................................................16-50
ip route-map match protocol ................................................................................16-52
ip route-map set metric .........................................................................................16-54
ip route-map set metric-type ................................................................................16-56
ip route-map set tag ..............................................................................................16-58
ip route-map set community .................................................................................16-60
ip route-map set local-preference .........................................................................16-62
ip route-map set level ...........................................................................................16-64
ip route-map set ip-nexthop ..................................................................................16-66
ip route-map set ipv6-nexthop ..............................................................................16-68
vrf .........................................................................................................................16-70
ip export ................................................................................................................16-72
ip import ...............................................................................................................16-75
show ip export ......................................................................................................16-77
show ip import ......................................................................................................16-78
show ip global-route-table ....................................................................................16-80
arp .........................................................................................................................16-82
clear arp-cache ......................................................................................................16-84
ip dos arp-poison restricted-address .....................................................................16-85
arp filter ................................................................................................................16-86
clear arp filter .......................................................................................................16-88
icmp type ..............................................................................................................16-89
icmp unreachable ..................................................................................................16-91
icmp echo .............................................................................................................16-93
icmp timestamp ....................................................................................................16-95
icmp addr-mask ....................................................................................................16-97
icmp messages ......................................................................................................16-99
ip dos scan close-port-penalty ............................................................................16-100
ip dos scan tcp open-port-penalty .......................................................................16-101
ip dos scan udp open-port-penalty .....................................................................16-102
ip dos scan threshold ..........................................................................................16-103
ip dos trap ...........................................................................................................16-105
ip dos scan decay ................................................................................................16-106
ip dos type ..........................................................................................................16-107
show ip traffic .....................................................................................................16-109
show ip interface ................................................................................................16-112
show ip routes .....................................................................................................16-116
show ip route-pref ..............................................................................................16-118
show ip redist .....................................................................................................16-119
show ip access-list ..............................................................................................16-121
show ip route-map ..............................................................................................16-123
show ip router database ......................................................................................16-125
show ip emp-routes ............................................................................................16-128
show ip config ....................................................................................................16-130
show ip protocols ...............................................................................................16-131
show ip router-id ................................................................................................16-133
show ip service ...................................................................................................16-134
show ip service source-ip ...................................................................................16-136

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 xi

 Contents

show ip dos arp-poison .......................................................................................16-138

show arp .............................................................................................................16-139
show arp filter .....................................................................................................16-141
show icmp control ..............................................................................................16-143
show icmp statistics ............................................................................................16-145
show tcp statistics ...............................................................................................16-147
show tcp ports .....................................................................................................16-149
show udp statistics ..............................................................................................16-151
show udp ports ...................................................................................................16-152
show ip dos config ..............................................................................................16-153
show ip dos statistics ..........................................................................................16-155
show vrf ..............................................................................................................16-157
show vrf-profiles ................................................................................................16-160

Chapter 17 IPv6 Commands ........................................................................................................ 17-1

ipv6 interface ..........................................................................................................17-3
ipv6 interface tunnel source destination .................................................................17-7
ipv6 address ............................................................................................................17-8
ipv6 address global-id ..........................................................................................17-10
ipv6 address local-unicast ....................................................................................17-11
ipv6 dad-check .....................................................................................................17-13
ipv6 hop-limit .......................................................................................................17-14
ipv6 pmtu-lifetime ................................................................................................17-15
ipv6 neighbor stale-lifetime .................................................................................17-16
ipv6 neighbor ........................................................................................................17-17
ipv6 neighbor limit ...............................................................................................17-18
ipv6 neighbor vrf-limit .........................................................................................17-19
ipv6 ra-filter ..........................................................................................................17-20
ipv6 prefix ............................................................................................................17-22
ipv6 static-route ....................................................................................................17-24
ipv6 route-pref ......................................................................................................17-26
ipv6 virtual-source-mac ........................................................................................17-28
ping6 .....................................................................................................................17-29
traceroute6 ............................................................................................................17-31
show ipv6 icmp statistics ......................................................................................17-33
show ipv6 interface ..............................................................................................17-36
show ipv6 ra-filter ................................................................................................17-40
show ipv6 pmtu table ...........................................................................................17-42
show ipv6 neighbors .............................................................................................17-44
clear ipv6 neighbors .............................................................................................17-46
show ipv6 prefixes ...............................................................................................17-47
show ipv6 routes ...................................................................................................17-49
show ipv6 route-pref ............................................................................................17-51
show ipv6 router database ....................................................................................17-52
show ipv6 tcp connections ...................................................................................17-54
show ipv6 tcp listeners .........................................................................................17-56
show ipv6 traffic ...................................................................................................17-58
show ipv6 tunnel configured ................................................................................17-61
show ipv6 tunnel 6to4 ..........................................................................................17-63
show ipv6 udp ports .............................................................................................17-65
show ipv6 information .........................................................................................17-66
ipv6 redist .............................................................................................................17-68

xii OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Contents

ipv6 access-list .....................................................................................................17-70

ipv6 access-list address ........................................................................................17-71
show ipv6 redist ...................................................................................................17-73
show ipv6 access-list ............................................................................................17-75
ipv6 load rip .........................................................................................................17-77
ipv6 rip admin-state ..............................................................................................17-78
ipv6 rip invalid-timer ...........................................................................................17-79
ipv6 rip garbage-timer ..........................................................................................17-80
ipv6 rip holddown-timer .......................................................................................17-81
ipv6 rip jitter .........................................................................................................17-82
ipv6 rip route-tag ..................................................................................................17-83
ipv6 rip update-interval ........................................................................................17-84
ipv6 rip triggered-sends ........................................................................................17-85
ipv6 rip interface ..................................................................................................17-86
ipv6 rip interface metric .......................................................................................17-88
ipv6 rip interface recv-status ................................................................................17-89
ipv6 rip interface send-status ................................................................................17-90
ipv6 rip interface horizon .....................................................................................17-91
show ipv6 rip ........................................................................................................17-92
show ipv6 rip interface .........................................................................................17-94
show ipv6 rip peer ................................................................................................17-97
show ipv6 rip routes .............................................................................................17-99
ipv6 dhcp relay admin-state ...............................................................................17-102
ipv6 dhcp relay interface admin-state ................................................................17-103
ipv6 dhcp relay destination ................................................................................17-104
show ipv6 dhcp relay ..........................................................................................17-106

Chapter 18 IPsec commands ....................................................................................................... 18-1

ipsec key .................................................................................................................18-2
ipsec security-key ...................................................................................................18-4
ipsec policy .............................................................................................................18-6
ipsec policy rule .....................................................................................................18-9
ipsec sa .................................................................................................................18-10
show ipsec policy .................................................................................................18-12
show ipsec sa ........................................................................................................18-14
show ipsec key .....................................................................................................18-16
show ipsec ipv6 statistics .....................................................................................18-18

Chapter 19 RIP Commands .......................................................................................................... 19-1

ip load rip ...............................................................................................................19-2
ip rip admin-state ....................................................................................................19-3
ip rip interface ........................................................................................................19-4
ip rip interface admin-state .....................................................................................19-6
ip rip interface metric .............................................................................................19-8
ip rip interface send-version ...................................................................................19-9
ip rip interface recv-version .................................................................................19-11
ip rip interface ingress-filter .................................................................................19-12
ip rip interface ingress-filter .................................................................................19-13
ip rip interface egress-filter ..................................................................................19-14
ip rip force-holddowntimer ..................................................................................19-15
ip rip host-route ....................................................................................................19-17
ip rip route-tag ......................................................................................................19-18

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 xiii

 Contents

ip rip interface auth-type ......................................................................................19-19

ip rip interface auth-key .......................................................................................19-20
ip rip update-interval ............................................................................................19-21
ip rip invalid-timer ...............................................................................................19-22
ip rip garbage-timer ..............................................................................................19-23
ip rip holddown-timer ...........................................................................................19-24
show ip rip ............................................................................................................19-25
show ip rip routes .................................................................................................19-27
show ip rip interface .............................................................................................19-30
show ip rip peer ....................................................................................................19-32

Chapter 20 BFD Commands ......................................................................................................... 20-1

ip bfd admin-state ...................................................................................................20-3
ip bfd transmit ........................................................................................................20-4
ip bfd receive ..........................................................................................................20-5
ip bfd multiplier ......................................................................................................20-6
ip bfd echo-interval ................................................................................................20-7
ip bfd interface .......................................................................................................20-8
ip bfd interface admin-state ....................................................................................20-9
ip bfd interface transmit .......................................................................................20-10
ip bfd interface receive .........................................................................................20-11
ip bfd interface multiplier .....................................................................................20-12
ip bfd interface echo-interval ...............................................................................20-13
ip ospf bfd-state ....................................................................................................20-15
ip ospf bfd-state all-interfaces ..............................................................................20-17
ip ospf interface bfd-state .....................................................................................20-18
ip ospf interface bfd-state drs-only .......................................................................20-19
ip ospf interface bfd-state all-neighbors ...............................................................20-20
ip bgp bfd-state .....................................................................................................20-21
ip bgp bfd-state all-neighbors ...............................................................................20-22
ip bgp neighbor bfd-state ......................................................................................20-23
vrrp bfd-state ........................................................................................................20-24
vrrp track address bfd-state ..................................................................................20-25
show ip bfd ...........................................................................................................20-26
show ip bfd interfaces ..........................................................................................20-28
show ip bfd sessions .............................................................................................20-30
show ip bfd sessions statistics ..............................................................................20-32
ip static-route all bfd-state ....................................................................................20-34
ip static-route bfd-state .........................................................................................20-35

Chapter 21 DHCP Relay Commands .......................................................................................... 21-1

ip helper address .....................................................................................................21-3
ip helper vlan address .............................................................................................21-5
ip helper standard ...................................................................................................21-7
ip helper per-vlan-only ...........................................................................................21-8
ip helper forward-delay ........................................................................................21-10
ip helper maximum-hops ......................................................................................21-12
ip helper agent-information ..................................................................................21-14
ip helper agent-information policy .......................................................................21-16
ip helper pxe-support ............................................................................................21-18
ip helper boot-up ..................................................................................................21-19
ip helper boot-up enable .......................................................................................21-20

xiv OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Contents

ip udp relay port ...................................................................................................21-21

ip udp relay service ..............................................................................................21-23
ip udp relay service vlan .......................................................................................21-25
show ip helper ......................................................................................................21-27
show ip helper statistics ........................................................................................21-29
show ip udp relay .................................................................................................21-31
show ip udp relay statistics ...................................................................................21-33
no ip helper statistics ............................................................................................21-35
ip udp relay no statistics .......................................................................................21-37
dhcp-server ...........................................................................................................21-38
dhcp-server restart ................................................................................................21-39
show dhcp-server leases .......................................................................................21-40
show dhcp-server statistics ...................................................................................21-42
clear dhcp-server statistics ...................................................................................21-50
dhcpv6-server .......................................................................................................21-51
dhcpv6-server restart ............................................................................................21-52
show dhcpv6-server leases ...................................................................................21-53
show dhcpv6-server statistics ...............................................................................21-55
clear dhcpv6-server statistics ...............................................................................21-65
dhcp-message-service ...........................................................................................21-66
dhcp-message-service restart ................................................................................21-67
show message-service status ................................................................................21-68
dhcp-snooping admin-state ..................................................................................21-69
dhcp-snooping mac-address-verification .............................................................21-70
dhcp-snooping option-82-data-insertion ..............................................................21-71
dhcp-snooping bypass option-82-check ...............................................................21-72
dhcp-snooping option-82 format ..........................................................................21-73
dhcp-snooping vlan ..............................................................................................21-76
dhcp-snooping port ...............................................................................................21-78
dhcp-snooping linkagg .........................................................................................21-80
dhcp-snooping ip-source-filter .............................................................................21-82
dhcp-snooping binding admin-state .....................................................................21-84
dhcp-snooping binding timeout ............................................................................21-85
dhcp-snooping binding action ..............................................................................21-86
dhcp-snooping binding persistency ......................................................................21-87
dhcp-snooping binding .........................................................................................21-88
show dhcp-snooping ip-source-filter ....................................................................21-90
show dhcp-snooping vlan .....................................................................................21-92
show dhcp-snooping port .....................................................................................21-94
show dhcp-snooping binding ...............................................................................21-96

Chapter 22 VRRP Commands ...................................................................................................... 22-1

vrrp .........................................................................................................................22-3
vrrp address ............................................................................................................22-5
vrrp track ................................................................................................................22-6
vrrp track-association .............................................................................................22-8
vrrp trap ..................................................................................................................22-9
vrrp delay ..............................................................................................................22-10
vrrp interval ..........................................................................................................22-11
vrrp priority ..........................................................................................................22-13
vrrp preempt .........................................................................................................22-15
vrrp all ..................................................................................................................22-17

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 xv

 Contents

vrrp set ..................................................................................................................22-19

vrrp group .............................................................................................................22-21
vrrp group all ........................................................................................................22-23
vrrp group set .......................................................................................................22-25
vrrp group-association ..........................................................................................22-27
vrrp3 .....................................................................................................................22-28
vrrp3 address ........................................................................................................22-31
vrrp3 trap ..............................................................................................................22-32
vrrp3 track-association .........................................................................................22-33
show vrrp ..............................................................................................................22-34
show vrrp statistics ...............................................................................................22-37
show vrrp track .....................................................................................................22-40
show vrrp track-association ..................................................................................22-42
show vrrp group ...................................................................................................22-44
show vrrp group-association ................................................................................22-46
show vrrp3 ............................................................................................................22-48
show vrrp3 statistics .............................................................................................22-51
show vrrp3 track-association ................................................................................22-53

Chapter 23 OSPF Commands ...................................................................................................... 23-1

ip ospf admin-state .................................................................................................23-3
ip load ospf .............................................................................................................23-4
ip ospf asbr .............................................................................................................23-5
ip ospf exit-overflow-interval .................................................................................23-6
ip ospf extlsdb-limit ...............................................................................................23-7
ip ospf host .............................................................................................................23-8
ip ospf mtu-checking ............................................................................................23-10
ip ospf default-originate .......................................................................................23-11
ip ospf route-tag ...................................................................................................23-13
ip ospf spf-timer ...................................................................................................23-14
ip ospf virtual-link ................................................................................................23-16
ip ospf neighbor ....................................................................................................23-18
ip ospf area ...........................................................................................................23-20
ip ospf area default-metric ....................................................................................23-22
ip ospf area range .................................................................................................23-24
ip ospf interface ....................................................................................................23-26
ip ospf interface admin-state ................................................................................23-27
ip ospf interface area ............................................................................................23-28
ip ospf interface auth-key .....................................................................................23-29
ip ospf interface auth-type ....................................................................................23-30
ip ospf interface dead-interval ..............................................................................23-32
ip ospf interface hello-interval .............................................................................23-33
ip ospf interface md5 ............................................................................................23-34
ip ospf interface md5 key .....................................................................................23-36
ip ospf interface type ............................................................................................23-37
ip ospf interface cost ............................................................................................23-39
ip ospf interface poll-interval ...............................................................................23-40
ip ospf interface priority .......................................................................................23-41
ip ospf interface retrans-interval ..........................................................................23-42
ip ospf interface transit-delay ...............................................................................23-43
ip ospf restart-support ...........................................................................................23-44
ip ospf restart-interval ..........................................................................................23-45

xvi OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Contents

ip ospf restart-helper admin-state .........................................................................23-46

ip ospf restart-helper strict-lsa-checking admin-state ..........................................23-47
ip ospf restart initiate ............................................................................................23-49
show ip ospf .........................................................................................................23-50
show ip ospf border-routers ..................................................................................23-53
show ip ospf ext-lsdb ............................................................................................23-55
show ip ospf host ..................................................................................................23-57
show ip ospf lsdb ..................................................................................................23-59
show ip ospf neighbor ..........................................................................................23-61
show ip ospf routes ...............................................................................................23-64
show ip ospf virtual-link ......................................................................................23-66
show ip ospf virtual-neighbor ..............................................................................23-68
show ip ospf area ..................................................................................................23-71
show ip ospf area range ........................................................................................23-74
show ip ospf area stub ..........................................................................................23-76
show ip ospf interface ..........................................................................................23-78
show ip ospf restart ..............................................................................................23-84

Chapter 24 OSPFv3 Commands .................................................................................................. 24-1

ipv6 ospf admin-state .............................................................................................24-3
ipv6 load ospf .........................................................................................................24-4
ipv6 ospf host .........................................................................................................24-5
ipv6 ospf mtu-checking ..........................................................................................24-7
ipv6 ospf route-tag .................................................................................................24-8
ipv6 ospf spf-timer .................................................................................................24-9
ipv6 ospf virtual-link ............................................................................................24-11
ipv6 ospf area .......................................................................................................24-13
ipv6 ospf interface ................................................................................................24-15
ipv6 ospf interface suppress-link-lsa ....................................................................24-16
ipv6 ospf interface type ........................................................................................24-17
ipv6 ospf neighbor ................................................................................................24-18
ipv6 ospf interface admin-state ............................................................................24-20
ipv6 ospf interface area ........................................................................................24-21
ipv6 ospf interface dead-interval ..........................................................................24-22
ipv6 ospf interface hello-interval .........................................................................24-24
ipv6 ospf interface cost ........................................................................................24-25
ipv6 ospf interface priority ...................................................................................24-26
ipv6 ospf interface retrans-interval ......................................................................24-27
ipv6 ospf interface transit-delay ...........................................................................24-28
show ipv6 ospf .....................................................................................................24-29
show ipv6 ospf border-routers ..............................................................................24-33
show ipv6 ospf host ..............................................................................................24-35
show ipv6 ospf lsdb ..............................................................................................24-37
show ipv6 ospf neighbor ......................................................................................24-39
show ipv6 ospf routes ...........................................................................................24-42
show ipv6 ospf virtual-link ..................................................................................24-44
show ipv6 ospf area ..............................................................................................24-46
show ipv6 ospf interface ......................................................................................24-48

Chapter 25 IS-IS Commands ....................................................................................................... 25-1

ip load isis ...............................................................................................................25-4
ip isis admin-state ...................................................................................................25-5

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 xvii

 Contents

ip isis area-id ..........................................................................................................25-6

ip isis level-capability .............................................................................................25-7
ip isis auth-check ....................................................................................................25-8
ip isis auth-type ......................................................................................................25-9
ip isis csnp-auth ....................................................................................................25-11
ip isis hello-auth ...................................................................................................25-12
ip isis psnp-auth ....................................................................................................25-13
ip isis lsp-lifetime .................................................................................................25-14
ip isis lsp-wait .......................................................................................................25-15
ip isis spf-wait ......................................................................................................25-17
ip isis summary-address .......................................................................................25-19
ip isis overload .....................................................................................................25-21
ip isis overload-on-boot ........................................................................................25-23
ip isis graceful-restart ...........................................................................................25-25
ip isis graceful-restart helper ................................................................................25-26
ip isis strict-adjacency-check ...............................................................................25-27
ip isis level auth-type ............................................................................................25-28
ip isis level hello-auth ..........................................................................................25-30
ip isis level csnp-auth ...........................................................................................25-31
ip isis level psnp-auth ...........................................................................................25-32
ip isis level wide-metrics-only .............................................................................25-33
ip isis activate-ipv6|ipv4 .......................................................................................25-34
ip isis vlan .............................................................................................................25-35
ip isis vlan admin-state .........................................................................................25-36
ip isis vlan interface-type .....................................................................................25-37
ip isis vlan csnp-interval .......................................................................................25-38
ip isis vlan hello-auth-type ...................................................................................25-39
ip isis vlan level-capability ...................................................................................25-41
ip isis vlan lsp-pacing-interval .............................................................................25-42
ip isis vlan passive ................................................................................................25-44
ip isis vlan retransmit-interval ..............................................................................25-45
ip isis vlan default-type ........................................................................................25-46
ip isis vlan level hello-auth-type ..........................................................................25-47
ip isis vlan level hello-interval .............................................................................25-49
ip isis vlan level hello-multiplier ..........................................................................25-50
ip isis vlan level metric .........................................................................................25-51
ip isis vlan level passive .......................................................................................25-53
ip isis vlan level priority .......................................................................................25-55
ip isis summary-address6 .....................................................................................25-57
show ip isis adjacency ..........................................................................................25-58
show ip isis database ............................................................................................25-61
show ip isis hostname ...........................................................................................25-67
show ip isis routes ................................................................................................25-69
show ip isis routes6 ..............................................................................................25-71
show ip isis spf .....................................................................................................25-73
show ip isis spf-log ...............................................................................................25-75
show ip isis statistics ............................................................................................25-77
show ip isis status .................................................................................................25-80
show ip isis summary-address ..............................................................................25-84
show ip isis vlan ...................................................................................................25-86
show ip isis summary-address6 ............................................................................25-90
clear ip isis adjacency ...........................................................................................25-92

xviii OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Contents

clear ip isis lsp-database .......................................................................................25-94

clear ip isis spf-log ...............................................................................................25-95
clear ip isis statistics .............................................................................................25-96
ip isis multi-topology ...........................................................................................25-98

Chapter 26 BGP Commands ........................................................................................................ 26-1

ip load bgp ..............................................................................................................26-6
ip bgp admin-state ..................................................................................................26-7
ip bgp autonomous-system .....................................................................................26-8
ip bgp bestpath as-path ignore ..............................................................................26-10
ip bgp cluster-id ....................................................................................................26-12
ip bgp default local-preference .............................................................................26-14
ip bgp fast-external-failover .................................................................................26-16
ip bgp always-compare-med ................................................................................26-18
ip bgp bestpath med missing-as-worst .................................................................26-19
ip bgp client-to-client reflection ...........................................................................26-20
ip bgp as-origin-interval .......................................................................................26-22
ip bgp synchronization .........................................................................................26-23
ip bgp confederation identifier .............................................................................26-25
ip bgp maximum-paths .........................................................................................26-27
ip bgp log-neighbor-changes ................................................................................26-28
ip bgp dampening .................................................................................................26-29
ip bgp dampening clear ........................................................................................26-32
ip bgp asn-format .................................................................................................26-33
ip bgp aggregate-address ......................................................................................26-34
ip bgp aggregate-address admin-state ..................................................................26-36
ip bgp aggregate-address as-set ............................................................................26-38
ip bgp aggregate-address community ...................................................................26-40
ip bgp aggregate-address local-preference ...........................................................26-42
ip bgp aggregate-address metric ...........................................................................26-44
ip bgp aggregate-address summary-only ..............................................................26-46
ip bgp network ......................................................................................................26-48
ip bgp network admin-state ..................................................................................26-50
ip bgp network community ..................................................................................26-52
ip bgp network local-preference ...........................................................................26-54
ip bgp network metric ..........................................................................................26-56
ip bgp neighbor .....................................................................................................26-58
ip bgp neighbor admin-state .................................................................................26-59
ip bgp neighbor advertisement-interval ................................................................26-60
ip bgp neighbor clear ............................................................................................26-61
ip bgp neighbor route-reflector-client ..................................................................26-63
ip bgp neighbor default-originate .........................................................................26-64
ip bgp neighbor timers ..........................................................................................26-65
ip bgp neighbor conn-retry-interval .....................................................................26-67
ip bgp neighbor auto-restart .................................................................................26-69
ip bgp neighbor maximum-prefix ........................................................................26-71
ip bgp neighbor md5 key ......................................................................................26-73
ip bgp neighbor ebgp-multihop ............................................................................26-75
ip bgp neighbor description ..................................................................................26-77
ip bgp neighbor next-hop-self ..............................................................................26-78
ip bgp neighbor passive ........................................................................................26-80
ip bgp neighbor remote-as ....................................................................................26-81

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 xix

 Contents

ip bgp neighbor remove-private-as ......................................................................26-83

ip bgp neighbor soft-reconfiguration ....................................................................26-84
ip bgp neighbor stats-clear ...................................................................................26-86
ip bgp confederation neighbor ..............................................................................26-87
ip bgp neighbor update-source .............................................................................26-88
ip bgp neighbor in-aspathlist ................................................................................26-90
ip bgp neighbor in-communitylist ........................................................................26-91
ip bgp neighbor in-prefixlist .................................................................................26-92
ip bgp neighbor out-aspathlist ..............................................................................26-93
ip bgp neighbor out-communitylist ......................................................................26-94
ip bgp neighbor out-prefixlist ...............................................................................26-95
ip bgp neighbor route-map ...................................................................................26-96
ip bgp neighbor clear soft .....................................................................................26-98
ip bgp policy aspath-list .......................................................................................26-99
ip bgp policy aspath-list action ...........................................................................26-102
ip bgp policy aspath-list priority ........................................................................26-104
ip bgp policy community-list .............................................................................26-106
ip bgp policy community-list action ...................................................................26-108
ip bgp policy community-list match-type ..........................................................26-110
ip bgp policy community-list priority ................................................................26-112
ip bgp policy prefix-list ......................................................................................26-114
ip bgp policy prefix-list action ...........................................................................26-116
ip bgp policy prefix-list ge .................................................................................26-117
ip bgp policy prefix-list le ..................................................................................26-119
ip bgp policy prefix6-list ....................................................................................26-121
ip bgp policy route-map .....................................................................................26-123
ip bgp policy route-map action ...........................................................................26-125
ip bgp policy route-map aspath-list ....................................................................26-126
ip bgp policy route-map asprepend ....................................................................26-127
ip bgp policy route-map community ..................................................................26-128
ip bgp policy route-map community-list ............................................................26-130
ip bgp policy route-map community-mode ........................................................26-131
ip bgp policy route-map lpref .............................................................................26-132
ip bgp policy route-map lpref-mode ...................................................................26-133
ip bgp policy route-map match-community .......................................................26-135
ip bgp policy route-map match-mask .................................................................26-137
ip bgp policy route-map match-prefix ................................................................26-138
ip bgp policy route-map match-regexp ..............................................................26-139
ip bgp policy route-map med .............................................................................26-141
ip bgp policy route-map med-mode ...................................................................26-142
ip bgp policy route-map origin ...........................................................................26-144
ip bgp policy route-map prefix-list .....................................................................26-145
ip bgp policy route-map weight .........................................................................26-147
ip bgp policy route-map community-strip ..........................................................26-148
show ip bgp ........................................................................................................26-149
show ip bgp statistics ..........................................................................................26-153
show ip bgp dampening ......................................................................................26-155
show ip bgp dampening-stats .............................................................................26-157
show ip bgp path ................................................................................................26-159
show ip bgp routes ..............................................................................................26-163
show ip bgp aggregate-address ..........................................................................26-165
show ip bgp network ..........................................................................................26-167

xx OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Contents

show ip bgp neighbors ........................................................................................26-169

show ip bgp neighbors policy .............................................................................26-174
show ip bgp neighbors timer ..............................................................................26-176
show ip bgp neighbors statistics .........................................................................26-178
show ip bgp policy aspath-list ............................................................................26-183
show ip bgp policy community-list ....................................................................26-185
show ip bgp policy prefix-list .............................................................................26-187
show ip bgp policy route-map ............................................................................26-189
ip bgp graceful-restart ........................................................................................26-192
ip bgp graceful-restart restart-interval ................................................................26-193
ip bgp unicast .....................................................................................................26-194
ipv6 bgp unicast .................................................................................................26-195
ip bgp neighbor activate-ipv6 .............................................................................26-196
ip bgp neighbor ipv6-nexthop ............................................................................26-197
show ipv6 bgp path ............................................................................................26-198
show ipv6 bgp routes ..........................................................................................26-202
ipv6 bgp network ................................................................................................26-204
ipv6 bgp network community ............................................................................26-205
ipv6 bgp network local-preference .....................................................................26-207
ipv6 bgp network metric ....................................................................................26-209
ipv6 bgp network admin-state ............................................................................26-211
show ipv6 bgp network ......................................................................................26-212
ipv6 bgp neighbor ...............................................................................................26-214
ipv6 bgp neighbor activate-ipv6 .........................................................................26-216
ipv6 bgp neighbor ipv6-nexthop ........................................................................26-217
ipv6 bgp neighbor admin-state ...........................................................................26-218
ipv6 bgp neighbor remote-as ..............................................................................26-219
ipv6 bgp neighbor timers ....................................................................................26-220
ipv6 bgp neighbor maximum-prefix ..................................................................26-222
ipv6 bgp neighbor next-hop-self ........................................................................26-224
ipv6 bgp neighbor conn-retry-interval ...............................................................26-225
ipv6 bgp neighbor default-originate ...................................................................26-226
ipv6 bgp neighbor update-source .......................................................................26-227
ipv6 bgp neighbor ipv4-nexthop ........................................................................26-228
show ipv6 bgp neighbors ....................................................................................26-229
show ipv6 bgp neighbors statistics .....................................................................26-233
show ipv6 bgp neighbors policy .........................................................................26-238
show ipv6 bgp neighbors timers .........................................................................26-240

Chapter 27 Server Load Balancing Commands ..................................................................... 27-1

ip slb admin-state ...................................................................................................27-2
ip slb reset statistics ................................................................................................27-3
ip slb cluster ...........................................................................................................27-4
ip slb cluster admin-state ........................................................................................27-6
ip slb cluster ping period ........................................................................................27-7
ip slb cluster ping timeout ......................................................................................27-9
ip slb cluster ping retries ......................................................................................27-11
ip slb cluster probe ...............................................................................................27-12
ip slb server ip cluster ...........................................................................................27-13
ip slb server ip cluster probe ................................................................................27-15
ip slb probe ...........................................................................................................27-16
ip slb probe timeout ..............................................................................................27-18

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 xxi

 Contents

ip slb probe period ................................................................................................27-20

ip slb probe port ....................................................................................................27-22
ip slb probe retries ................................................................................................27-24
ip slb probe username ...........................................................................................27-26
ip slb probe password ...........................................................................................27-27
ip slb probe url ......................................................................................................27-28
ip slb probe status .................................................................................................27-29
ip slb probe send ...................................................................................................27-30
ip slb probe expect ................................................................................................27-31
show ip slb ............................................................................................................27-32
show ip slb clusters ..............................................................................................27-34
show ip slb cluster ................................................................................................27-37
show ip slb cluster server .....................................................................................27-41
show ip slb servers ...............................................................................................27-44
show ip slb probes ................................................................................................27-46

Chapter 28 IP Multicast Switching Commands ....................................................................... 28-1

ip multicast admin-state .........................................................................................28-4
ip multicast querier-forwarding ..............................................................................28-6
ip multicast flood-unknown ...................................................................................28-8
ip multicast version ..............................................................................................28-10
ip multicast max-group .........................................................................................28-12
ip multicast vlan max-group .................................................................................28-14
ip multicast port max-group .................................................................................28-16
ip multicast static-neighbor ..................................................................................28-18
ip multicast static-querier .....................................................................................28-20
ip multicast static-group .......................................................................................28-22
ip multicast query-interval ...................................................................................28-24
ip multicast last-member-query-interval ..............................................................28-26
ip multicast query-response-interval ....................................................................28-28
ip multicast unsolicited-report-interval ................................................................28-30
ip multicast router-timeout ...................................................................................28-32
ip multicast source-timeout ..................................................................................28-34
ip multicast querying ............................................................................................28-36
ip multicast robustness .........................................................................................28-38
ip multicast spoofing ............................................................................................28-40
ip multicast zapping .............................................................................................28-42
ip multicast proxying ............................................................................................28-44
ip multicast helper-address ...................................................................................28-46
ip multicast initial-packet-buffer admin-state ......................................................28-47
ip multicast initial-packet-buffer max-packet ......................................................28-48
ip multicast initial-packet-buffer max-flow .........................................................28-49
ip multicast initial-packet-buffer timeout .............................................................28-50
ip multicast initial-packet-buffer min-delay .........................................................28-51
ipv6 multicast admin-state ...................................................................................28-52
ipv6 multicast querier-forwarding ........................................................................28-54
ipv6 multicast flood-unknown .............................................................................28-56
ipv6 multicast version ..........................................................................................28-58
ipv6 multicast max-group .....................................................................................28-60
ipv6 multicast vlan max-group .............................................................................28-62
ipv6 multicast port max-group .............................................................................28-64
ipv6 multicast static-neighbor ..............................................................................28-66

xxii OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Contents

ipv6 multicast static-querier .................................................................................28-68

ipv6 multicast static-group ...................................................................................28-70
ipv6 multicast query-interval ...............................................................................28-72
ipv6 multicast last-member-query-interval ..........................................................28-74
ipv6 multicast query-response-interval ................................................................28-76
ipv6 multicast unsolicited-report-interval ............................................................28-78
ipv6 multicast router-timeout ...............................................................................28-80
ipv6 multicast source-timeout ..............................................................................28-82
ipv6 multicast querying ........................................................................................28-84
ipv6 multicast robustness .....................................................................................28-86
ipv6 multicast spoofing ........................................................................................28-88
ipv6 multicast zapping .........................................................................................28-90
ipv6 multicast proxying ........................................................................................28-92
ipv6 multicast initial-packet-buffer admin-state ..................................................28-94
ipv6 multicast initial-packet-buffer max-packet ..................................................28-95
ipv6 multicast initial-packet-buffer max-flow .....................................................28-96
ipv6 multicast initial-packet-buffer timeout .........................................................28-97
ipv6 multicast initial-packet-buffer min-delay .....................................................28-98
show ip multicast ..................................................................................................28-99
show ip multicast port ........................................................................................28-103
show ip multicast forward ..................................................................................28-106
show ip multicast neighbor ................................................................................28-108
show ip multicast querier ...................................................................................28-110
show ip multicast group .....................................................................................28-112
show ip multicast source ....................................................................................28-114
show ip multicast tunnel .....................................................................................28-116
show ip multicast initial-packet-buffer ..............................................................28-118
show ipv6 multicast ............................................................................................28-120
show ipv6 multicast port ....................................................................................28-124
show ipv6 multicast forward ..............................................................................28-126
show ipv6 multicast neighbor ............................................................................28-128
show ipv6 multicast querier ...............................................................................28-130
show ipv6 multicast group .................................................................................28-132
show ipv6 multicast source ................................................................................28-134
show ipv6 multicast tunnel .................................................................................28-136
show ipv6 multicast initial-packet-buffer ..........................................................28-138

Chapter 29 DVMRP Commands .................................................................................................. 29-1

ip load dvmrp .........................................................................................................29-2
ip dvmrp admin-state ..............................................................................................29-3
ip dvmrp flash-interval ...........................................................................................29-4
ip dvmrp graft-timeout ...........................................................................................29-5
ip dvmrp interface ..................................................................................................29-6
ip dvmrp interface metric .......................................................................................29-7
ip dvmrp interface mbr-default-information ..........................................................29-8
ip dvmrp neighbor-interval .....................................................................................29-9
ip dvmrp neighbor-timeout ...................................................................................29-10
ip dvmrp prune-lifetime .......................................................................................29-11
ip dvmrp prune-timeout ........................................................................................29-12
ip dvmrp report-interval .......................................................................................29-13
ip dvmrp route-holddown .....................................................................................29-14
ip dvmrp route-timeout .........................................................................................29-15

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 xxiii

 Contents

ip dvmrp subord-default .......................................................................................29-16

ip interface tunnel .................................................................................................29-18
show ip dvmrp ......................................................................................................29-20
show ip dvmrp interface .......................................................................................29-23
show ip dvmrp neighbor .......................................................................................29-25
show ip dvmrp nexthop ........................................................................................29-27
show ip dvmrp prune ............................................................................................29-29
show ip dvmrp route .............................................................................................29-31
show ip dvmrp tunnel ...........................................................................................29-33

Chapter 30 PIM Commands ......................................................................................................... 30-1

ip load pim ..............................................................................................................30-3
ip pim sparse admin-state .......................................................................................30-5
ip pim dense admin-state ........................................................................................30-6
ip pim ssm group ....................................................................................................30-7
ip pim dense group .................................................................................................30-9
ip pim cbsr ............................................................................................................30-11
ip pim static-rp .....................................................................................................30-13
ip pim candidate-rp ...............................................................................................30-15
ip pim rp-threshold ...............................................................................................30-17
ip pim keepalive-period ........................................................................................30-18
ip pim max-rps .....................................................................................................30-20
ip pim probe-time .................................................................................................30-22
ip pim register checksum ......................................................................................30-23
ip pim register-suppress-timeout ..........................................................................30-24
ip pim spt admin-state ..........................................................................................30-25
ip pim state-refresh-interval .................................................................................30-26
ip pim state-refresh-limit ......................................................................................30-27
ip pim state-refresh-ttl ..........................................................................................30-28
ip pim interface .....................................................................................................30-29
ip pim neighbor-loss-notification-period .............................................................30-32
ip pim invalid-register-notification-period ...........................................................30-33
ip pim invalid-joinprune-notification-period .......................................................30-34
ip pim rp-mapping-notification-period .................................................................30-35
ip pim interface-election-notification-period .......................................................30-36
ip pim mbr all-sources ..........................................................................................30-37
ip pim bfd-state .....................................................................................................30-39
ip pim bfd-state all-interfaces ...............................................................................30-40
ip pim interface bfd-state ......................................................................................30-41
ip pim mofrr-state .................................................................................................30-42
ip pim mofrr-state all-routes .................................................................................30-43
show ip pim sparse ...............................................................................................30-45
show ip pim dense ................................................................................................30-48
show ip pim ssm group .........................................................................................30-50
show ip pim dense group ......................................................................................30-52
show ip pim neighbor ...........................................................................................30-54
show ip pim candidate-rp .....................................................................................30-57
show ip pim group-map ........................................................................................30-59
show ip pim interface ...........................................................................................30-61
show ip pim static-rp ............................................................................................30-65
show ip pim cbsr ..................................................................................................30-67
show ip pim bsr ....................................................................................................30-69

xxiv OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Contents

show ip pim notifications .....................................................................................30-71

show ip pim groute ...............................................................................................30-74
show ip pim sgroute .............................................................................................30-78
ipv6 pim sparse admin-state .................................................................................30-83
ipv6 pim dense admin-state ..................................................................................30-84
ipv6 pim ssm group ..............................................................................................30-85
ipv6 pim dense group ...........................................................................................30-87
ipv6 pim cbsr ........................................................................................................30-89
ipv6 pim static-rp .................................................................................................30-91
ipv6 pim candidate-rp ...........................................................................................30-93
ipv6 pim rp-switchover ........................................................................................30-95
ipv6 pim spt admin-state ......................................................................................30-96
ipv6 pim interface .................................................................................................30-97
show ipv6 pim sparse .........................................................................................30-100
show ipv6 pim dense ..........................................................................................30-102
show ipv6 pim ssm group ...................................................................................30-104
show ipv6 pim dense group ................................................................................30-106
show ipv6 pim interface .....................................................................................30-108
show ipv6 pim neighbor .....................................................................................30-112
show ipv6 pim static-rp ......................................................................................30-116
show ipv6 pim group-map ..................................................................................30-118
show ipv6 pim candidate-rp ...............................................................................30-120
show ipv6 pim cbsr ............................................................................................30-122
show ipv6 pim bsr ..............................................................................................30-124
show ipv6 pim groute .........................................................................................30-126
show ipv6 pim sgroute .......................................................................................30-130

Chapter 31 Multicast Routing Commands ............................................................................... 31-1

ip mroute-boundary ................................................................................................31-3
ip mroute-boundary extended .................................................................................31-5
ip mroute interface ttl .............................................................................................31-6
ip mroute mbr .........................................................................................................31-7
ipv6 mroute interface ttl .........................................................................................31-9
show ip mroute-boundary .....................................................................................31-10
show ip mroute .....................................................................................................31-12
show ipv6 mroute .................................................................................................31-14
show ip mroute interface ......................................................................................31-16
show ipv6 mroute interface ..................................................................................31-18
show ip mroute-nexthop .......................................................................................31-20
show ipv6 mroute-nexthop ...................................................................................31-22
show ip mroute mbr ..............................................................................................31-24

Chapter 32 QoS Commands ........................................................................................................ 32-1

qos ..........................................................................................................................32-3
qos trust-ports .........................................................................................................32-5
qos forward log .......................................................................................................32-7
qos log console .......................................................................................................32-8
qos log lines ............................................................................................................32-9
qos log level .........................................................................................................32-10
qos stats interval ...................................................................................................32-12
qos phones ............................................................................................................32-13
qos quarantine mac-group ....................................................................................32-15

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 xxv

 Contents

qos user-port .........................................................................................................32-17

qos dei ..................................................................................................................32-19
qos dscp-table .......................................................................................................32-21
debug qos ..............................................................................................................32-22
debug qos internal ................................................................................................32-24
clear qos log .........................................................................................................32-26
qos apply ..............................................................................................................32-27
qos revert ..............................................................................................................32-28
qos flush ...............................................................................................................32-29
qos reset ................................................................................................................32-31
qos stats reset ........................................................................................................32-32
qos port reset ........................................................................................................32-33
qos port .................................................................................................................32-34
qos port trusted .....................................................................................................32-36
qos port maximum egress-bandwidth ..................................................................32-38
qos port maximum ingress-bandwidth .................................................................32-40
qos port maximum depth ......................................................................................32-42
qos port default 802.1p .........................................................................................32-44
qos port default dscp ............................................................................................32-45
qos port default classification ...............................................................................32-46
qos port dei ...........................................................................................................32-48
qos qsi qsp ............................................................................................................32-50
qos qsi stats ...........................................................................................................32-52
show qos port .......................................................................................................32-54
show qos slice .......................................................................................................32-56
show qos log .........................................................................................................32-58
show qos config ....................................................................................................32-60
show qos statistics ................................................................................................32-62
show qos dscp-table .............................................................................................32-65
show qos qsi summary .........................................................................................32-67
show qos qsp ........................................................................................................32-69
show qos qsi .........................................................................................................32-73
show qos qsi stats .................................................................................................32-77
clear qos qsi stats ..................................................................................................32-80

Chapter 33 QoS Policy Commands ............................................................................................ 33-1

policy rule ...............................................................................................................33-5
policy validity-period .............................................................................................33-9
policy list ..............................................................................................................33-12
policy list rules .....................................................................................................33-14
policy network group ...........................................................................................33-16
policy service group .............................................................................................33-18
policy mac group ..................................................................................................33-20
policy port group ..................................................................................................33-22
policy map group ..................................................................................................33-24
policy service ........................................................................................................33-26
policy service protocol .........................................................................................33-29
policy service source tcp-port ..............................................................................33-31
policy service destination tcp-port .......................................................................33-33
policy service source udp-port .............................................................................33-35
policy service destination udp-port ......................................................................33-37
policy condition ....................................................................................................33-39

xxvi OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Contents

policy condition source ip ....................................................................................33-42

policy condition source ipv6 ................................................................................33-44
policy condition destination ip .............................................................................33-46
policy condition destination ipv6 .........................................................................33-48
policy condition multicast ip ................................................................................33-50
policy condition source network group ................................................................33-52
policy condition destination network group .........................................................33-54
policy condition multicast network group ............................................................33-56
policy condition source ip-port ............................................................................33-58
policy condition destination ip-port .....................................................................33-60
policy condition source tcp-port ...........................................................................33-62
policy condition destination tcp-port ....................................................................33-64
policy condition source udp-port ..........................................................................33-66
policy condition destination udp-port ..................................................................33-68
policy condition ethertype ....................................................................................33-70
policy condition established .................................................................................33-72
policy condition tcpflags ......................................................................................33-74
policy condition service .......................................................................................33-76
policy condition service group .............................................................................33-77
policy condition icmptype ....................................................................................33-79
policy condition icmpcode ...................................................................................33-81
policy condition ip-protocol .................................................................................33-83
policy condition ipv6 ............................................................................................33-85
policy condition nh ...............................................................................................33-87
policy condition flow-label ..................................................................................33-89
policy condition tos ..............................................................................................33-91
policy condition dscp ...........................................................................................33-93
policy condition source mac .................................................................................33-95
policy condition destination mac ..........................................................................33-97
policy condition source mac group ......................................................................33-99
policy condition destination mac group .............................................................33-101
policy condition source vlan ..............................................................................33-103
policy condition inner source-vlan .....................................................................33-104
policy condition destination vlan .......................................................................33-106
policy condition 802.1p ......................................................................................33-108
policy condition inner 802.1p .............................................................................33-109
policy condition source port ...............................................................................33-111
policy condition destination port ........................................................................33-113
policy condition source port group .....................................................................33-115
policy condition source port split-group ............................................................33-117
policy condition destination port group .............................................................33-119
policy condition vrf ............................................................................................33-121
policy condition fragments .................................................................................33-123
policy condition app-mon ...................................................................................33-124
policy action .......................................................................................................33-126
policy action disposition .....................................................................................33-128
policy action shared ............................................................................................33-130
policy action priority ..........................................................................................33-132
policy action maximum bandwidth ....................................................................33-134
policy action maximum depth ............................................................................33-136
policy action cir ..................................................................................................33-138
policy action cpu priority ...................................................................................33-141

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 xxvii

 Contents

policy action tos .................................................................................................33-142

policy action 802.1p ...........................................................................................33-144
policy action dscp ...............................................................................................33-146
policy action map ...............................................................................................33-148
policy action permanent gateway-ip ..................................................................33-150
policy action port-disable ...................................................................................33-152
policy action redirect port ..................................................................................33-154
policy action redirect linkagg .............................................................................33-156
policy action no-cache ........................................................................................33-158
policy action mirror ............................................................................................33-159
show policy network group ................................................................................33-161
show policy service ............................................................................................33-163
show policy service group ..................................................................................33-165
show policy mac group ......................................................................................33-167
show policy port group .......................................................................................33-169
show policy map group ......................................................................................33-171
show policy action ..............................................................................................33-173
show policy condition ........................................................................................33-175
show active policy rule .......................................................................................33-178
show policy rule .................................................................................................33-181
show policy validity period ................................................................................33-183
show active policy list ........................................................................................33-185
show policy list ...................................................................................................33-187

Chapter 34 Policy Server Commands ........................................................................................ 34-1

policy server load ...................................................................................................34-2
policy server flush ..................................................................................................34-3
policy server ...........................................................................................................34-4
show policy server ..................................................................................................34-6
show policy server long ..........................................................................................34-8
show policy server statistics .................................................................................34-10
show policy server rules .......................................................................................34-12
show policy server events ....................................................................................34-14

Chapter 35 AAA Commands ........................................................................................................ 35-1

aaa radius-server .....................................................................................................35-3
aaa tacacs+-server ..................................................................................................35-5
aaa ldap-server ........................................................................................................35-7
aaa test-radius-server ............................................................................................35-10
system fips admin-state ........................................................................................35-12
aaa authentication .................................................................................................35-13
aaa authentication default .....................................................................................35-15
aaa accounting session .........................................................................................35-17
aaa accounting command .....................................................................................35-19
aaa device-authentication .....................................................................................35-21
aaa accounting ......................................................................................................35-23
aaa accounting radius calling-station-id ...............................................................35-25
aaa 802.1x re-authentication ................................................................................35-27
aaa interim-interval ..............................................................................................35-29
aaa session-timeout ..............................................................................................35-31
aaa inactivity-logout .............................................................................................35-33
aaa radius nas-port-id ...........................................................................................35-35

xxviii OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Contents

aaa radius nas-identifier .......................................................................................35-36

aaa radius mac-format ..........................................................................................35-37
aaa profile .............................................................................................................35-39
user .......................................................................................................................35-43
password ...............................................................................................................35-46
user password-size min ........................................................................................35-48
user password-expiration ......................................................................................35-49
user password-policy cannot-contain-username ..................................................35-51
user password-policy min-uppercase ...................................................................35-52
user password-policy min-lowercase ...................................................................35-53
user password-policy min-digit ............................................................................35-54
user password-policy min-nonalpha .....................................................................35-55
user password-history ...........................................................................................35-56
user password-min-age .........................................................................................35-57
user lockout-window ............................................................................................35-58
user lockout-threshold ..........................................................................................35-60
user lockout-duration ............................................................................................35-62
user lockout unlock ..............................................................................................35-64
show aaa server ....................................................................................................35-65
show aaa authentication .......................................................................................35-68
show aaa device-authentication ............................................................................35-70
show aaa accounting .............................................................................................35-72
show aaa config ....................................................................................................35-74
show aaa radius config .........................................................................................35-77
show aaa profile ...................................................................................................35-79
show user ..............................................................................................................35-82
show user password-policy ..................................................................................35-85
show user lockout-setting .....................................................................................35-87
show aaa priv hexa ...............................................................................................35-89
show system fips ..................................................................................................35-92

Chapter 36 UNP Commands ........................................................................................................ 36-1

unp edge-profile .....................................................................................................36-6
unp edge-profile qos-policy-list .............................................................................36-8
unp edge-profile location-policy ..........................................................................36-10
unp edge-profile period-policy .............................................................................36-12
unp edge-profile captive-portal-authentication ....................................................36-14
unp edge-profile captive-portal-profile ................................................................36-16
unp edge-profile authentication-flag ....................................................................36-18
unp edge-profile mobile-tag .................................................................................36-19
unp edge-profile redirect ......................................................................................36-21
unp edge-profile maximum-ingress-bandwidth ...................................................36-22
unp edge-profile maximum-egress-bandwidth .....................................................36-24
unp edge-profile maximum-ingress-depth ...........................................................36-26
unp edge-profile maximum-egress-depth .............................................................36-28
unp vlan-mapping edge-profile ............................................................................36-30
unp vlan-profile ....................................................................................................36-32
unp vlan-profile qos-policy-list ............................................................................36-34
unp vlan-profile mobile-tag ..................................................................................36-36
unp vlan-profile maximum-ingress-bandwidth ....................................................36-38
unp vlan-profile maximum-egress-bandwidth .....................................................36-40
unp vlan-profile maximum-ingress-depth ............................................................36-42

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 xxix

 Contents

unp vlan-profile maximum-egress-depth .............................................................36-44

unp vlan-profile saa-profile ..................................................................................36-46
unp spb-profile .....................................................................................................36-48
unp spb-profile qos-policy-list .............................................................................36-51
unp spb-profile multicast-mode ...........................................................................36-53
unp spb-profile vlan-xlation .................................................................................36-55
unp spb-profile mobile-tag ...................................................................................36-57
unp saa-profile ......................................................................................................36-59
unp port ................................................................................................................36-61
unp redirect port-bounce ......................................................................................36-64
unp port group-id ..................................................................................................36-66
unp unp-customer-domain ....................................................................................36-68
unp default-edge-profile .......................................................................................36-70
unp default-vlan-profile ........................................................................................36-72
unp default-spb-profile .........................................................................................36-74
unp aaa-profile ......................................................................................................36-76
unp port edge-template .........................................................................................36-78
unp mac-authentication ........................................................................................36-80
unp mac-authentication pass-alternate .................................................................36-82
unp 802.1x-authentication ....................................................................................36-84
unp 802.1x-authentication pass-alternate .............................................................36-86
unp 802.1x-authentication tx-period ....................................................................36-88
unp 802.1x-authentication supp-timeout ..............................................................36-90
unp 802.1x-authentication max-req ......................................................................36-92
unp 802.1x-authentication bypass ........................................................................36-94
unp mac-authentication allow-eap .......................................................................36-96
unp 802.1x-authentication failure-policy .............................................................36-98
unp classification ................................................................................................36-100
unp trust-tag ........................................................................................................36-102
unp direction .......................................................................................................36-104
unp vlan ..............................................................................................................36-106
unp edge-template ..............................................................................................36-108
unp classification port ........................................................................................36-112
unp classification group-id .................................................................................36-114
unp classification mac-address ...........................................................................36-116
unp classification mac-oui ..................................................................................36-120
unp classification mac-address-range .................................................................36-122
unp classification ip-address ..............................................................................36-125
unp classification vlan-tag ..................................................................................36-129
unp classification lldp med-endpoint ip-phone ..................................................36-132
unp classification authentication-type ................................................................36-134
unp classification-rule ........................................................................................36-136
unp classification-rule port .................................................................................36-138
unp classification-rule group-id .........................................................................36-140
unp classification-rule mac-address ...................................................................36-141
unp classification-rule mac-oui ..........................................................................36-142
unp classification-rule mac-address-range .........................................................36-144
unp classification-rule ip-address .......................................................................36-146
unp classification-rule vlan-tag ..........................................................................36-148
unp classification-rule lldp med-endpoint ip-phone ...........................................36-149
unp classification-rule authentication-type ........................................................36-150
unp user-role .......................................................................................................36-152

xxx OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Contents

unp user-role policy-list .....................................................................................36-154

unp user-role edge-profile ..................................................................................36-156
unp user-role authentication-type .......................................................................36-158
unp user-role cp-status-post-login ......................................................................36-160
unp restricted-role policy-list .............................................................................36-162
unp group-id .......................................................................................................36-164
unp customer-domain .........................................................................................36-166
unp policy validity-period ..................................................................................36-168
unp policy validity-location ...............................................................................36-171
unp dynamic-vlan-configuration ........................................................................36-173
unp dynamic-profile-configuration ....................................................................36-175
unp auth-server-down .........................................................................................36-177
unp auth-server-down timeout ...........................................................................36-179
unp redirect pause-timer .....................................................................................36-181
unp redirect proxy-server-port ...........................................................................36-183
unp redirect-server ..............................................................................................36-184
unp redirect allowed-name .................................................................................36-186
unp edge-user flush ............................................................................................36-188
unp spb-access-user flush ...................................................................................36-190
show unp global configuration ...........................................................................36-192
show unp edge-profile ........................................................................................36-195
show unp edge-profile vlan-mapping .................................................................36-198
show unp edge-template .....................................................................................36-200
show unp vlan-profile .........................................................................................36-204
show unp spb-profile ..........................................................................................36-206
show unp saa-profile ..........................................................................................36-208
show unp group-id ..............................................................................................36-210
show unp customer-domain ...............................................................................36-212
show unp classification ......................................................................................36-214
show unp classification-rule ...............................................................................36-217
show unp user-role .............................................................................................36-219
show unp restricted-role .....................................................................................36-221
show unp port .....................................................................................................36-223
show unp port bandwidth ...................................................................................36-228
show unp port 802.1x statistics ..........................................................................36-231
show unp port configured-vlans .........................................................................36-233
show unp user .....................................................................................................36-235
show unp edge-user ............................................................................................36-239
show unp edge-user status ..................................................................................36-242
show unp edge-user details ................................................................................36-244
show unp vlan-user details .................................................................................36-248
show unp spb-access-user details .......................................................................36-251
show unp policy validity-period .........................................................................36-254
show unp policy validity-location ......................................................................36-256
captive-portal name ............................................................................................36-257
captive-portal ip-address ....................................................................................36-259
captive-portal success-redirect-url .....................................................................36-261
captive-portal proxy-server-port ........................................................................36-262
captive-portal retry-count ...................................................................................36-263
captive-portal authentication-pass ......................................................................36-264
captive-portal-profile ..........................................................................................36-267
captive-portal customization ..............................................................................36-270

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 xxxi

 Contents

show captive-portal configuration ......................................................................36-272

show captive-portal profile-name .......................................................................36-275
qmr quarantine path ............................................................................................36-277
qmr quarantine page ...........................................................................................36-279
qmr quarantine allowed-name ............................................................................36-281
qmr quarantine custom-proxy ............................................................................36-283
show qmr ............................................................................................................36-285
show quarantine mac group ................................................................................36-287
mdns-relay ..........................................................................................................36-289
mdns-relay tunnel ...............................................................................................36-290
show mdns-relay config .....................................................................................36-292
ssdp-relay ...........................................................................................................36-293
ssdp-relay tunnel ................................................................................................36-295
show ssdp-relay config .......................................................................................36-297

Chapter 37 Application Monitoring and Enforcement Commands .................................. 37-1

app-mon admin-state ..............................................................................................37-3
app-mon port admin-state .......................................................................................37-4
app-mon auto-group create .....................................................................................37-6
app-mon app-group ................................................................................................37-7
app-mon app-list ...................................................................................................37-10
app-mon apply ......................................................................................................37-12
app-mon l3-mode .................................................................................................37-14
app-mon l4-mode .................................................................................................37-15
app-mon l4port-exclude .......................................................................................37-17
app-mon flow-table flush .....................................................................................37-19
app-mon flow-table enforcement stats .................................................................37-21
app-mon aging enforcement .................................................................................37-22
app-mon logging-threshold ..................................................................................37-24
app-mon flow-sync enforcement interval ............................................................37-25
app-mon force-flow-sync .....................................................................................37-26
show app-mon config ...........................................................................................37-27
show app-mon port ...............................................................................................37-29
show app-mon app-pool .......................................................................................37-31
show app-mon app-list .........................................................................................37-33
show app-mon app-group .....................................................................................37-38
show app-mon app-record ....................................................................................37-40
show app-mon ipv4-flow-table ............................................................................37-43
show app-mon ipv6-flow-table ............................................................................37-46
show app-mon l4port-exclude ..............................................................................37-49
show app-mon stats ..............................................................................................37-51
show app-mon aging enforcement .......................................................................37-53
show app-mon vc-topology ..................................................................................37-55
clear app-mon app-list ..........................................................................................37-57

Chapter 38 Port Mapping Commands ...................................................................................... 38-1

port-mapping user-port network-port .....................................................................38-2
port-mapping ..........................................................................................................38-4
port-mapping [unidirectional | bidirectional] .........................................................38-6
port-mapping unknown-unicast-flooding ...............................................................38-8
show port-mapping status .....................................................................................38-10
show port-mapping ...............................................................................................38-12

xxxii OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Contents

Chapter 39 Learned Port Security Commands ....................................................................... 39-1

port-security ...........................................................................................................39-2
port-security learning-window ...............................................................................39-4
port-security convert-to-static ................................................................................39-7
port-security maximum ..........................................................................................39-9
port-security learn-trap-threshold .........................................................................39-11
port-security port max-filtering ............................................................................39-13
port-security mac-range ........................................................................................39-15
port-security port violation ...................................................................................39-17
show port-security ................................................................................................39-19
show port-security brief .......................................................................................39-22
show port-security learning-window ....................................................................39-24

Chapter 40 Port Mirroring and Monitoring Commands ...................................................... 40-1

port-mirroring source destination ...........................................................................40-2
port-mirroring .........................................................................................................40-5
port-monitoring source ...........................................................................................40-7
port-monitoring ......................................................................................................40-9
show port-mirroring status ...................................................................................40-10
show port-monitoring status .................................................................................40-13
show port-monitoring file .....................................................................................40-15

Chapter 41 sFlow Commands ...................................................................................................... 41-1

sflow receiver .........................................................................................................41-3
sflow sampler .........................................................................................................41-5
sflow poller .............................................................................................................41-7
show sflow agent ....................................................................................................41-9
show sflow receiver ..............................................................................................41-11
show sflow sampler ..............................................................................................41-13
show sflow poller .................................................................................................41-15

Chapter 42 RMON Commands .................................................................................................... 42-1

rmon probes ............................................................................................................42-2
show rmon probes ..................................................................................................42-4
show rmon events ...................................................................................................42-7

Chapter 43 Switch Logging Commands ................................................................................... 43-1

swlog ......................................................................................................................43-2
swlog appid ............................................................................................................43-4
swlog output ...........................................................................................................43-6
swlog output flash-file-size ....................................................................................43-8
swlog clear ..............................................................................................................43-9
show log swlog .....................................................................................................43-10
show swlog ...........................................................................................................43-12

Chapter 44 Health Monitoring Commands ............................................................................. 44-1

health threshold ......................................................................................................44-2
health interval .........................................................................................................44-4
show health configuration ......................................................................................44-5
show health .............................................................................................................44-7
show health all ........................................................................................................44-9

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 xxxiii

 Contents

Chapter 45 Ethernet OAM Commands ..................................................................................... 45-1

ethoam vlan ............................................................................................................45-3
ethoam domain .......................................................................................................45-5
ethoam domain mhf ................................................................................................45-7
ethoam domain id-permission ................................................................................45-8
ethoam association .................................................................................................45-9
ethoam association mhf ........................................................................................45-11
ethoam association id-permission ........................................................................45-13
ethoam association ccm-interval ..........................................................................45-15
ethoam association endpoint-list ..........................................................................45-17
clear ethoam statistics ...........................................................................................45-19
ethoam default-domain level ................................................................................45-20
ethoam default-domain mhf .................................................................................45-21
ethoam default-domain id-permission ..................................................................45-22
ethoam default-domain primary-vlan ...................................................................45-23
ethoam endpoint ...................................................................................................45-25
ethoam endpoint admin-state ...............................................................................45-27
ethoam endpoint rfp .............................................................................................45-29
ethoam endpoint ccm ...........................................................................................45-31
ethoam endpoint priority ......................................................................................45-33
ethoam endpoint lowest-defect-priority ...............................................................45-35
ethoam linktrace ...................................................................................................45-37
ethoam loopback ..................................................................................................45-39
ethoam fault-alarm-time .......................................................................................45-41
ethoam fault-reset-time ........................................................................................45-43
ethoam one-way-delay .........................................................................................45-45
ethoam two-way-delay .........................................................................................45-47
clear ethoam .........................................................................................................45-49
show ethoam .........................................................................................................45-50
show ethoam domain ............................................................................................45-52
show ethoam domain association .........................................................................45-54
show ethoam domain association end-point .........................................................45-56
show ethoam default-domain configuration .........................................................45-59
show ethoam default-domain ...............................................................................45-61
show ethoam remote-endpoint domain ................................................................45-63
show ethoam cfmstack .........................................................................................45-65
show ethoam linktrace-reply ................................................................................45-67
show ethoam linktrace-tran-id ..............................................................................45-70
show ethoam vlan .................................................................................................45-72
show ethoam statistics ..........................................................................................45-73
show ethoam config-error ....................................................................................45-75
show ethoam one-way-delay ................................................................................45-77
show ethoam two-way-delay ................................................................................45-79

Chapter 46 VLAN Stacking Commands .................................................................................... 46-1

ethernet-service svlan .............................................................................................46-2
ethernet-service service-name ................................................................................46-4
ethernet-service nni ................................................................................................46-6
ethernet-service svlan nni .......................................................................................46-8
ethernet-service sap ..............................................................................................46-10
ethernet-service sap uni ........................................................................................46-12
ethernet-service sap cvlan ....................................................................................46-14

xxxiv OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Contents

ethernet-service sap-profile ..................................................................................46-16

ethernet-service sap sap-profile ............................................................................46-19
ethernet-service uni-profile ..................................................................................46-21
ethernet-service uni uni-profile ............................................................................46-24
show ethernet-service vlan ...................................................................................46-26
show ethernet-service ...........................................................................................46-28
show ethernet-service sap .....................................................................................46-31
show ethernet-service ...........................................................................................46-33
show ethernet-service nni .....................................................................................46-36
show ethernet-service uni .....................................................................................46-38
show ethernet-service uni-profile .........................................................................46-40
show ethernet-service sap-profile .........................................................................46-42

Chapter 47 Service Manager Commands ................................................................................47-1

service spb ..............................................................................................................47-3
service spb description ...........................................................................................47-5
service spb stats ......................................................................................................47-7
service spb admin-state ..........................................................................................47-9
service spb multicast-mode ..................................................................................47-11
service spb vlan-xlation ........................................................................................47-13
service stats ..........................................................................................................47-15
service l2profile ....................................................................................................47-16
service access .......................................................................................................47-18
service access l2profile .........................................................................................47-20
service access vlan-xlation ...................................................................................47-22
service spb sap ......................................................................................................47-24
service spb sap description ...................................................................................47-26
service spb sap trusted ..........................................................................................47-28
service spb sap admin-state ..................................................................................47-30
service spb sap stats ..............................................................................................47-32
show service l2profile ..........................................................................................47-34
show service access ..............................................................................................47-36
show service .........................................................................................................47-38
show service spb ports ..........................................................................................47-40
show service spb sap ............................................................................................47-42
show service sdp ...................................................................................................47-44
show service mesh-sdp .........................................................................................47-47
show service spb debug-info ................................................................................47-49
show service spb counters ....................................................................................47-51
clear service spb counters .....................................................................................47-53

Chapter 48 CMM Commands ....................................................................................................... 48-1

reload secondary .....................................................................................................48-2
reload all .................................................................................................................48-4
reload from .............................................................................................................48-6
reload slot ...............................................................................................................48-8
reload chassis-id .....................................................................................................48-9
copy certified ........................................................................................................48-11
issu from ...............................................................................................................48-12
issu slot .................................................................................................................48-13
write memory .......................................................................................................48-14
copy running certified ..........................................................................................48-15

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 xxxv

 Contents

modify running-directory .....................................................................................48-17

copy flash-synchro ...............................................................................................48-18
takeover ................................................................................................................48-19
show running-directory ........................................................................................48-20
show reload ..........................................................................................................48-22
show microcode ....................................................................................................48-24
usb ........................................................................................................................48-26
usb auto-copy .......................................................................................................48-27
mount ....................................................................................................................48-29
umount ..................................................................................................................48-30
show usb statistics ................................................................................................48-31
show issu status ....................................................................................................48-33

Chapter 49 Chassis Management and Monitoring Commands ........................................ 49-1

system contact ........................................................................................................49-3
system name ...........................................................................................................49-4
system location .......................................................................................................49-5
system date .............................................................................................................49-6
system time .............................................................................................................49-7
system timezone .....................................................................................................49-8
system daylight-savings-time ...............................................................................49-10
update uboot .........................................................................................................49-11
update fpga-cpld ...................................................................................................49-13
hash-control ..........................................................................................................49-15
bluetooth ...............................................................................................................49-17
license ...................................................................................................................49-18
show system .........................................................................................................49-19
show hardware-info ..............................................................................................49-21
show chassis .........................................................................................................49-23
show cmm ............................................................................................................49-25
show slot ...............................................................................................................49-27
show module ........................................................................................................49-29
show module long ................................................................................................49-31
show module status ..............................................................................................49-33
show powersupply ................................................................................................49-35
show fan ...............................................................................................................49-37
show fantray .........................................................................................................49-38
show temperature .................................................................................................49-40
show hash-control ................................................................................................49-42
show license-info ..................................................................................................49-43
show bluetooth status ...........................................................................................49-45
show me ................................................................................................................49-47
power-shelf slot bps-connector-priority ...............................................................49-48
power-shelf shelf bps-mode .................................................................................49-50
update bps-firmware shelf ....................................................................................49-51
show power-shelf bps-connector-priority ............................................................49-52
show power-shelf bps ...........................................................................................49-54
show powersupply bps shelf ................................................................................49-56
show mac-range ....................................................................................................49-59

xxxvi OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Contents

Chapter 50 Network Time Protocol Commands ..................................................................... 50-1

ntp server ................................................................................................................50-3
ntp server synchronized ..........................................................................................50-5
ntp server unsynchronized ......................................................................................50-6
ntp client .................................................................................................................50-7
ntp broadcast-client ................................................................................................50-8
ntp broadcast-delay ................................................................................................50-9
ntp key ..................................................................................................................50-10
ntp key load ..........................................................................................................50-12
ntp authenticate ....................................................................................................50-13
ntp master .............................................................................................................50-14
ntp interface ..........................................................................................................50-15
ntp max-associations ............................................................................................50-16
ntp broadcast ........................................................................................................50-17
ntp peer .................................................................................................................50-19
ntp vrf-name .........................................................................................................50-21
show ntp status .....................................................................................................50-22
show ntp client .....................................................................................................50-24
show ntp client server-list ....................................................................................50-26
show ntp server client-list ....................................................................................50-28
show ntp server status ..........................................................................................50-30
show ntp keys .......................................................................................................50-34
show ntp peers ......................................................................................................50-36
show ntp server disabled-interfaces .....................................................................50-38

Chapter 51 Session Management Commands ....................................................................... 51-1

session login-attempt ..............................................................................................51-3
session login-timeout ..............................................................................................51-4
session banner ........................................................................................................51-5
session timeout .......................................................................................................51-7
session prompt ........................................................................................................51-8
session xon-xoff .....................................................................................................51-9
show prefix ...........................................................................................................51-10
user profile save ...................................................................................................51-11
user profile save global-profile ............................................................................51-12
user profile reset ...................................................................................................51-14
history ...................................................................................................................51-15
! .............................................................................................................................51-16
command-log ........................................................................................................51-18
kill .........................................................................................................................51-19
exit ........................................................................................................................51-20
whoami .................................................................................................................51-21
who .......................................................................................................................51-23
show session config ..............................................................................................51-25
show session xon-xoff ..........................................................................................51-27
more ......................................................................................................................51-28
telnet .....................................................................................................................51-29
ssh .........................................................................................................................51-31
ssh enforce-pubkey-auth ......................................................................................51-33
show command-log ..............................................................................................51-34
show command-log status ....................................................................................51-36

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 xxxvii

 Contents

show telnet ............................................................................................................51-37

show ssh ...............................................................................................................51-38

Chapter 52 File Management Commands ............................................................................... 52-1

cd ............................................................................................................................52-2
pwd .........................................................................................................................52-3
mkdir ......................................................................................................................52-4
rmdir .......................................................................................................................52-6
ls .............................................................................................................................52-8
rm .........................................................................................................................52-10
cp ..........................................................................................................................52-12
scp .........................................................................................................................52-14
mv .........................................................................................................................52-16
chmod ...................................................................................................................52-18
freespace ...............................................................................................................52-19
fsck .......................................................................................................................52-20
newfs ....................................................................................................................52-22
vi ...........................................................................................................................52-23
tty ..........................................................................................................................52-25
show tty ................................................................................................................52-27
tftp ........................................................................................................................52-28
sftp ........................................................................................................................52-30
ftp .........................................................................................................................52-32
show ftp ................................................................................................................52-34

Chapter 53 Web Management Commands ............................................................................. 53-1

webview server .......................................................................................................53-2
webview access ......................................................................................................53-3
webview force-ssl ...................................................................................................53-4
webview http-port ..................................................................................................53-5
webview https-port .................................................................................................53-6
show webview ........................................................................................................53-7

Chapter 54 Configuration File Manager Commands ........................................................... 54-1

configuration apply ................................................................................................54-2
configuration error-file-limit ..................................................................................54-4
show configuration status .......................................................................................54-6
configuration cancel ...............................................................................................54-8
configuration syntax-check ....................................................................................54-9
configuration snapshot .........................................................................................54-11
show configuration snapshot ................................................................................54-13
write terminal .......................................................................................................54-15

Chapter 55 SNMP Commands ..................................................................................................... 55-1

snmp station ............................................................................................................55-3
show snmp station ..................................................................................................55-5
snmp community-map ............................................................................................55-7
snmp community-map mode ..................................................................................55-9
show snmp community-map ................................................................................55-10
snmp security ........................................................................................................55-12
show snmp security ..............................................................................................55-14
show snmp statistics .............................................................................................55-16

xxxviii OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Contents

show snmp mib-family .........................................................................................55-18

snmp-trap absorption ............................................................................................55-20
snmp-trap to-webview ..........................................................................................55-21
snmp-trap replay-ip ..............................................................................................55-22
snmp-trap filter-ip ................................................................................................55-24
snmp authentication-trap ......................................................................................55-26
show snmp-trap replay-ip .....................................................................................55-27
show snmp-trap filter-ip .......................................................................................55-29
show snmp authentication-trap .............................................................................55-31
show snmp-trap config .........................................................................................55-32

Chapter 56 OpenFlow Commands ............................................................................................. 56-1

openflow back-off-max ..........................................................................................56-2
openflow idle-probe-timeout ..................................................................................56-3
openflow logical-switch .........................................................................................56-4
openflow logical-switch controller .........................................................................56-6
openflow logical-switch interfaces .........................................................................56-8
show openflow .......................................................................................................56-9
show openflow logical-switch ..............................................................................56-10

Chapter 57 DNS Commands ........................................................................................................ 57-1

ip domain-lookup ...................................................................................................57-2
ip name-server ........................................................................................................57-3
ipv6 name-server ....................................................................................................57-5
ip domain-name ......................................................................................................57-7
show dns .................................................................................................................57-8

Appendix A Software License and Copyright Statements ..................................................... A-1

Alcatel-Lucent License Agreement ................................................................................ A-1
ALCATEL-LUCENT SOFTWARE LICENSE AGREEMENT ............................ A-1
Third Party Licenses and Notices .................................................................................. A-4
CLI Quick Reference

Index ...................................................................................................................... Index-1

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 xxxix

 Contents

xl OmniSwitch AOS Release 8 CLI Reference Guide November 2015

 About This Guide

This OmniSwitch AOS Release 8 CLI Reference Guide is a comprehensive resource to all Command Line
Interface (CLI) commands available on the OmniSwitch 6860, 6860E Series switches.

Supported Platforms
The information in this guide applies only to OmniSwitch 6860, 6860E switches.

Who Should Read this Manual?

The audience for this user guide is network administrators and IT support personnel who need to config-
ure, maintain, and monitor switches and routers in a live network. Anyone wishing to gain knowledge on
the details of all CLI commands available on the OmniSwitch will benefit from the material in this refer-
ence guide. However, advanced users who have already familiarized themselves with the OmniSwitch CLI
commands will benefit most from the detailed content in this guide.

When Should I Read this Manual?

Read this guide whenever you want detailed information on individual CLI commands. Although this
guide provides helpful information during any stage of the configuration process, it is a good idea to first
familiarize yourself with the software features available on the switch before investigating the detailed
command information in this guide.
Overview information, procedures, and live network examples on switch software features can be found in
the OmniSwitch AOS Release 8 Switch Management Guide, OmniSwitch AOS Release 8 Network Configu-
ration Guide, and the OmniSwitch AOS Release 8 Advanced Routing Configuration Guide. Once you are
familiar with the procedures and base CLI commands in these configuration guides you can obtain more
detailed information on the individual commands in this guide.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 xli

What is in this Manual?
This reference guide includes information on every CLI command available in the switch. Command
reference information is included for base software commands as well as commands associated with
optional software packages, such as Advanced Routing (multicast routing protocols and OSPF). The infor-
mation provided for each CLI command includes:
• Command description.

• Syntax.

• Description of all keywords and variables included in the syntax.

• Default values.

• Usage guidelines, which include tips on when and how to use the command.

• Examples of command lines using the command.

• Related commands with descriptions.

• Release history, which indicates the release when the command was introduced.

• SNMP information, such as the MIB files related to a set of CLI commands. In addition each CLI
command includes the corresponding MIB variables that map to all parameters included in a command.

What is Not in this Manual?

Primarily a reference, this guide does not provide step-by-step instructions on how to set up particular
features on the switch. It also does not provide overview or application examples on software features. For
comprehensive information on how to configure particular software features in the switch, consult the
appropriate configuration guide.
This guide also does not provide any information on the network management applications, WebView and
OmniVista. Further information on WebView and OmniVista can be found in the context-sensitive on-line
help available with those applications.

How is the Information Organized?

Each chapter in this guide includes reference material for all commands related to a single software
feature, such as server load balancing or link aggregation. Typically commands in a single chapter will
share a common prefix.

xlii OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Text Conventions
The following table contains text conventions and usage guidelines for CLI commands as they are
documented in this guide.

bold text Indicates basic command and keyword syntax.

Example: show snmp station
italicized text Indicates user-specific information such as IP addresses, slot numbers,
passwords, names, etc.
Example: no snmp station ip_address

Italicized text that is not enclosed with straight brackets ([ ]) indicates

required information.
[ ] (Straight Brackets) Indicates optional parameters for a given command.
Example: show aaa server [server_name]
Here, you can enter either of the following options:
show aaa server
show aaa server server_name (where server_name is the user-
specified server name, e.g., show aaa server myserver1)

Note that this example includes italicized text. The optional parameter
in this case is a user-specified server name.
{ } (Curly Braces) Indicates that the user must choose between one or more parameters.
Example: port mirroring {enable | disable}
Here, you must choose one of the following:
port mirroring enable or port mirroring disable
| (Vertical Pipes) Used to separate parameter choices within a command string. For
example, the command string
show health threshold [rx | txrx | memory | cpu]
separates the choices rx, txrx, memory, and cpu.
Examples:
show health threshold rx
show health threshold txrx
show health threshold memory
show health threshold cpu
‘ ‘(Quotation Marks) Used to enclose text strings that contain spaces. The quotation marks
are required input on the command line.
Example: vlan 2 ‘new test vlan’

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 xliii

Documentation Roadmap
The OmniSwitch user documentation suite was designed to supply you with information at several critical
junctures of the configuration process.The following section outlines a roadmap of the manuals that will
help you at each stage of the configuration process. Under each stage, we point you to the manual or
manuals that will be most helpful to you.

Stage 1: Using the Switch for the First Time

Pertinent Documentation: Release Notes
OmniSwitch Hardware Users Guide
A hard-copy OmniSwitch AOS Release 8 Getting Started Guide is included with your switch; this guide
provides all the information you need to get your switch up and running the first time. It provides
information on unpacking the switch, rack mounting the switch, installing NI modules, unlocking access
control, setting the switch’s IP address, and setting up a password. It also includes succinct overview
information on fundamental aspects of the switch, such as hardware LEDs, the software directory
structure, CLI conventions, and web-based management.
At this time you should also familiarize yourself with the Release Notes that accompanied your switch.
This document includes important information on feature limitations that are not included in other user
guides.

Stage 2: Gaining Familiarity with Basic Switch Functions

Pertinent Documentation: OmniSwitch Hardware Users Guide
OmniSwitch AOS Release 8 Switch Management Guide
Once you have your switch up and running, you will want to begin investigating basic aspects of its
hardware and software. Information about switch hardware is provided in the OmniSwitch AOS Release 8
Hardware Guide. This guide provide specifications, illustrations, and descriptions of all hardware
components, such as chassis, power supplies, Chassis Management Modules (CMMs), Network Interface
(NI) modules, and cooling fans. It also includes steps for common procedures, such as removing and
installing switch components.
This guide is the primary users guide for the basic software features on a single switch. This guide
contains information on the switch directory structure, basic file and directory utilities, switch access
security, SNMP, and web-based management. It is recommended that you read this guide before
connecting your switch to the network.

Stage 3: Integrating the Switch Into a Network

Pertinent Documentation: OmniSwitch AOS Release 8 Network Configuration Guide
OmniSwitch AOS Release 8 Advanced Routing Configuration Guide
When you are ready to connect your switch to the network, you will need to learn how the OmniSwitch
implements fundamental software features, such as 802.1Q, VLANs, Spanning Tree, and network routing
protocols. The OmniSwitch AOS Release 8 Network Configuration Guide contains overview information,
procedures, and examples on how standard networking technologies are configured on the OmniSwitch.
The OmniSwitch AOS Release 8 Advanced Routing Configuration Guide includes configuration
information for networks using advanced routing technologies (OSPF and BGP) and multicast routing
protocols (DVMRP and PIM-SM).

xliv OmniSwitch AOS Release 8 CLI Reference Guide November 2015

 Anytime
The OmniSwitch AOS Release 8 CLI Reference Guide contains comprehensive information on all CLI
commands supported by the switch. This guide includes syntax, default, usage, example, related CLI
command, and CLI-to-MIB variable mapping information for all CLI commands supported by the switch.
This guide can be consulted anytime during the configuration process to find detailed and specific
information on each CLI command.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 xlv

Related Documentation
The following are the titles and descriptions of all the related OmniSwitch user manuals:
• OmniSwitch Hardware Users Guides

Describes the hardware and software procedures for getting an OmniSwitch up and running. Also
provides information on fundamental aspects of OmniSwitch software architecture.
• OmniSwitch AOS Release 8 CLI Reference Guide

Complete reference to all CLI commands supported on the OmniSwitch. Includes syntax definitions,
default values, examples, usage guidelines and CLI-to-MIB variable mappings.
• OmniSwitch AOS Release 8 Switch Management Guide

Includes procedures for readying an individual switch for integration into a network. Topics include the
software directory architecture, image rollback protections, authenticated switch access, managing
switch files, system configuration, using SNMP, and using web management software (WebView).
• OmniSwitch AOS Release 8 Network Configuration Guide

Includes network configuration procedures and descriptive information on all the major software
features and protocols included in the base software package. Chapters cover Layer 2 information
(Ethernet and VLAN configuration), Layer 3 information (routing protocols, such as RIP and IPX),
security options (authenticated VLANs), Quality of Service (QoS), link aggregation, and server load
balancing.
• OmniSwitch AOS Release 8 Advanced Routing Configuration Guide

Includes network configuration procedures and descriptive information on all the software features and
protocols included in the advanced routing software package. Chapters cover multicast routing
(DVMRP and PIM-SM), Open Shortest Path First (OSPF), and Border Gateway Protocol (BGP).
• OmniSwitch Transceivers Guide

Includes SFP and XFP transceiver specifications and product compatibility information.
• Technical Tips, Field Notices

Includes information published by Alcatel-Lucent’s Customer Support group.

• Release Notes

Includes critical Open Problem Reports, feature exceptions, and other important information on the
features supported in the current release and any limitations to their support.

xlvi OmniSwitch AOS Release 8 CLI Reference Guide November 2015

Technical Support
An Alcatel-Lucent service agreement brings your company the assurance of 7x24 no-excuses technical
support. You’ll also receive regular software updates to maintain and maximize your Alcatel-Lucent
product’s features and functionality and on-site hardware replacement through our global network of
highly qualified service delivery partners.
With 24-hour access to Alcatel-Lucent’s Service and Support web page, you’ll be able to view and update
any case (open or closed) that you have reported to Alcatel-Lucent’s technical support, open a new case or
access helpful release notes, technical bulletins, and manuals.
Access additional information on Alcatel-Lucent’s Service Programs:
Web: service.esd.alcatel-lucent.com
Phone: 1-800-995-2696
Email: esd.support@alcatel-lucent.com

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 xlvii

xlviii OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 1 Ethernet Port Commands

The Ethernet port software is responsible for configuring and monitoring Ethernet ports. This includes:
• Performing hardware diagnostics, loading software, and initializing hardware.

• Notifying other software modules in the system when Ethernet links become active or inactive.

• Configuring basic line parameters for Ethernet ports.

• Gathering basic line statistics for Ethernet ports and passing this information to the user interface and
configuration manager.
MIB information for the Ethernet Port commands is as follows:
Filename: AlcatelIND1Port.mib
Module: alcatelIND1PortMIB
Filename: IETF_ETHERLIKE.mib
Module: EtherLike-MIB

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-1
 Ethernet Port Commands

A summary of the available commands is listed here.

Interfaces commands interfaces

interfaces speed
interfaces duplex
interfaces alias
clear interfaces
interfaces max-frame-size
interfaces flood-limit
interfaces flood-limit action
interfaces ingress-bandwidth
interfaces pause
interfaces link-trap
interfaces ddm
interfaces ddm-trap
interfaces wait-to-restore
interfaces wait-to-shutdown
interfaces eee
violation recovery-maximum
show interfaces alias
show interfaces status
show interfaces capability
show interfaces accounting
show interfaces counters
show interfaces counters errors
show interfaces flood-rate
show interfaces traffic
show interfaces ingress-rate-limit
show interfaces ddm
show transceivers
Interface violation commands violation recovery-maximum
violation recovery-time
violation recovery-trap
show violation
show violation-recovery-configuration
clear violation
Link monitoring commands show violation-recovery-configuration
interfaces link-monitoring time-window
interfaces link-monitoring link-flap-threshold
interfaces link-monitoring link-error-threshold
interfaces clear-link-monitoring-stats
show interfaces link-monitoring config
show interfaces link-monitoring statistics
Time Domain Reflectometry interfaces tdr
(TDR) commands show interfaces tdr-statistics
Link fault propagation link-fault-propagation group
commands link-fault-propagation group source
link-fault-propagation group destination
link-fault-propagation group wait-to-shutdown
show link-fault-propagation group

page 1-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands interfaces

interfaces
Enables or disables auto negotiation or administrative status on a single port, a range of ports, or an entire
Network Interface (NI).
interfaces {slot chassis/slot| port chassis/slot/port[-port2]} {admin-state | autoneg | epp} {enable |
disable}

Syntax Definitions

chassis The chassis identifier.

slot Slot number you want to configure.
port Port number of the interface you want to configure.
port2 Last port number in a range of ports you want to configure.
admin-state enable Enables administrative state.
admin-state disable Disables administrative state.
autoneg enable Enables auto negotiation.
autoneg disable Disables auto negotiation.
epp enable Enables Enhanced Port Performance.
epp disable Disables Enhanced Port Performance.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If auto negotiation is disabled, auto MDIX, flow control, auto speed, and auto duplex are not accepted.
See the interfaces duplex command on page 1-7 for more information.
• When EPP is enabled the fiber port receiver performance is enhanced by increasing its sampling rate.
This enhancement can help with port link connection reliability or CRC problems that may occur with
direct copper cable interfaces.
• Autonegotiation cannot be disabled on 10GBase-T ports.

Examples
-> interfaces slot 3/1 autoneg disable
-> interfaces 3/1/1 autoneg disable
-> interfaces 3/1/1-4 autoneg disable
-> interfaces 2/1/1-5 admin-state enable

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-3
interfaces Ethernet Port Commands

Release History
Release 8.1.1; command introduced.

Related Commands

interfaces Configures interface speed.

interfaces duplex Enables or disables flow (pause).
show interfaces alias Displays interface line settings.
violation recovery-maximum Displays auto negotiation, speed, duplex, and other general
interface information.

MIB Objects
esmConfTable
esmPortCfgAutoNegotiation

page 1-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands interfaces speed

interfaces speed
Configures interface line speed.
interfaces {slot chassis/slot | port chassis/slot/port [-port2]} speed {10 | 100 | 1000 | 10000 | auto | max
{10 | 100 | 1000}}

Syntax Definitions

chassis The chassis identifier.

slot Slot number you want to configure.
port Port number of the interface you want to configure.
port2 Last port number in a range of ports you want to configure.
auto The switch automatically sets the line speed to match the attached
device (auto-sensing).
10 Sets the interface to 10 Mbps.
100 Sets the interface to 100 Mbps.
1000 Sets the interface to 1000 Mbps (1 Gigabit).
10000 Sets the interface to 10000 Mbps (10 Gigabit).
2000 Sets the interface to 2000 Mbps for FibreChannel.
4000 Sets the interface to 4000 Mbps for FibreChannel.
8000 Sets the interface to 8000 Mbps for FibreChannel.
max 10 Sets the maximum speed to 10 Mbps.
max 100 Sets the maximum speed to 100 Mbps.
max 1000 Sets the maximum speed to 1000 Mbps (1 Gigabit).
max 4000 Sets the maximum speed to 4000 Mbps for FibreChannel.
max 8000 Sets the maximum speed to 8000 Mbps for FibreChannel.

Defaults

parameter default
auto enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> interfaces slot 3/1 speed auto
-> interfaces 3/1/1 speed 100

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-5
interfaces speed Ethernet Port Commands

-> interfaces 3/1/1-8 speed auto

Release History
Release 8.1.1; command introduced.

Related Commands

violation recovery-maximum Displays auto negotiation, speed, and duplex settings.

MIB Objects
esmConfTable
esmPortCfgSpeed

page 1-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands interfaces duplex

interfaces duplex
Configures duplex mode. In full duplex mode, the interface transmits and receives data simultaneously. In
half duplex mode, the interface can transmit or receive data at a given time. Auto duplex setting causes the
switch to advertise all available duplex modes (half/full/both) for the port during autonegotiation.
interfaces {slot chassis/slot| port chassis/slot/port[-port2]} duplex {full | half | auto}

Syntax Definitions

chassis The chassis identifier..

slot Slot number you want to configure.
port Port number of the interface you want to configure.
port2 Last port number in a range of ports you want to configure.
full Sets interface to full duplex mode.
half Sets interface to half duplex mode.
auto Switch automatically sets both the duplex mode settings to
auto-negotiation.

Defaults

parameter default
full | half | auto full

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• You can only configure one slot at a time. Repeat the command to configure additional slots.

• Half duplex mode is not supported on Gigabit modules if a port is detected as Gigabit (1000 Mbps).

• Gigabit and 10 Gigabit fiber ports only support full duplex.

Examples
-> interfaces slot 3/1 duplex auto
-> interfaces 3/1/1 duplex half
-> interfaces 3/1/1-4 auto

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-7
interfaces duplex Ethernet Port Commands

Related Commands

interfaces Configures interface line speed. Set to auto to set speed and duplex
mode to auto-sensing.
violation recovery-maximum Displays auto negotiation, speed, duplex, and other general
interface information.

MIB Objects
esmConfTable
esmPortAutoDuplexMode

page 1-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands interfaces alias

interfaces alias
Configures a description (alias) for a single port.
interfaces port chassis/slot/port alias description

Syntax Definitions

chassis The chassis identifier.

slot Slot number you want to configure.
port Port number of the interface you want to configure.
description A description for the port, which can be up to 40 characters long.
Description tags with spaces must be enclosed within quotes (e.g., “IP
Phone”).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• You can only configure one port at time. You cannot configure an alias for multiple ports.

• To remove an alias use a description consisting of two quotes without any spaces (e.g., "").

Examples
-> interfaces 3/1/1 alias "switch port"
-> interfaces 2/1/2 alias "IP Phone"
-> interfaces 3/1/1 alias ""

Release History
Release 8.1.1; command introduced.

Related Commands

show interfaces alias Displays port status (up or down) and any aliases for a port.

MIB Objects
ifXTable
ifAlias

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-9
clear interfaces Ethernet Port Commands

clear interfaces
Resets all statistics counters.
clear interfaces {slot chassis/slot | port chassis/slot/port[-port2]} {l2-statistics [cli] | tdr-statistics}

Syntax Definitions

chassis The chassis identifier.

slot Slot number you want to configure.
port Port number of the interface you want to configure.
port2 Last port number in a range of ports you want to configure.
cli Clears the CLI statistics only.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
There is no global clear statistics command for TDR. The highest level granularity supported for clearing
statistics is per chassis/slot.

Examples
-> clear interfaces 3/1/1 l2-statistics
-> clear interfaces 3/1/2 l2-statistics cli
-> clear interfaces 3/1/3 tdr-statistics

Release History
Release 8.1.1; command introduced.

Related Commands

show interfaces counters Displays general interface information, including when statistics
were last cleared.

MIB Objects
alcetherStatsTable
alcetherClearStats
esmTdrPortTable
esmTdrPortClearResults

page 1-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands interfaces max-frame-size

interfaces max-frame-size
Configures the maximum frame size for Gigabit Ethernet interfaces.
interfaces {slot chassis/slot | port chassis/slot/port[-port2} max-frame-size bytes

Syntax Definitions

chassis The chassis identifier.

slot Slot number you want to configure.
port Port number of the interface you want to configure.
port2 Last port number in a range of ports you want to configure.
max frame Maximum frame size, in bytes. Valid range is 1518–9216.

Defaults

parameter default
bytes (Gigabit Ethernet Packets) 9216
bytes (Ethernet Packets) 1553

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> interfaces 3/1/1 max-frame-size 1518
-> interfaces slot 3/1 max-frame-size 1518

Release History
Release 8.1.1; command introduced.

Related Commands

violation recovery-maximum Displays auto negotiation, speed, duplex, and other general
interface information.

MIB Objects
esmConfTable
esmPortCfgMaxFrameSize

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-11
interfaces flood-limit Ethernet Port Commands

interfaces flood-limit
Configures the flood rate settings on a single port, a range of ports, or an entire Network Interface (NI).
interfaces {slot chassis/slot| port chassis/slot/port[-port2]} flood-limit {bcast|mcast|uucast|all} rate {pps
pps_num| mbps mbps_num | cap% cap_num | enable | disable | default} low-threshold num

Syntax Definitions

chassis The chassis identifier.

slot Slot number you want to configure.
port Port number of the interface you want to configure.
port2 Last port number in a range of ports you want to configure.
bcast Specifies broadcast flood limit.
mcast Specifies multicast flood limit.
uucast Specifies unicast flood limit.
all Specifies flood limit for all types of traffic.
pps_num Packets per second.
mbps_num Megabits per second.
cap_num Percentage of port’s capacity.
enable Enables flood rate limits.
disable Disables flood rate limits.
default Sets default flood rate limits

Defaults

parameter default
enable | disable enable
low-threshold 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The auto recovery has to be enabled by configuring low threshold.

• The high and low threshold when configured, will have same type [mbps, pps, and percentage].

page 1-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands interfaces flood-limit

Examples
-> interfaces slot 3/1 flood-limit all rate cap% 50
-> interfaces 2/1/1 flood-limit bcast rate mbps 100
-> interfaces 1/1/1 flood-limit bcast rate mbps 60 low-threshold 40
-> interfaces 1/1/4 flood-limit uucast rate mbps 100 low-threshold 40
-> interfaces 1/1/5 flood-limit mcast rate pps 2000 low-threshold 1000

Release History
Release 8.1.1; command introduced.
Release 8.2.1; Parameter “low-threshold” added.

Related Commands

show interfaces flood-rate Displays interface flood rate settings.

MIB Objects
esmConfigTable
esmPortCfgFlow
esmPortBcastRateLimit
esmPortMcastRateLimit
esmPortUucastRateLimit
dot3PauseTable
dot3PauseAdminMode

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-13
interfaces flood-limit action Ethernet Port Commands

interfaces flood-limit action

Configures the action on a single port, a range of ports, when the port reaches the storm violated state.
interfaces {slot chassis/slot| port chassis/slot/port[-port2]} flood-limit {bcast|mcast|uucast|all} action
{shutdown|trap|default}

Syntax Definitions

chassis The chassis identifier.

slot Slot number you want to configure.
port Port number of the interface you want to configure.
port2 Last port number in a range of ports you want to configure.
bcast Specifies broadcast flood limit.
mcast Specifies multicast flood limit.
uucast Specifies unicast flood limit.
all Specifies flood limit for all types of traffic.
shutdown Specifies when high threshold is violated, port need to be put in blocked
state.
trap Specifies when high threshold is crossed, trap will be sent with the
violation reason.
default Specifies when traffic reaches high threshold, packets above that rate
will be dropped.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When high threshold is violated, and the port needs to be put in blocked state, set the action as
“shutdown”.
• When high threshold is crossed, and a trap has to be sent with violation reason, set the action as “trap”.

• When traffic reaches high threshold, and the packets above that rate needs to be dropped, set the action
as “default”.

Examples
-> interfaces 1/1/1 flood-limit bcast action shutdown
-> interfaces 1/1/4 flood uucast action trap
-> interfaces 1/1/11 flood-limit all action shutdown
-> interfaces 1/1/14 flood mcast action default

page 1-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands interfaces flood-limit action

Release History
Release 8.2.1; command introduced.

Related Commands

show interfaces flood-rate Displays interface flood rate settings.

MIB Objects
esmConfigTable
esmPortBcastThresholdAction
esmPortMcastThresholdAction
esmPortUucastThresholdAction

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-15
interfaces ingress-bandwidth Ethernet Port Commands

interfaces ingress-bandwidth
Configures the ingress bandwidth settings on a single port, a range of ports, or an entire Network Interface
(NI).
interfaces {slot chassis/slot| port chassis/slot/port[-port2]} ingress-bandwidth {mbps| enable | disable}

Syntax Definitions

chassis The chassis identifier.

slot Slot number you want to configure.
port Port number of the interface you want to configure.
port2 Last port number in a range of ports you want to configure.
mbps Specifies the ingress bandwidth in Mbps.
enable Enables ingress bandwidth limiting.
disable Disables ingress bandwidth limiting.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> interfaces slot 3/1 ingress-bandwidth enable
-> interfaces slot 3/2 ingress-bandwidth mbps 30

Release History
Release 8.1.1; command introduced.

Related Commands

show interfaces ingress-rate- Displays the ingress-rate-limit set for each interface por.
limit

MIB Objects
esmConfTable
esmPortIngressRateLimitEnable

page 1-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands interfaces pause

interfaces pause
Configures whether or not the switch will transmit and/or honor flow control PAUSE frames on the
specified interface. PAUSE frames are used to temporarily pause the flow of traffic between two
connected devices to help prevent packet loss when traffic congestion occurs between switches.
interfaces chassis/slot[/port[-port2]] pause {tx | rx | tx-and-rx | disable}

Syntax Definitions

chassis The chassis identifier.

slot Slot number you want to configure.
port Port number of the interface you want to configure.
port2 Last port number in a range of ports you want to configure.
tx Allows interface to transmit PAUSE frames to peer switches.
rx Allows interface to honor PAUSE frames from peer switches and
temporarily stop sending traffic to the peer.
tx-and-rx Allows the interface to transmit and honor PAUSE frames to/from peer
switches.
disable Disables flow control on the interface.

Platforms Supported
OmniSwitch 6860, 6860E

Defaults
By default, flow control is disabled on all switch interfaces.

Usage Guidelines
• Flow control is only supported on interfaces configured to run in full-duplex mode; half-duplex mode
is not supported. In addition, flow control is not supported across a virtual fabric link (VFL).
• If both autonegotiation and flow control are enabled on the same local interface, autonegotiation
calculates operational flow control settings for that interface. Note that the operational settings override
the configured settings as long as autonegotiation and flow control are both enabled for the interface.

• If autonegotiation is disabled, the configured flow control settings are applied to the local interface.

Examples
-> interfaces 4/1/2 pause rx
-> interfaces 1/1/11 pause tx
-> interfaces 2/1/1 pause tx-and-rx
-> interfaces 3/1/1-6 disable

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-17
interfaces pause Ethernet Port Commands

Related Commands

show interfaces status Displays interface line settings.

MIB Objects

esmConfTable
esmPortCfgPause

page 1-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands interfaces link-trap

interfaces link-trap
Enables trap link messages. If enabled, a trap is generated whenever the port changes state.
interfaces [slot chassis/slot | port chassis/slot/port [-port2]] link-trap {enable|disable}

Syntax Definitions

chassis The chassis identifier.

slot Slot number you want to configure.
port Port number of the interface you want to configure.
port2 Last port number in a range of ports you want to configure.
enable Port link up/down traps are displayed on the NMS.
disable Port link up/down traps are not displayed on the NMS.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> interfaces 3/1/1 link-trap enable
-> interfaces slot 3/1 link-trap enable
-> interfaces 3/1/1-6 link-trap enable

Release History
Release 8.1.1; command introduced.

Related Commands

show interfaces status Displays interface line settings.

MIB Objects
esmConfigTable
esmPortSlot
esmPortIF

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-19
interfaces ddm Ethernet Port Commands

interfaces ddm
Configures the DDM administrative status.
interfaces ddm {enable | disable}

Syntax Definitions

enable Enables DDM functionality.

disable Disables DDM functionality.

Defaults

parameter default
ddm disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• DDM capability will vary based on the transceiver manufacturer.

• DDM status must be enabled in order to enable traps; traps are enabled separately.

Examples
-> interfaces ddm enable
-> interfaces ddm disable

Release History
Release 8.1.1; command introduced.

Related Commands

show interfaces ddm Displays the interface DDM status.

MIB Objects
ddmConfiguration
ddmConfig

page 1-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands interfaces ddm-trap

interfaces ddm-trap
Configures the DDM administrative status or trap capability.
interfaces ddm-trap {enable | disable}

Syntax Definitions

enable Enables DDM trap functionality.

disable Disables DDM trap functionality.

Defaults

parameter default
ddm-trap disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
DDM status must be enabled in order to enable traps; traps are enabled separately.

Examples
-> interfaces ddm-trap enable
-> interfaces ddm-trap disable

Release History
Release 8.1.1; command introduced.

Related Commands

show interfaces ddm Displays the interface DDM status.

MIB Objects
ddmConfiguration
ddmTrapConfig
ddmNotificationType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-21
interfaces wait-to-restore Ethernet Port Commands

interfaces wait-to-restore
Configures the wait to restore timer on a specific slot, port, or a range of specified ports. The timer is
enabled when a link up event is detected. Other applications are notified of the link up event only after the
wait to restore timer has elapsed.
interfaces {slot chassis/slot| port chassis/slot/port[-port2]} wait-to-restore num

Syntax Definitions

chassis The chassis identifier.

slot The slot number for a specific module.
slot/port[-port2] The slot and port number. Use a hyphen to specify a range of ports.
num The number of seconds the switch waits before notifying other
applications. The valid range is 0-300 in multiples of 5 seconds.

Defaults
By default, the timer is set to zero (disabled).

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Set the wait-to-restore timer to zero to disable the timer.

• Enter a slot number to configure the timer value for all interfaces on a specific slot.

• Enter a slot and port number or a range of port numbers to configure the timer value for a specific
interface or a range of interfaces.

Example
-> interfaces slot 1/1 wait-to-restore 30
-> interfaces 1/1/1 wait-to-restore 10
-> interfaces 1/1/1-7 wait-to-restore 250

Release History
Release 8.1.1; command introduced.

page 1-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands interfaces wait-to-restore

Related Commands

violation recovery-maximum Displays the administrative, operational, violation, and recovery

status and configuration for the specified port.

MIB Objects
alaLinkMonConfigTable
alaLinkMonWaitToRestoreTimer

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-23
interfaces wait-to-shutdown Ethernet Port Commands

interfaces wait-to-shutdown
Configures the wait to shutdown timer on a specific slot, port, or a range of specified ports. The timer is
enabled when a link down event is detected. Other applications are notified of the link down event only
after the wait to shutdown timer has elapsed.
interfaces {slot chassis/slot| port chassis/slot/port[-port2]} wait-to-shutdown num

Syntax Definitions

chassis The chassis identifier.

slot The slot number for a specific module.
slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-3/10).
num The number of milliseconds the switch waits before notifying other
applications. The valid range is 0-300 in multiples of 10msec.

Defaults
By default, the timer is set to zero (disabled).

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command can be used to reduce port flapping. If the port comes back up before the timer expires
then the timer will be canceled and other applications will not be notified of the link down event.
• Set the wait-to-shutdown timer to zero to disable the timer.

• The WTS timer is not started when the switch is first booted. But administratively disabling the port
will start the timer if enabled.
• The link-status of the remote port will be down when the WTS timer is running. This is due to the port
being physically down and only the link-down event not being communicated to other applications.

Example
-> interfaces slot 1/1 wait-to-shutdown 30
-> interfaces 1/1/1 wait-to-shutdown 10
-> interfaces 1/1/1-7 wait-to-shutdown 250

Release History
Release 8.1.1; command introduced.

page 1-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands interfaces wait-to-shutdown

Related Commands

violation recovery-maximum Displays the administrative, operational, violation, and recovery

status and configuration for the specified port.

MIB Objects
alaLinkMonConfigTable
alaLinkMonWaittoShutdownTimer

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-25
interfaces eee Ethernet Port Commands

interfaces eee
Enables or disabled Energy Efficient Ethernet.
interfaces {slot chassis/slot| port chassis/slot/port[-port2]} eee {enable | disable}

Syntax Definitions

chassis The chassis identifier.

slot The slot number for a specific module.
slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-3/10).
enable Enables EEE functionality.
disable Disables EEE functionality.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• EEE is only supported on 10GBase-T ports.

• Enabling EEE will start advertising EEE capability to peer ports. Disabling EEE will stop advertising
EEE capability to peer ports.

Examples
-> interfaces 1/1/1 eee enable
-> interfaces slot 2/1 eee disable

Release History
Release 8.1.1; command was introduced.

Related Commands

violation recovery-maximum Displays the administrative, operational, violation, and recovery

status and configuration for the specified port.

MIB Objects
N/A

page 1-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands clear violation

clear violation
Clears all the MAC address violation logs for a particular port and session. After the violations are
cleared, the specific port resumes normal operation. This includes applying an existing application
configuration.
clear violation {port chassis/slot/port[-port2] | linkagg agg_id[-agg_id2]}

Syntax Definitions

chassis The chassis identifier.

slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-8).
agg_id[-agg_id2] Enter a link aggregate ID number. Use a hyphen to specify a range of
link aggregate IDs.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When a violation is set on a physical port that is part of a link aggregate, the violation is set for the
whole link aggregate. All ports on that link aggregate are brought down. When this command is
applied to a link aggregate ID, all member ports of the link aggregate are activated.
• When this command is applied, all MAC addresses known to the port are cleared from the MAC
address table for the switch.

Examples
-> clear violation port 1/1/10
-> clear violation port 2/1/1-5
-> clear violation linkagg 5
-> clear violation linkagg 10-20

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-27
clear violation Ethernet Port Commands

Related Commands

show violation Displays the address violations that occur on ports with LPS
restrictions.

MIB Objects
portViolationTable
portViolationClearPort

page 1-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands violation recovery-maximum

violation recovery-maximum
Configures the maximum number of recovery attempts allowed before the port is permanently shut down.
This value is configurable on a global basis (applies to all ports on all modules) and on a per-slot or per-
port basis.
violation [chassis/slot/port[-port2]] recovery-maximum {infinite | default | max_attempts}

Syntax Definitions

chassis The chassis identifier.

slot The slot number for a specific module.
slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-8).
infinite Sets the recovery attempt to infinite auto recovery.
default Sets the number of recovery attempts to the global value for the
specified ports. This parameter is only available when a slot, port, or
range of ports is specified with this command.
max_attempts The maximum number of recovery attempts. Valid range is 0-50.

Defaults
By default, this command configures the global maximum number of recovery attempts. The global value
applies to all ports on all modules in the switch.

parameter default
max_attempts 10

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Set the maximum number of recovery attempts value to 0 to disable this recovery mechanism.

• Enter a slot number to configure the number of recovery attempts for all interfaces on a specific slot.

• Enter a slot and port number or a range of ports to configure the number of recovery attempts for a
specific interface or a range of interfaces.
• When this command is used to configure the number of recovery attempts for all ports on a slot or for a
specific port or range of ports, the value specified overrides the global maximum number of attempts
configured for the switch.
• When configuring the number of recovery attempts for a specific slot, port, or range of ports, use the
default parameter to reset this value to the global maximum number of attempts.
• The number of recovery attempts increments whenever a port recovers using automatic recovery timer
mechanism. When the number of recovery attempts exceeds the configured threshold, the port is
permanently shut down.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-29
violation recovery-maximum Ethernet Port Commands

• Once an interface is permanently shut down, only the clear violation command can be used to recover
the interface.
• The recovery mechanism tracks the number of recoveries within a fixed time window (FTW). The
FTW = 2 * maximum recovery number * recovery timer. For example, if the maximum number of
recovery attempts is set to 4 and the recovery timer is set to 5, the FTW is 40 seconds (2 * 4 * 5=40).

Examples
-> violation recovery-maximum 25
-> violation 1/2 recovery-maximum 10
-> violation 1/2/3 recovery-maximum 20
-> violation 1/2/4-9 recovery-maximum 50
-> violation 1/2/4-9 recovery-maximum default
-> violation 1/2/3 recovery-maximum 0
-> violation recovery-maximum infinite
-> violation recovery-maximum 0

Release History
Release 8.2.1; command was introduced.

Related Commands

violation recovery-time Configures the time interval after which the port is
automatically re-activated if the port was shut down for any
violation.
show interfaces Displays the administrative, operational, violation, and
recovery status and configuration for the specified port.
show violation-recovery-configuration Displays the globally configured recovery time, SNMP
recovery trap status, and maximum recovery attempts.

MIB Objects
alaPortViolationRecoveryTable
alaPortViolationRecoveryMaximum

page 1-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands violation recovery-time

violation recovery-time
Configures the time interval after which the port is automatically re-activated if the port was shutdown for
any violation. This value is configurable on a global basis (applies to all ports on all modules) and on a
per-slot or per-port basis.
violation recovery-time seconds
violation {chassis/slot/port[-port2]} recovery-time {seconds | default}

Syntax Definitions

chassis The chassis identifier.

slot The slot number for a specific module.
slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-8).
seconds The number of seconds after which a port is reactivated. The valid range
is 30-600 seconds. Specify 0 to disable the recovery timer.
default Sets the recovery time to the global value for the specified ports. This
parameter is only available when a slot, port, or range of ports is
specified with this command.

Defaults
• By default, this command configures the global recovery time. The global value applies to all ports on
all modules in the switch.
• By default, the violation recovery time is set to 300 seconds.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When the recovery timer expires, the interface is operationally re-enabled and the violation on the
interface is cleared.
• The violation recovery time value does not apply to interfaces that are in a permanent shutdown state.
A port in this state is only recoverable using the clear violation command.
• The interface violation recovery mechanism is not supported on link aggregates, but is supported on
the link aggregate member ports.
• Set the recovery time to 0 to disable the violation recovery mechanism.

• Enter a slot number to configure the recovery time for all interfaces on a specific slot.

• Enter a slot and port number or a range of ports to configure the recovery time for a specific interface
or a range of interfaces.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-31
violation recovery-time Ethernet Port Commands

• When this command is used to configure the recovery time for all ports on a slot or for a specific port
or range of ports, the value specified overrides the global maximum recovery time configured for the
switch.
• When configuring the time for a specific slot, port, or range of ports, use the default parameter to reset
this value to the global maximum number of attempts.

Examples
-> violation recovery-time 600
-> violation 1/2 recovery-time 100
-> violation 1/2/3 recovery-time 200
-> violation 1/2/4-9 recovery-time 500
-> violation 1/2/4-9 recovery-maximum default
-> violation 1/2/3 recovery-time 0
-> violation recovery-time 0

Release History
Release 8.2.1; command introduced.

Related Commands

violation recovery-maximum Configures the maximum number of recovery attempts

before a port is permanently shut down.
show interfaces Displays the administrative, operational, violation, and
recovery status and configuration for the specified port.
show violation-recovery-configuration Displays the globally configured recovery time, SNMP
recovery trap enable/disable status and maximum recov-
ery attempts.

MIB Objects
alaPortViolationRecoveryTable
alaPortViolationRecoveryTime

page 1-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands violation recovery-trap

violation recovery-trap
Enables or disables the sending of a violation recovery trap when any port is re-enabled after the violation
recovery time has expired.
violation recovery-trap {enable | disable}

Syntax Definitions

enable Enables the ports to send violation recovery traps.

disable Disables the ports from sending violation recovery traps.

Defaults
By default, sending of a violation recovery trap is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This is a global command that is applied to all ports on all modules.

Examples
-> violation recovery-trap enable
-> violation recovery-trap disable

Release History
Release 8.2.1; command was introduced.

Related Commands

violation recovery-time Configures the time interval to automatically re-enable the ports
that were shutdown due to a violation.
show violation-recovery- Displays the globally configured recovery time, SNMP recovery
configuration trap status, and maximum recovery attempts.

MIB Objects
esmViolationRecovery
esmViolationRecoveryTrap

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-33
show interfaces Ethernet Port Commands

show interfaces
Displays general interface information (for example, hardware, MAC address, input errors, and output
errors).
show interfaces [slot chassis/slot | port chassis/slot/port[-port2]]

Syntax Definitions

chassis The chassis identifier.

slot Slot number you want to display.
port Port number of the interface you want to display.
port2 Last port number in a range of ports you want to display.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
EEE will be appended to the Autonegotiation output when EEE is enabled.

Examples
-> show interfaces 1/1/2
Chassis/Slot/Port 1/1/2 :
Operational Status : up,
Last Time Link Changed : FRI DEC 27 15:10:40 ,
Number of Status Change: 1,
Type : Ethernet,
SFP/XFP : GBIC_SX,
EPP : Disabled,, Link-Quality:Good
MAC address : 00:d0:95:b2:39:85,
BandWidth (Megabits) : 1000, Duplex : Full,
Autonegotiation : 1 [ 1000-F 100-F 100-H 10-F 10-H ],
Long Accept : Enable, Runt Accept : Disable,
Long Frame Size(Bytes) : 9216, Runt Size(Bytes) : 64,
Rx :
Bytes Received : 7967624, Unicast Frames : 0,
Broadcast Frames: 124186, M-cast Frames : 290,
UnderSize Frames: 0, OverSize Frames: 0,
Lost Frames : 0, Error Frames : 0,
CRC Error Frames: 0, Alignments Err : 0,
Tx :
Bytes Xmitted : 255804426, Unicast Frames : 24992,
Broadcast Frames: 3178399, M-cast Frames : 465789,
UnderSize Frames: 0, OverSize Frames: 0,
Lost Frames : 0, Collided Frames: 0,

page 1-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show interfaces

output definitions
Slot/Port Interface slot and port.
Operational Status Interface status:
up - port is operationally up.
down - port is operationally down
dormant - SFP/SFP+ transceiver is inserted into a port configured for
FibreChannel or vice versa.
Last Time Link Changed The last time the configuration for this interface was changed.
Number of Status Change The total number of times that the configuration of this interface has
changed.
Type Interface type (Ethernet/Fast Ethernet/Gigabit Ethernet).
SFP/XFP The type of transceiver detected.
EPP Enhanced Port Performance setting.
Link-Quality The link quality of the connection:
GOOD - The port will connect with no problems and transfer data with
no errors.
FAIR - The port may have intermittent problems connecting and
maintaining its connection to a remote port and/or intermittent CRC's
could occur.
POOR - The port will have problems connecting and maintaining a
connection with remote port. If the ports connect, it’s likely CRC errors
will occur.
N/A - The port link quality is either very poor or the port type does not
support the Link Quality capability.
MAC address Interface MAC address.
WWPN OmniSwitch 64-bit World Wide Port Name (WWPN) for each Fibre
Channel port.
Bandwidth Bandwidth (in megabits).
Duplex Duplex mode (Half/Full/Auto).
Autonegotiation The auto negotiation settings for this interface.
Long Accept Long Frames status (enable/disable).
Runt Accept Runt Frames status (enable/disable).
Long Frame Size Long Frame Size (in Bytes).
Runt Size Runt Frame Size (in Bytes).
Bytes Received Number of Bytes received.
Rx Unicast Frames Number of unicast frames received.
Rx Broadcast Frames Number of broadcast frames received.
Rx M-cast Frames Number of multicast frames received.
Rx Undersize Frames Number of undersized frames received.
Rx Oversize Frames Number of oversized frames received.
Rx Lost Frames Number of Lost Frames received.
Rx Error Frames Number of error frames received.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-35
show interfaces Ethernet Port Commands

output definitions (continued)

Rx CRC Error Frames Number of CRC error frames received. Only applies to frames that are
less than or equal to Max/Long Frame Size. Frames larger than Long
Frame Size are counted as OverSizeFrames.
Rx Alignments Err Number of Alignments Error frames received.
Bytes Xmitted Number of Bytes transmitted.
Tx Unicast Frames Number of unicast frames transmitted.
Tx Broadcast Frames Number of broadcast frames transmitted.
Tx M-cast Frames Number of multicast frames r transmitted.
Tx Undersize Frames Number of undersized frames transmitted.
Tx Oversize Frames Number of oversized frames transmitted.
Tx Lost Frames Number of Lost Frames transmitted.
Tx Collided Frames Number of collision frames received or transmitted.
Tx Error Frames Number of error frames transmitted.

Release History
Release 8.1.1; command introduced.

Related Commands

show interfaces accounting Displays interface accounting information (e.g., packets received/
transmitted).
show interfaces counters Displays interface counter information (e.g., unicast packets
received/transmitted).
show interfaces alias Displays the interface line settings (e.g., speed and mode).
show interfaces traffic Displays interface traffic statistics (input/output bytes and packets).

page 1-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show interfaces

MIB Objects
ifTable
ifOperStatus
ifType
ifPhysAddress
ifSpeed
ifInDiscards
IfOutDiscards
esmConfTable
esmPortSlot
esmPortIF
esmPortCfgLongEnable
esmPortCfgRuntEnable
esmPortCfgMaxFrameSize
esmPortCfgRuntSize
ifXTable
ifHCInOctets
ifHCInUcastPkts
ifHCInBroadcastPkts
ifHCInMulticastPkts
IfHCOutOctets
IfHCOutUcastPkts
IfHCOutBroadcastPkts
IfHCOutMulticastPkts
alcetherStatsTable
alcetherStatsRxUndersizePkts
alcetherStatsCRCAlignErrors
alcetherStatsTxUndersizePkts
alcetherStatsTxOversizePkts
alcetherStatsTxCollisions
dot3StatsTable
dot3StatsFrameTooLong
dot3StatsFCSErrors
dot3StatsLateCollisions

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-37
show interfaces alias Ethernet Port Commands

show interfaces alias

Displays interface line settings (e.g., speed and mode).
show interfaces [slot chassis/slot | port chassis/slot/port[-port2]] alias

Syntax Definitions

chassis The chassis identifier.

slot Slot number you want to display.
port Port number of the interface you want to display.
port2 Last port number in a range of ports you want to display.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If no slot/port numbers are entered, line settings for all slots/ports on the switch are displayed.

Examples
-> show interfaces 1/1/2 alias
Legends:WTS - Wait to shutdown
# - WTS Timer is Running & port is in wait-to-shutdown state
Slot/ Admin Link WTR WTS Alias
Port Status Status (sec) (msec)
-----+----------+---------+-----+----+----------------------------------
1/1/2 disable down 5 #10 ""

output definitions
Slot/Port Interface slot/port number.
Admin Status The administrative status of the port.
Link Status The link status of the port.Autonegotiation status (Enable/Disable).
WTS (msec) The wait-to-shutdown configuration time.
WTR (sec) The wait-to-restore configuration time.
Alias The configured alias for the port..

Release History
Release 8.1.1; command introduced.

page 1-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show interfaces alias

Related Commands

interfaces alias Configures the port alias.

MIB Objects
ifXTable
ifAlias

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-39
show interfaces status Ethernet Port Commands

show interfaces status

Displays interface line settings (for example, speed and mode).
show interfaces [slot chassis/slot | port chassis/slot/port[-port2]] status

Syntax Definitions

chassis The chassis identifier.

slot Slot number you want to display.
port Port number of the interface you want to display.
port2 Last port number in a range of ports you want to display.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If no slot/port numbers are entered, line settings for all slots/ports on the switch are displayed.

Examples
-> show interfaces status
Chas/ DETECTED-VALUES CONFIGURED-VALUES
Slot/ Admin Auto Speed Duplex Pause Speed Duplex Pause Link
Port Status Nego (Mbps) (Mbps) Trap
------+------+----+--------+------+-------+--------+------+-------+-----
1/1/1 en dis - - - 10000 Full - dis
1/1/2 en dis - - - 10000 Full - dis
1/1/3 en dis - - - 10000 Full - dis
1/1/4 en dis - - - 10 Full - dis
1/1/5 en dis - - - 10000 Full - dis
1/1/6 en dis - - - 10000 Full - dis
1/1/7 en dis - - - 10000 Full - dis
1/1/8 en dis - - - 10000 Full - dis
1/1/9 en dis - - - 10000 Full - dis
1/1/10 en dis - - - 10000 Full - dis
1/1/11 en dis - - - 10000 Full Rx-N-Tx dis
1/1/12 en dis - - - 10000 Full - dis

-> show interfaces 1/1/2 status

Chas/ DETECTED-VALUES CONFIGURED-VALUES

Slot/ Admin Auto Speed Duplex Pause Speed Duplex Pause Link
Port Status Nego (Mbps) (Mbps) Trap
------+------+----+--------+------+-------+--------+------+-------+-----
1/2 en dis - - - 10000 Full - dis

page 1-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show interfaces status

-> show interfaces 1/11 status

DETECTED-VALUES CONFIGURED-VALUES
Slot/ Admin Auto Speed Duplex Pause Speed Duplex Pause Link
Port Status Nego (Mbps) (Mbps) Trap
------+------+----+--------+------+-------+--------+------+-------+-----
1/1/11 en dis - - - 10000 Full Rx-N-Tx dis

output definitions
Slot/Port Interface slot/port number.
Admin Status The administrative status of the port. Configured through the
interfaces command.
AutoNego Autonegotiation status (Enable/Disable). Configured through the
interfaces command.
Detected Speed Detected line speed in Mbps.
Detected Duplex Detected line duplex (Half duplex/Full duplex/Auto).
Detected Pause Detected pause control configuration.
Configured Speed Configured line speed (10/100/Auto/1000/10000 Mbps). Configured
through the interfaces speed command.
Configured Duplex Configured line duplex (Half duplex/Full duplex/Auto). Configured
through the interfaces duplex command.
Configured Pause Detected pause control configuration. Configured through the
interfaces pause command.
Link Trap Link Trap status. Configured through the interfaces link-trap
command.

Release History
Release 8.1.1; command introduced.

Related Commands

interfaces Configures interface line speed, sets speed, and duplex mode to
auto-sensing.
interfaces duplex Configures interface duplex mode.

MIB Objects
esmConfTable
esmPortSlot
esmPortIF
esmPortAutoSpeed
esmPortAutoDuplexMode
esmPortCfgAutoNegotiation
esmPortCfgSpeed
esmPortCfgDuplexMode
esmPortCfgPause
esmPortLinkUpDownTrapEnable

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-41
show interfaces capability Ethernet Port Commands

show interfaces capability

Displays default auto negotiation, speed, duplex, flow, and cross-over settings for a single port, a range of
ports, or all ports on a Network Interface (NI) module.
show interfaces [slot | slot//port[-port2]] capability

Syntax Definitions

slot Slot number you want to display.

port Port number of the interface you want to display.
port2 Last port number in a range of ports you want to display.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Displays defaults settings in two rows of data for each port. The first row of data, identified by the label
CAP, displays the valid user-defined configuration settings available for the port. The second row,
identified by the label DEF, displays the default settings for the port.

Examples
-> show interfaces 5/1/1 capability
Ch/Slot/Port AutoNeg Pause Crossover Speed Duplex
-----------+---------+--------+-----------+----------+----------
5/1/1 CAP EN/DIS EN/DIS MDI/X/Auto 10/100/1G Full/Half
5/1/1 DEF EN EN Auto Auto Auto

output definitions
Slot The slot number.
Port The port number
AutoNeg In the row labeled CAP, the field displays the valid auto negotiation
configurations for the port. In the row label DEF, the field displays the
default auto negotiation settings for the port. The possible values are
EN (enabled) or DIS (disabled).
Pause In the row labeled CAP, the field displays the valid pause
configurations for the port. In the row label DEF, the field displays the
default pause settings for the port.

page 1-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show interfaces capability

output definitions (continued)

Crossover In the row labeled CAP, the field displays the valid cross over
configurations for the port. In the row labeled DEF, the field displays
the default cross over settings for the port. The possible values are
Auto, MDI/X/Auto (MDI/MDIX/Auto), or -- (not configurable and/or
not applicable).
Speed In the row labeled CAP, the field displays the valid line speed
configurations for the port. In the row label DEF, the field displays the
default line speed settings for the port. The possible values are 10/100,
100, 1G, 10/100/1G, 10G, or Auto.
Duplex In the row labeled CAP, the field displays the valid duplex
configurations for the port. In the row label DEF, the field displays the
default duplex settings for the port. The possible values are Full, Full/
Half, or Auto.

Release History
Release 8.1.1; command introduced.

Related Commands

interfaces Enables and disables auto negotiation.

interfaces speed Configures interface speed.
interfaces duplex Configures duplex settings.
show interfaces alias Displays interface line settings.

MIB Objects
esmConfTable
esmPortCfgAutoNegotiation
esmPortCfgFlow
esmPortCfgCrossover
esmPortCfgSpeed
esmPortAutoDuplexMode

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-43
show interfaces accounting Ethernet Port Commands

show interfaces accounting

Displays interface accounting information (e.g., packets received/transmitted and deferred frames
received).
show interfaces [slot chassis/slot | port chassis/slot/port[-port2]] accounting

Syntax Definitions

chassis The chassis identifier.

slot Slot number you want to display.
port Port number of the interface you want to display.
port2 Last port number in a range of ports you want to display.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If no slot/port numbers are entered, accounting information for all slots/ports on the switch is displayed.

Examples
-> show interfaces 1/1/2 accounting
1/1/2 ,
Rx undersize packets = 0,
Tx undersize packets = 0,
Rx oversize packets = 0,
Tx oversize packets = 0,
Rx packets 64 Octets = 3073753,
Rx packets 65To127 Octets = 678698,
Rx packets 128To255 Octets = 21616,
Rx packets 256To511 Octets = 21062,
Rx packets 512To1023 Octets = 2,
Rx packets 1024To1518 Octets = 84,
Rx packets 1519to4095 Octets = 0,
Rx packets 4096ToMax Octets = 0,
Rx Jabber frames = 0

output definitions
Rx undersize packets Number of undersized packets received.
Tx undersize packets Number of undersized packets transmitted.
Rx oversize packets Number of oversized packets received.
Tx oversize packets Number of oversized packets transmitted.

page 1-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show interfaces accounting

output definitions (continued)

Rx packets Octets Number of packets received in each listed octet range.
Rx Jabber frames Number of jabber packets received (longer than 1518 octets).
Tx deferred frames Number of packets for which transmission was delayed (Ethernet
only).

Release History
Release 8.1.1; command introduced.

Related Commands

violation recovery-maximum Displays general interface information (e.g., hardware, MAC

address, and input/output errors).
show interfaces counters Displays interface counter information (e.g., unicast packets
received/transmitted).

MIB Objects
esmConfTable
esmPortSlot
esmPortIF
dot3StatsTable
dot3StatsFrameTooLong
dot3StatsDeferredTransmissions
alcetherStatsTable
alcetherStatRxsUndersizePkts
alcetherStatTxsUndersizePkts
alcetherStatsTxOversizePkts
alcetherStatsPkts64Octets
alcetherStatsPkts65to127Octets
alcetherStatsPkts128to255Octets
alcetherStatsPkts256to511Octets
alcetherStatsPkts512to1023Octets
alcetherStatsPkts1024to1518Octets
gigaEtherStatsPkts1519to4095Octets
gigaEtherStatsPkts4096to9215Octets
alcetherStatsRxJabber

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-45
show interfaces counters Ethernet Port Commands

show interfaces counters

Displays interface counters information (e.g., unicast, broadcast, and multi-cast packets received/
transmitted).
show interfaces [slot chassis/slot | port chassis/slot/port[-port2]] counters

Syntax Definitions

chassis The chassis identifier.

slot Slot number you want to display.
port Port number of the interface you want to display.
port2 Last port number in a range of ports you want to display.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If no slot/port numbers are entered, counter information for all slots/ports on the switch is displayed.

Examples
-> show interfaces 3/1/1 counters

InOctets = 54367578586897979, OutOctets = 5.78E19,

InUcastPkts = 55654265276, OutUcastPkts = 5.78E20,
InMcastPkts = 58767867868768777, OutMcastPkts = 5465758756856,
InBcastPkts = 576567567567567576, OutBcastPkts = 786876,
InPauseFrames = 567798768768767, OutPauseFrames= 786876,

output definitions
InOctets Number of octets received.
OutOctets Number of octets transmitted.
InUcastPkts Number of unicast packets received.
OutUcastPkts Number of unicast packets transmitted.
InMcastPkts Number of multicast packets received.
OutMcastPkts Number of unicast packets transmitted.
InBcastPkts Number of broadcast packets received.
OutBcastPkts Number of unicast packets transmitted.
InPauseFrames Number of MAC control frames received.
OutPauseFrames Number of MAC control frames transmitted.

page 1-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show interfaces counters

Release History
Release 8.1.1; command introduced.

Related Commands

show interfaces counters errors Displays interface error frame information (e.g., CRC errors, transit
errors, and receive errors).

MIB Objects
esmConfTable
esmPortSlot
esmPortIF
ifXTable
IfHCInOctets
IfHCOutOctets
IfHCInUcastPkts
IfHCOutUcastPkts
IfHCInMulticastPkts
IfHCOutMulticastPkts
IfHCInBroadcastPkts
IfHCOutBroadcastPkts
dot3PauseTable
dot3InPauseFrame
dot3OutPauseFrame

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-47
show interfaces counters errors Ethernet Port Commands

show interfaces counters errors

Displays interface error frame information (e.g., CRC errors, transit errors, and receive errors).
show interfaces [slot chassis/slot | port chassis/slot/port[-port2]] counters errors

Syntax Definitions

chassis The chassis identifier.

slot Slot number you want to display.
port Port number of the interface you want to display.
port2 Last port number in a range of ports you want to display.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If no slot/port numbers are entered, counter error information for all slots/ports on the switch is displayed.

Examples
-> show interfaces 2/1/1 counters errors

02/01,
Alignments Errors = 6.45E13, FCS Errors = 7.65E12
IfInErrors = 6435346, IfOutErrors= 5543,
Undersize pkts = 867568, Oversize pkts = 5.98E8

output definitions
Slot/Port Interface slot and port number.
Alignments Errors Number of Alignments errors.
FCS Errors Number of Frame Check Sequence errors.
IfInErrors Number of received error frames.
IfOutErrors Number of transmitted error frames.
Undersize pkts Number of undersized packets.
Oversize pkts Number of oversized packets (more than 1518 octets).

Release History
Release 8.1.1; command introduced.

page 1-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show interfaces counters errors

Related Commands

show interfaces counters Displays interface counters information (e.g., unicast, broadcast,
and multi-cast packets received/transmitted).

MIB Objects
esmConfTable
esmPortSlot
esmPortIF
ifTable
ifInErrors
ifOutErrors
alcetherStatsTable
alcetherStatsRxUndersizePkts
dot3StatsTable
dot3StatsAlignmentErrors
dot3StatsFCSErrors
dot3StatsFrameTooLong

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-49
show interfaces flood-rate Ethernet Port Commands

show interfaces flood-rate

Displays interface peak flood rate settings.
show interfaces [slot chassis/slot | port chassis/slot/port[-port2]] flood-rate [bcast | mcast | uucast]

Syntax Definitions

chassis The chassis identifier.

slot Slot number you want to display.
port Port number of the interface you want to display.
port2 Last port number in a range of ports you want to display.
bcast Specifies broadcast flood limit.
mcast Specifies multicast flood limit.
uucast Specifies unicast flood limit.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show interfaces flood-rate
Chas/
Slot/ Bcast Bcast Bcast Ucast Ucast Ucast Mcast Mcast Mcast
Port Value Type Status Value Type Status Value Type Status
-----+----------+-----+-------+----------+-----+-------+----------+-----+--------
1/1/1 496 mbps enable 496 mbps enable 496 mbps disable
1/1/2 496 mbps enable 496 mbps enable 496 mbps disable
1/1/3 496 mbps enable 496 mbps enable 496 mbps disable
1/1/4 496 mbps enable 496 mbps enable 496 mbps disable
1/1/5 496 mbps enable 496 mbps enable 496 mbps disable

-> show interface flood-rate bcast

Chas/ Bcast Bcast

Slot/ High Low Bcast Bcast Bcast Bcast
Port Value Value Type Status State Action
--------+----------+-----+-------+----------+--------+---------
1/1/1 60 20 mbps enable Normal Trap
1/1/2 50 20 mbps enable Storm Shutdown
1/1/3 496 0 mbps enable Normal Default

page 1-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show interfaces flood-rate

output definitions
Slot/Port Interface slot and port numbers.
Value The value set based on the type of flood limiting.
Type The type of flood limiting: mbps, pps, or %
Status Status of the type of flood-limiting: enabled or disabled.

Release History
Release 8.1.1; command introduced.
Release 8.2.1; Parameters “bcast, mcast, uucast” were added.

Related Commands

interfaces flood-limit Configures the peak flood rate for an interface.

MIB Objects
esmConfTable
esmPortSlot
esmPortIF
esmPortMaxFloodRate
esmPortFloodMcastEnable
esmPortBcastRateLimit
esmPortMcastRateLimit
esmPortUucastRateLimit

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-51
show interfaces traffic Ethernet Port Commands

show interfaces traffic

Displays interface traffic statistics.
show interfaces [slot chassis/slot | port chassis/slot/port[-port2]] traffic

Syntax Definitions

chassis The chassis identifier.

slot Slot number you want to display.
port Port number of the interface you want to display.
port2 Last port number in a range of ports you want to display.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If no port numbers are entered, traffic settings for all ports on the switch are displayed.

Examples
-> show interfaces traffic
Ch/Slot/Port Input packets Input bytes Output packets Output bytes
---------+-----------------+-----------------+-----------------+---------------
1/1/2 322 20624 5125 347216
3/1/2 322 20620 5133 347764

output definitions
Slot/Port Interface slot and port numbers.
Input packets Input packets detected.
Input bytes Input bytes detected.
Output packets Output packets detected.
Output bytes Output bytes detected.

Release History
Release 8.1.1; command introduced.

page 1-52 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show interfaces traffic

Related Commands

violation recovery-maximum Displays general interface information (e.g., hardware, MAC

address, and input/output errors).
show interfaces counters Displays interface counter information (e.g., unicast packets
received/transmitted).

MIB Objects
esmConfTable
esmPortSlot
esmPortIF
ifXTable
ifHCInOctets
ifHCInUcastPkts
ifHCInMulticastPkts
ifHCInBroadcastPkts
ifHCOutOctets
ifHCOutUcastPkts
ifHCOutMulticastPkts
ifHCOutBroadcastPkts

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-53
show interfaces ingress-rate-limit Ethernet Port Commands

show interfaces ingress-rate-limit

Displays the ingress-rate-limit set for each interface port.
show interfaces [slot chassis/slot| port chassis/slot/port[-port1]] ingress-rate-limit

Syntax Definitions

chassis The chassis identifier.

slot Slot number you want to display.
port Port number of the interface you want to display.
port1 Last port number in a range of ports you want to display.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If the slot number is not specified, then the switch back pressure feature must be enabled or disabled on an
entire chassis.

Examples
-> show interfaces 1/1/1-4 ingress-rate-limit
Ch/Slot/ Rate Limit Burst Size Status
Port (Mbps) (MB)
------+----------+----------+-------
1/1/1 496 19 disable
1/1/2 496 19 disable
1/1/3 496 19 disable
1/1/4 496 19 disable

output definitions
Slot/Port Interface slot and port numbers.
Rate Limit (Mbps) Rate limit in Megabits.
Burst Size (MB) Burst size in Megabytes.
Status Status of rate limiting.

Release History
Release 8.1.1; command introduced.

page 1-54 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show interfaces ingress-rate-limit

Related Commands

interfaces flood-limit Configures the ingress-rate-limit.

MIB Objects
esmConfTable
esmPortSlot
esmPortIF

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-55
show interfaces ddm Ethernet Port Commands

show interfaces ddm

Displays the information for the specified transceivers.
show interfaces [slot chassis/slot| port chassis/slot/port[-port1]] ddm [w-low w-high status a-low a-high
actual]

Syntax Definitions

chassis The chassis identifier.

slot Display all the transceivers on the specified slot.
num Display information for the specified transceiver.
port2 Last port number in a range of ports to display.
w-low Display the transceivers Warning Low value.
w-high Display the transceivers Warning High value.
status Display the administrative status of DDM.
a-low Display the transceivers Alarm Low value.
a-high Display the transceivers Alarm High value.
actual The real-time values indicated by the transceiver. Values displayed in
parentheses indicate the Warning or Alarm value that has been reached.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If the threshold values of the transceiver are ‘0’ then NS (Not Supported) will be displayed in the DDM
output display.

Examples
-> show interfaces transceiver W-Low

Ch/Slot/Port Temp C Voltage(V) Current(mA) Output(dBm) Input(dBm)

---------+------+----------+-----------+----------+---------+
1/1/1 48 5.15 50 2.50 2.50
1/1/2 47 5.35 49 2.43 2.43
1/1/3 NA NA NA NA NA

-> show interfaces transceiver A-High

Ch/Slot/Port Temp C Voltage(V) Current(mA) Output(dBm) Input(dBm)

---------+------+----------+-----------+----------+---------+
1/1/1 50 5.75 75 3.22 3.22
1/1/2 50 5.95 65 3.22 3.22

page 1-56 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show interfaces ddm

1/1/3 NA NA NA NA NA

-> show interfaces 1/1/1 transceiver

Threshold Temp C Voltage(V) Current(mA) Output(dBm) Input(dBm)

------------+------+----------+-----------+----------+---------+
Actual 50 1.95(WL) 75 4.92(AH) 3.22
Alarm High 120 5.75 100 4.91 4.91
Warning High 90 3.00 90 4.77 4.77
Warning Low 10 2.00 60 0.00 0.00
Alarm Low -5 1.75 20 -3.01 -10

-> show interfaces transceiver ddm

DDM Status : enable
DDM Trap Status : disable

output definitions
Slot/Port Interface slot and port numbers.
Temp C The transceiver temperature, in degrees centigrade.
Voltage (V) The transceiver supply voltage, in volts.
Current (mA) The transceiver transmit bias current, in milliamps.
Output (dBm) The transceiver output power, in decibels.
Input (dBm) The transceiver received optical power, in decibels.
DDM Status The administrative status of DDM.
DDM Trap Status The administrative status of DDM traps.
Actual The real-time values indicated by the transceiver. Values displayed
in parentheses indicate the Warning or Alarm value that has
been reached.
Alarm High (AH) Indicates the value at which the transceiver’s functionality may be
affected.
Warning High (WH) Indicates the transceiver is approaching the High Alarm value.
Warning Low (WL) Indicates the transceiver is approaching the Low Alarm value.
Alarm Low (AL) Indicates the value at which the transceiver’s functionality may be
affected.
N/A Indicates the transceiver does support DDM.
N/S Indicates the transceiver does not support the DDM attribute.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-57
show interfaces ddm Ethernet Port Commands

Related Commands

show interfaces ddm Configures the DDM administrative status or trap capability.

MIB Objects
ddmPortInfoTable
ddmPortChannel
ddmPortTemperature
ddmPortTempLowWarning
ddmPortTempLowAlarm
ddmPortTempHiWarning
ddmPortTempHiAlarm
ddmPortSupplyVoltage,
ddmPortSupplyVoltageLowWarning
ddmPortSupplyVoltageLowAlarm
ddmPortSupplyVoltageHiWarning
ddmPortSupplyVoltageHiAlarm
ddmPortTxBiasCurrent
dmPortTxBiasCurrentLowWarning
ddmPortTxBiasCurrentLowAlarm
ddmPortTxBiasCurrentHiWarning
ddmPortTxBiasCurrentHiAlarm
ddmPortTxOutputPower
ddmPortTxOutputPowerLowWarning
ddmPortTxOutputPowerLowAlarm
ddmPortTxOutputPowerHiWarning
ddmPortTxOutputPowerHiAlarm
ddmPortRxOpticalPower
ddmPortRxOpticalPowerLowWarning
ddmPortRxOpticalPowerLowAlarm
ddmPortRxOpticalPowerHiWarning
ddmPortRxOpticalPowerHiAlarm

page 1-58 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show transceivers

show transceivers
Displays transceiver manufactuer and status information.
show transceivers [slot chassis/lot] [chassis-id chassis]

Syntax Definitions

chassis The chassis identifier.

slot Display all the transceivers on the specified slot.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show transceivers
Slot 2 Transceiver 1
Manufacturer Name: FIBERXON INC. ,
Part Number: FTM-8012C-SLG ,
Hardware Revision: 10 ,
Serial Number: 101680092800319 ,
Manufacture Date: 090707,
Laser Wave Length: 850nm,
Admin Status: POWER ON,
Operational Status: UP

output definitions
Manufacturer Name The name of the transceiver’s manufacturer.
Part Number The part number of the transceiver.
Hardware Revision The hardware revision of the transceiver.
Serial Number The serial number of the transceiver.
Manufacturer Date The manufacture date of the transceiver.
Laser Wave Length The laser wavelength of the transceiver.
Admin Status The administrative status of the transceiver.
Operational Status The operational status of the transceiver.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-59
show transceivers Ethernet Port Commands

Release History
Release 8.1.1; command introduced.

Related Commands

show interfaces ddm Displays the DDM administrative status or trap capability.

MIB Objects
N/A

page 1-60 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show violation

show violation
Displays the address violations that occur on ports with LPS restrictions. This command displays a port
violation for sticky port security when the maximum number of MAC address of the connected
workstation that the switch learns.
show violation {port chassis/slot/port[-port2] | linkagg agg_id[-agg_id2]}

Syntax Definitions

chassis The chassis identifier.

slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-8).
agg_id[-agg_id2] Enter a link aggregate ID number. Use a hyphen to specify a range of
link aggregate IDs.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
NA

Examples
-> show violation

LAG ID/ Recovery Recovery

Port Source Action Reason WTR Time Max/Remain
-------+------+---------------+-------------+----+-------------+-----------------
1/1/2 QOS simulated down lps shutdown 0 300 5/2
1/1/3 LPS 10 100 8/0
1/1/4 QOS 0 300 infinite
1/1/5 QOS 0 300 disabled

output definitions\
LAG ID/Port The chassis, slot and port numbers or link aggregate IDs on which
address violations occurred.
Source Specifies the source application that detected the violation.
Action Specifies the action that is taken when the violation is detected on the
port. There are two types of actions:
admin down - deactivates the physical port.
simulated down - the port is put in blocking state.
Reason Specifies the reason for the violation.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-61
show violation Ethernet Port Commands

output definitions\
WTR Wait to restore time.
Recovery Time Specifies the duration taken for recovery.
Recovery Max/Remain Specifies the maximum number of retry configured and the number of
retry remaining.

Release History
Release 8.1.1; command introduced.

Related Commands

clear violation Clears all the MAC address violation logs for a particular port and
session. After the violations are cleared, the specific port resumes
normal operation.

MIB Objects
portViolationTable
portViolationSource
portViolationEntry
portViolationTrap
portViolationSource
portViolationReason
portViolationAction
portViolationTimer
portViolationCfgRecoveryMax
portViolationRetryRemain
portViolationTimerAction

page 1-62 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show violation-recovery-configuration

show violation-recovery-configuration
Displays the global violation recovery configuration details (recovery trap, recovery maximum, and
recovery time.
show violation-recovery-configuration {port chassis/slot/port[-port2] | slot chassis/slot]}

Syntax Definitions

chassis The chassis identifier.

slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-8).
chassis/slot The chassis and slot number.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
NA

Examples
-> show violation-recovery-configuration

Global Recovery Trap : enable

Global Recovery Maximum : 20
Global Recovery Time : 200

Port Recovery Max Recovery Time

------+---------------+----------------
1/1/1 10 300
1/1/2 10 300

-> show violation-recovery-configuration 3/1/1-2

Global Recovery Trap : enable

Global Recovery Maximum : 20
Global Recovery Time : 200

Port Recovery Max Recovery Time

------+----------------+---------------
3/1/1 10 300
3/1/2 10 300

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-63
show violation-recovery-configuration Ethernet Port Commands

output definitions\
Global Recovery Trap Displays the global status of the violation trap recovery.
Global Recovery Maximum Displays the global value set for the maximum violation recovery.
Global Recovery Time Displays the global value set for the recovery time.
Port Displays the chassis, slot and port numbers or link aggregate IDs on
which address violations occurred.
Recovery Max Displays the maximum number of retry configured.
Recovery Time Displays the duration taken for recovery.

Release History
Release 8.2.1; command introduced.

Related Commands

clear violation Clears all the MAC address violation logs for a particular port and
session. After the violations are cleared, the specific port resumes
normal operation.

MIB Objects
portViolationTable
alaPvrGlobalTrapEnable
alaPvrGlobalRetryTime
alaPvrGlobalRecoveryMax
alaPvrRetryTime
alaPvrRecoveryMax

page 1-64 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands interfaces link-monitoring admin-status

interfaces link-monitoring admin-status

Enables or disables link monitoring on a specific slot, port, or a range of specified ports.
interfaces {slot chassis/slot| port chassis/slot/port[-port2]} link-monitoring admin-status {enable |
disable}

Syntax Definitions

chassis The chassis identifier.

slot The slot number for a specific module.
slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-3/10).
enable Enables link monitoring for the specified port.
disable Disables link monitoring for the specified port.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Configuring link monitoring parameters are allowed even if the link monitoring status is disabled for
the specified ports.
• The Automatic Recovery Timer and link monitoring must not be enabled on Remote Fault Propagation
(RFP) enabled ports.
• Enter a slot number to configure link monitoring for all interfaces on a specific slot.

• Enter a slot and port number or a range of port numbers to configure link monitoring for a specific
interface or range of interfaces.
• Link Monitoring can be enabled on individual ports that make up a virtual port such as a link aggregate
or VFL, but not on the entire link aggregate or VFL virtual port.

Example
-> interfaces slot 1/1 link-monitoring admin-status enable
-> interfaces 1/1/1 link-monitoring admin-status enable
-> interfaces 1/1/1-7 link-monitoring admin-status enable
-> interfaces 2/1/5 link-monitoring admin-status disable
-> interfaces 2/1/5-20 link-monitoring admin-status disable

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-65
interfaces link-monitoring admin-status Ethernet Port Commands

Release History
Release 8.1.1; command introduced.

Related Commands

violation recovery-maximum Displays the administrative, operational, violation, and recovery

status and configuration for the specified port.
show interfaces link-monitoring Displays the link monitoring configuration for the specified ports.
config
show interfaces link-monitoring Displays the link monitoring statistics for the specified ports.
statistics

MIB Objects
alaLinkMonConfigTable
alaLinkMonStatus

page 1-66 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands interfaces link-monitoring time-window

interfaces link-monitoring time-window

Configures the monitoring time window on a specific slot, port, or a range of specified ports. This is the
length of time during which the link is monitored.
interfaces {slot chassis/slot| port chassis/slot/port[-port2]} link-monitoring time-window seconds

Syntax Definitions

chassis The chassis identifier.

slot The slot number for a specific module.
slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-3/10).
seconds The length of time during which the link is monitored. The valid range
is 0–3600 seconds.

Defaults
By default, the time window value is set to 300 seconds.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enter a slot number to configure the monitoring time window for all interfaces on a specific slot.

• Enter a slot and port number or a range of port numbers to configure the monitoring time window for a
specific interface or a range of interfaces.

Example
-> interfaces slot 1/1 link-monitoring time-window 20
-> interfaces 1/1/1 link-monitoring time-window 40
-> interfaces 1/1/1-7 link-monitoring time-window 2500

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-67
interfaces link-monitoring time-window Ethernet Port Commands

Related Commands

violation recovery-maximum Displays the administrative, operational, violation, and recovery

status and configuration for the specified port.
show interfaces link-monitoring Displays the link monitoring configuration for the specified ports.
config
show interfaces link-monitoring Displays the link monitoring statistics for the specified ports.
statistics

MIB Objects
alaLinkMonConfigTable
alaLinkMonTimeWindow

page 1-68 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands interfaces link-monitoring link-flap-threshold

interfaces link-monitoring link-flap-threshold

Configures the number of link flaps allowed on a specific slot, port, or a range of specified ports in the
time interval, before the port is shutdown.
interfaces {slot chassis/slot| port chassis/slot/port[-port2]} link-monitoring link-flap-threshold
link_flaps

Syntax Definitions

chassis The chassis identifier.

slot The slot number for a specific module.
slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-3/10).
link_flaps The number of link flaps. The valid range is 2-10.

Defaults
By default, the number of link flaps allowed is set to 5.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enter a slot number to configure the number of link flaps allowed for all interfaces on a specific slot.

• Enter a slot and port number or a range of port numbers to configure the number of link flaps allowed
for a specific interface or a range of interfaces.

Example
-> interfaces slot 1/1 link-monitoring link-flap-threshold 6
-> interfaces 1/1/1 link-monitoring link-flap-threshold 3
-> interfaces 1/1/1-7 link-monitoring link-flap-threshold 10

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-69
interfaces link-monitoring link-flap-threshold Ethernet Port Commands

Related Commands

violation recovery-maximum Displays the administrative, operational, violation, and recovery

status and configuration for the specified port.
show interfaces link-monitoring Displays the link monitoring configuration for the specified ports.
config
show interfaces link-monitoring Displays the link monitoring statistics for the specified ports.
statistics

MIB Objects
alaLinkMonConfigTable
alaLinkMonLinkFlapThreshold

page 1-70 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands interfaces link-monitoring link-error-threshold

interfaces link-monitoring link-error-threshold

Configures the number of MAC errors allowed on a specific slot, port, or a range of specified ports in the
time interval, before the port is shutdown. MAC errors refer to lost frames, error frames, alignment frames
and cyclic redundancy check (CRC).
interfaces {slot chassis/slot| port chassis/slot/port[-port2]} link-monitoring link-error-threshold
mac_errors

Syntax Definitions

chassis The chassis identifier.

slot The slot number for a specific module.
slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-3/10).
mac_errors The number of MAC errors. The valid range is 1-100.

Defaults
By default, the number of MAC errors allowed is set to 5.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enter a slot number to configure the number of MAC errors allowed on all interfaces on a specific slot.

• Enter a slot and port number or a range of port numbers to configure the number of MAC errors
allowed on a specific interface or on a range of interfaces.

Example
-> interfaces slot 1/1 link-monitoring link-error-threshold 30
-> interfaces 1/1/1 link-monitoring link-error-threshold 10
-> interfaces 1/1/1-7 link-monitoring link-error-threshold 35

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-71
interfaces link-monitoring link-error-threshold Ethernet Port Commands

Related Commands

violation recovery-maximum Displays the administrative, operational, violation, and recovery

status and configuration for the specified port.
show interfaces link-monitoring Displays the link monitoring configuration for the specified ports.
config
show interfaces link-monitoring Displays the link monitoring statistics for the specified ports.
statistics

MIB Objects
alaLinkMonConfigTable
alaLinkMonLinkErrorThreshold

page 1-72 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands interfaces clear-link-monitoring-stats

interfaces clear-link-monitoring-stats
Clears the link monitoring statistics on a specific slot, port, or a range of specified ports.
interfaces {slot chassis/slot| port chassis/slot/port[-port2]} clear-link-monitoring-stats

Syntax Definitions

chassis The chassis identifier.

slot The slot number for a specific module.
slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-3/10).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enter a slot number to clear monitoring statistics for all interfaces on a specific slot.

• Enter a slot and port number or a range of port numbers to clear monitoring statistics for a specific
interface or a range of interfaces.

Example
-> interfaces slot 1/1 clear-link-monitoring-stats
-> interfaces 1/1/1 clear-link-monitoring-stats
-> interfaces 1/1/1-7 clear-link-monitoring-stats

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-73
interfaces clear-link-monitoring-stats Ethernet Port Commands

Related Commands

violation recovery-maximum Displays the administrative, operational, violation, and recovery

status and configuration for the specified port.
show interfaces link-monitoring Displays the link monitoring configuration for the specified ports.
config
show interfaces link-monitoring Displays the link monitoring statistics for the specified ports.
statistics

MIB Objects
alaLinkMonStatsTable
alaLinkMonStatsClearStats

page 1-74 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show interfaces link-monitoring config

show interfaces link-monitoring config

Displays configuration information for the Link Monitoring feature. This includes the link monitoring
status on a specific slot, port or a range of specified ports, time window, link flap threshold, and link error
threshold.
show interfaces {slot chassis/slot| port chassis/slot/port[-port2]} link-monitoring config

Syntax Definitions

chassis The chassis identifier.

slot The slot number for a specific module.
slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-3/10).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enter a slot number to display information for all interfaces on a specific port.

• Enter a slot and port number or a range of port numbers to display information for a specific interface
or a range of interfaces.

Example
-> show interfaces 1 link-monitoring config

Ch/Slot/ Status Time Link-flap Link-error

Port Window Threshold Threshold
(sec)
------+--------+--------+------------+-----------
1/1/1 enabled 10 5 10
1/1/2 disabled 10 5 10
1/1/3 disabled 200 8 20
.
.
1/1/24 disabled 150 2 99

-> show interfaces 1/1/1-3 link-monitoring config

Slot/ Status Time Link-flap Link-error

Port Window Threshold Threshold
(sec)
------+--------+--------+------------+-------------
1/1/1 enabled 10 5 10
1/1/2 disabled 10 5 10

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-75
show interfaces link-monitoring config Ethernet Port Commands

1/1/3 disabled 200 7 99

-> show interfaces 1/1/1 link-monitoring config

Ch/Slot/ StatusTime Link-flap Link-error

Port Window Threshold Threshold
(sec)
------+--------+--------+------------+-------------
1/1/1 enabled 10 5 10

-> show interfaces 1/1/2 link-monitoring config

Ch/Slot/ StatusTime Link-flap Link-error

Port Window Threshold Threshold
(sec)
------+--------+--------+------------+------------
1/1/2 disabled 10 5 10

output definitions
Slot/Port Interface slot and port number.
Status Link monitoring status (enable/disable).
Time Window Time interval, in seconds, for which the link is monitored.
Link-flap threshold Number of link flaps allowed on a specific slot, port, or a range of
specified ports in the time interval before the port is shutdown.
Link-error threshold Number of MAC errors allowed on a specific slot, port, or a range of
specified ports in the time interval before the port is shutdown.

Release History
Release 8.1.1; command introduced.

Related Commands

violation recovery-maximum Displays information of the interface port status.

show interfaces link-monitoring Displays the Link Monitoring statistics.
statistics
show violation-recovery- Enables or disables link monitoring.
configuration
interfaces link-monitoring Configures the monitoring of the time-window of the link.
time-window
interfaces link-monitoring link- Configures the number of link flaps that are allowed before the port
flap-threshold is shutdown.
interfaces link-monitoring link- Configures the number of MAC errors that are allowed before the
error-threshold port is shutdown.

page 1-76 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show interfaces link-monitoring config

MIB Objects
alaLinkMonConfigTable
alaLinkMonStatus
alaLinkMonTimeWindow
alaLinkMonLinkFlapThreshold
alaLinkMonLinkErrorThreshold

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-77
show interfaces link-monitoring statistics Ethernet Port Commands

show interfaces link-monitoring statistics

Displays the Link Monitoring statistics for a specific slot, port, or a range of specified ports.
show interfaces {slot chassis/slot| port chassis/slot/port[-port2]} link-monitoring statistics

Syntax Definitions

chassis The chassis identifier.

slot The slot number for a specific module.
slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-3/10).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enter a slot number to display information for all interfaces on a specific port.

• Enter a slot and port number or a range of port numbers to display information for a specific interface
or a range of interfaces.

Example
-> show interfaces slot 1/1 link-monitoring statistics
Ch/Slot/ State Current Current Current Current Current Total Total
Port Flap Error CRC Lost Align Flap Error
------+---------+--------+--------+--------+--------+--------+-------+-------+
1/1/1 shutdown 6 3 2 0 0 15 6
1/1/2 down 3 2 1 0 0 12 3
.
.
1/1/24 up 3 2 1 0 0 12 3

-> show interfaces 1/1/1-2 link-monitoring statistics

Slot/ State Current Current Current Current Current Total Total
Port Flap Error CRC Lost Align Flap Error
------+---------+--------+--------+--------+--------+--------+-------+-------+
1/1/1 shutdown 6 3 2 0 0 15 6
1/1/2 down 3 2 1 0 0 12 3

-> show interfaces 1/1/1 link-monitoring statistics

Slot/ State Current Current Current Current Current Total Total
Port Flap Error CRC Lost Align Flap Error
------+---------+--------+--------+--------+--------+--------+-------+-------+
1/1/1 shutdown 6 3 2 0 0 15 6

page 1-78 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show interfaces link-monitoring statistics

Release History
Release 8.1.1; command introduced.

Related Commands

violation recovery-maximum Displays the administrative, operational, violation, and recovery

status and configuration for the specified port.
show interfaces link-monitoring Displays configuration information of the Link Monitoring.
config
show violation-recovery- Enables or disables link monitoring.
configuration
interfaces clear-link- Clears the Link Monitoring statistics.
monitoring-stats
interfaces link-monitoring link- Configures the number of MAC errors that are allowed before the
error-threshold port is shutdown.

MIB Objects
alaLinkMonStatsTable
alaLinkMonStatsPortStatus
alaLinkMonStatsCurrentLinkFlaps
alaLinkMonStatsCurrentErrorFrames
alaLinkMonStatsCurrentCRCErrors
alaLinkMonStatsCurrentLostFrames
alaLinkMonStatsCurrentAlignErrors
alaLinkMonStatsCurrentLinkErrors
alaLinkMonStatsTotalLinkFlaps
alaLinkMonStatsTotalLinkErrors

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-79
link-fault-propagation group Ethernet Port Commands

link-fault-propagation group
Configures a Link Fault Propagation (LFP) group to associate with source and destination ports.
link-fault-propagation group group_id [admin-status {enable | disable}]
no link-fault-propagation group {group_id[-group_id2]}

Syntax Definitions

group_id A group ID number. The valid range is 1–8.

group_id[-group_id2] A group ID number to remove. Use a hyphen to specify a range of
existing group ID numbers (5-8). Specifying a range is only used to
remove group IDs, not to create them.
enable Enables LFP for the specified group.
disable Disables LFP for the specified group.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a LFP group or a range of groups.

• Up to eight LFP groups per switch are allowed.

• Once a LFP group is created, assign source and destination ports to that group.

Example
-> link-fault-propagation group 1
-> no link-fault-propagation group 4
-> no link-fault-propagation group 4-7

Release History
Release 8.1.1; command introduced.

page 1-80 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands link-fault-propagation group

Related Commands

link-fault-propagation group Configures the source port assignments for the LFP group.
source
link-fault-propagation group Configures the destination port assignments for the LFP group.
destination
link-fault-propagation group Configures the amount of time LFP waits before shutting down the
wait-to-shutdown destination ports.
show link-fault-propagation Displays the LFP group configuration for the switch.
group

MIB Objects
alaLFPGroupTable
alaLFPGroupId
alaLFPGroupRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-81
link-fault-propagation group source Ethernet Port Commands

link-fault-propagation group source

Configures the source port assignments for a Link Fault Propagation (LFP) group.
link-fault-propagation group group_id source {port chassis/slot/port[-port2] | linkagg
agg_id[-agg_id2]}
no link-fault-propagation group group_id source {port chassis/slot/port[-port2] | linkagg
agg_id[-agg_id2]}

Syntax Definitions

group_id An existing LFP group ID number. The valid range is 1–8.

chassis The chassis identifier.
slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
and/or a space to specify multiple port entries (3/1-10 4/1 4/5 5/10).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
and/or a space to specify multiple ID entries (1-5 10 12).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a source port association with the specified LFP group.

• Make sure the LFP group specified with this command already exists in the switch configuration.

• Configuring the source ports and destinations ports for the specified LFP group is allowed within the
same command (see the examples on this command page).
• A port/linkagg added as a source/destination port for a particular group cannot be added as a
destination/source port for this group or for any other group.
• If a port is recovered due to the Interface Recovery Timer, then the port will revert to the shutdown
state if the error persists.

Example
-> link-fault-propagation group 1 source port 1/1/2
-> link-fault-propagation group 1 source port 1/1/2-5 2/1/3
-> link-fault-propagation group 1 source linkagg 1
-> link-fault-propagation group 1 source linkagg 1-3
-> link-fault-propagation group 1 source port 2/1/3 destination port 1/1/6
-> link-fault-propagation group 1 source port 3/1/1-5 destination linkagg 6
-> no link-fault-propagation group 1 destination port 1/1/10

page 1-82 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands link-fault-propagation group source

Release History
Release 8.1.1; command introduced.

Related Commands

link-fault-propagation group Configures an LFP group, including the administrative status.

link-fault-propagation group Configures the destination port assignments for the LFP group.
destination
link-fault-propagation group Configures the amount of time LFP waits before shutting down the
wait-to-shutdown destination ports.
show link-fault-propagation Displays the LFP group configuration for the switch.
group

MIB Objects
alaLFPGroupTable
alaLFPGroupId
alaLFPConfigTable
alaLFPConfigPort
alaLFPConfigPortType
alaLFPConfigRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-83
link-fault-propagation group destination Ethernet Port Commands

link-fault-propagation group destination

Configures the destination port assignments for a Link Fault Propagation (LFP) group.
link-fault-propagation group group_id destination {port chassis/slot/port[-port2] | linkagg
agg_id[-agg_id2]}
no link-fault-propagation group group_id destination {port chassis/slot/port[-port2] | linkagg
agg_id[-agg_id2]}

Syntax Definitions

group_id An existing LFP group ID number. The valid range is 1–8.

chassis The chassis identifier.
slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
and/or a space to specify multiple port entries (3/1-10 4/1 4/5 5/10).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
and/or a space to specify multiple ID entries (1-5 10 12).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a destination port association with the specified LFP
group.
• Make sure the LFP group specified with this command already exists in the switch configuration.

• Configuring the source ports and destinations ports for the specified LFP group is allowed within the
same command (see the examples on this command page).
• A port or link aggregate that is configured as a source port cannot be configured as a destination port
for any group. However, a source port can be associated with multiple LFP groups.
• A port or link aggregate that is configured as a destination port cannot be configured as a source port
for any group. However, a destination port can be associated with multiple LFP groups.
• If port is recovered due to the Interface Recovery Timer, then the port will revert to the shutdown state
if the error persists.

page 1-84 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands link-fault-propagation group destination

Example
-> link-fault-propagation group 1 destination port 1/1/4
-> link-fault-propagation group 1 destination port 1/1/5-8 2/1/3
-> link-fault-propagation group 1 destination linkagg 6
-> link-fault-propagation group 1 destination linkagg 6-10
-> link-fault-propagation group 1 source port 1/1/2 2/1/3 destination port 1/1/6
-> link-fault-propagation group 1 source port 1/1/2 2/1/3 destination linkagg 6
-> link-fault-propagation group 1 source linkagg 3 destination port 1/1/6 1/1/9
-> link-fault-propagation group 1 source linkagg 3 destination linkagg 1

-> no link-fault-propagation group 1 source port 1/1/9

-> no link-fault-propagation group 1 destination port 1/1/10

Release History
Release 8.1.1; command introduced.

Related Commands

link-fault-propagation group Configures an LFP group, including the administrative status.

link-fault-propagation group Configures the source port assignments for the LFP group.
source
link-fault-propagation group Configures the amount of time LFP waits before shutting down the
wait-to-shutdown destination ports.
show link-fault-propagation Displays the LFP group configuration for the switch.
group

MIB Objects
alaLFPGroupTable
alaLFPGroupId
alaLFPConfigTable
alaLFPConfigPort
alaLFPConfigPortType
alaLFPConfigRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-85
link-fault-propagation group wait-to-shutdown Ethernet Port Commands

link-fault-propagation group wait-to-shutdown

Configures the wait-to-shutdown timer value for the Link Fault Propagation (LFP) group. This is the
amount of time after all the source ports go down that LFP waits before shutting down the destination
ports.
link-fault-propagation group group_id wait-to-shutdown seconds

Syntax Definitions

group_id An existing LFP group ID number. The valid range is 1–8.

seconds The number of seconds LFP waits before shutting down the destination
ports. The valid range is 0-300 in multiples of 5.

Defaults
By default, the timer is set to zero (disabled).

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Set the wait-to-shutdown timer value to 0 to disable the timer.

• Make sure the LFP group specified with this command already exists in the switch configuration.

Example
-> link-fault-propagation group 1 wait-to-shutdown 40
-> link-fault-propagation group 3 wait-to-shutdown 70
-> link-fault-propagation group 5 wait-to-shutdown 0

Release History
Release 8.1.1; command introduced.

Related Commands

link-fault-propagation group Configures an LFP group, including the administrative status.

show link-fault-propagation Displays the LFP group configuration for the switch.
group

MIB Objects
alaLFPGroupTable
alaLFPGroupId
alaLFPGroupWaitToShutdown
alaLFPGroupRowStatus

page 1-86 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show link-fault-propagation group

show link-fault-propagation group

Displays information for the specified Link Fault Propagation (LFP) group.
show link-fault-propagation group [group_id]

Syntax Definitions

group_id An existing LFP group ID number. The valid range is 1–8.

Defaults
By default, information is displayed for all existing LFP groups.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enter a LFP group ID number with this command to display information for a specific group.

• If a virtual port such as a link aggregate is configured as a source or destination port it will be
displayed instead of the physical ports.

Example
-> show link-fault-propagation group
Group Id : 2
Source Port(s) : 0/1-2 1/1/1-5 1/1/7,
Destination Port(s) : 0/3 1/1/10-13,
Group-Src-Ports Status : up,
Admin Status : enable,
Wait To Shutdown : 10

Group Id : 7
Source Port(s) : 1/1/1 1/1/3,
Destination Port(s) : 0/3 1/1/5 1/1/7 1/1/11,
Group-Src-Ports Status : up,
Admin Status : enable,
Wait To Shutdown : 100

-> show link-fault-propagation group 2

Group Id : 2
Source Port(s) : 0/1-2 1/1/1-5 1/1/7,
Destination Port(s) : 0/3 1/1/10-13,
Group-Src-Ports Status : up,
Admin Status : enable,
Wait To Shutdown : 10

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-87
show link-fault-propagation group Ethernet Port Commands

Related Commands

link-fault-propagation group Configures a LFP group, including the administrative status.

link-fault-propagation group Configures the amount of time LFP waits before shutting down the
wait-to-shutdown destination ports.

MIB Objects
alaLFPConfigTable
alaLFPConfigPort
alaLFPConfigPortType
alaLFPGroupTable
alaLFPGroupId
alaLFPGroupAdminStatus
alaLFPGroupOperStatus
alaLFPGroupWaitToShutdown

page 1-88 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands interfaces tdr

interfaces tdr
Initiates a Time Domain Reflectometry (TDR) cable diagnostics test on the specified port. The TDR
feature sends a signal down a cable to determine the distance to a break or other discontinuity in the cable
path. The length of time it takes for the signal to reach the break and return is used to estimate the distance
to the discontinuity.
interfaces chassis/slot/port tdr enable

Syntax Definitions

chassis The chassis identifier.

slot/port The slot and port number.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• TDR is an on-demand, out-of-service test. The test is not automatically triggered; data and protocol
traffic is interrupted.
• Only one TDR test can be run at any given time.

• TDR is not supported on link aggregate ports, fiber ports, or stacking ports.

• TDR results are automatically cleared when a new test is started on the port or when the module for the
port is reset.

Examples
-> interfaces 1/1/1 tdr enable

Release History
Release 8.1.1; command was introduced.

Related Commands

clear interfaces Clears the statistics of the last test performed on the port
show interfaces tdr-statistics Displays the results of the last TDR test performed on a port.

MIB Objects
esmTdrPortTable
esmTdrPortTest

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-89
show interfaces tdr-statistics Ethernet Port Commands

show interfaces tdr-statistics

Displays the results of the last TDR test performed on a port.
show interfaces [slot chassis/slot | chassis/slot/port[-port2]] tdr-statistics

Syntax Definitions

chassis The chassis identifier.

slot/port The slot and port number.
slot/port[-port2] The slot and port number. Use a hyphen to specify a range of ports.

Defaults
By default, TDR statistics are shown for all ports on all modules

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enter a slot number to display information for all interfaces on a specific slot.

• Enter a slot and port number or a range of port numbers to display information for a specific interface
or range of interfaces.

Examples
-> show interfaces 1/1/3 tdr-statistics
Legend: Pair 1 - orange and white
Pair 2 - green and white
Pair 3 - blue and white
Pair 4 - brown and white

Ch/Slot/ No of Cable Fuzzy Pair1 Pair1 Pair2 Pair2 Pair3 Pair3 Pair4 Pair4 Test
port pairs State Length State Length State Length State Length State Length Result
-----+-----+------+-----+-----+-----+------+------+-----+------+-----+------+------
1/1/3 4 ok 0 ok 3 ok 3 ok 3 ok 3 success

output definitions
Legend Eight-conductor data cable contains 4 pairs of twisted Pair Copper Cable wires.
Each pair consists of a solid (or predominantly) colored wire and a white wire
with a strip of the same color. The pairs are twisted together.
Slot/Port The interface slot and port number.
No of pairs The number of pairs in the cable for which the test results are valid.

page 1-90 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Port Commands show interfaces tdr-statistics

output definitions (continued)

Cable State State of a cable as returned by the TDR test. The state of the cable wire.
(a) OK - Wire is working properly
(b) Open - Wire is broken
(c) Short - Pairs of wire are in contact with each other
(d) Crosstalk - Signal transmitted on one pair of wire creates an undesired
effect in another wire.
(e) Unknown - Cable diagnostic test unable to find the state of a cable.
Fuzzy Length The error in the estimated length of the cable.
Pair1 State The state of the Pair 1 cable wire (OK, Open, Short, Crosstalk, or Unknown)
Pair1 Length The length of the Pair 1 cable at which the fault is detected, if the pair is faulty.
Else, specifies the complete length of the cable.
Pair2 State The state of the Pair 2 cable wire (OK, Open, Short, Crosstalk, or Unknown)
Pair2 Length The length of the Pair 2 cable at which the fault is detected, if the pair is faulty.
Else, specifies the complete length of the cable.
Pair3 State The state of the Pair 3 cable wire (OK, Open, Short, Crosstalk, or Unknown)
Pair3 Length The length of the Pair 3 cable at which the fault is detected, if the pair is faulty.
Else, specifies the complete length of the cable.
Pair4 State The state of the Pair 4 cable wire (OK, Open, Short, Crosstalk, or Unknown)
Pair4 Length The length of the Pair 4 cable at which the fault is detected, if the pair is faulty.
Else, specifies the complete length of the cable.
Test Result The status of the TDR test performed, success or fail.

Release History
Release 8.1.1 command was introduced.

Related Commands

interfaces tdr Initiates the cable diagnostics on a port.

clear interfaces Clears the statistics of the last test performed on the port.

MIB Objects
esmTdrPortTable
esmTdrPortCableState
esmTdrPortValidPairs
esmTdrPortPair1State
esmTdrPortPair1Length
esmTdrPortPair2State
esmTdrPortPair2Length
esmTdrPortPair3State
esmTdrPortPair3Length
esmTdrPortPair4State
esmTdrPortPair4Length
esmTdrPortFuzzLength

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 1-91
show interfaces tdr-statistics Ethernet Port Commands

page 1-92 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 2 Power over Ethernet (PoE)
Commands

The Power over Ethernet (PoE) feature is supported on OmniSwitch PoE-capable switches. Refer to the
OmniSwitch Hardware Users Guide for further details.

Note. Note on Terminology. There are several general terms used to describe this feature. The terms
Power over Ethernet (PoE), Power over LAN (PoL), Power on LAN (PoL), and Inline Power are
synonymous terms used to describe the powering of attached devices via Ethernet ports. For
consistency, this chapter and the OmniSwitch AOS Release 8 CLI Reference Guide refer to the feature
as Power over Ethernet (PoE).
Note. Additional terms, such as Powered Device (PD) and Power Source Equipment (PSE) are terms
that are not synonymous, but are directly related to PoE.
• PD refers to any attached device that uses a PoE data cable as its only source of power. Exam-
ples include access points such as IP telephones, Ethernet hubs, wireless LAN stations, etc.
• PSE refers to the actual hardware source of the electrical current for PoE (e.g., OmniSwitch PoE-
capable switches.

PoE commands documented in this section comply with IEEE 802.3, 802.af, and 802.3at.
MIB information for the PoE commands is as follows:
Filename: AlcatelIND1InLinePowerEthernet_mib
Module: ALCATEL-IND1-INLINE-POWER-MIB
Filename: AaIETF_HUBMIB_POWER_ETHERNET_DRAFT_mib
Module: POWER-ETHERNET-MIB

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 2-1
 Power over Ethernet (PoE) Commands

A summary of the available commands is listed here:

lanpower slot service

lanpower port admin-state
lanpower type
lanpower power
lanpower slot maxpower
lanpower priority
lanpower slot priority-disconnect
lanpower power-rule
lanpower power-policy
lanpower slot class-detection
lanpower capacitor-detection
lanpower slot usage-threshold
lanpower slot update-from
lanpower slot update-from
show lanpower power-rule
show lanpower power-policy
show lanpower slot class-detection
show lanpower slot capacitor-detection
show lanpower slot priority-disconnect
show lanpower slot usage-threshold
show lanpower slot update-from

page 2-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Power over Ethernet (PoE) Commands lanpower slot service

lanpower slot service

Activates or stops PoE service on all ports in a specified slot.
lanpower slot chassis/slot service {start | stop}

Syntax Definitions

chassis/slot The slot on which the PoE power is being turned on or off.
start Activates PoE on all ports in the specified slot.
stop Turns off PoE on all ports in the specified slot.

Defaults
Power over Ethernet is globally disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> lanpower slot 2/1 service start
-> lanpower slot 1/1 service stop

Release History
Release 8.1.1; command was introduced.

Related Commands

lanpower port admin-state Activates or stops PoE service on an individual port.

lanpower slot update-from Displays the PoE status and related statistics for all ports in a
specified slot.

MIB Objects
alaPethMainPseTable
alaPethMainPseAdminStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 2-3
lanpower port admin-state Power over Ethernet (PoE) Commands

lanpower port admin-state

Activates or stops PoE service on an individual port.
lanpower port chassis/slot/port admin-state {enable | disable}

Syntax Definitions

chassis/slot/port The individual port on which the PoE power is being turned on or off.
enable Activates PoE on the specified port.
stop Turns off PoE on the specified port.

Defaults
Power over Ethernet is globally disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> lanpower port 2/1/1 admin-state enable
-> lanpower port 1/1/12 admin-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

lanpower slot service Activates or stops PoE service on all ports in a specified slot.
lanpower slot update-from Displays the PoE status and related statistics for all ports in a
specified slot.

MIB Objects
pethPsePortTable
pethPsePortAdminEnable

page 2-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Power over Ethernet (PoE) Commands lanpower type

lanpower type
Assigns a user-defined port type to a specific port (when chassis/slot/port values are entered) or across all
ports in a slot (if only slot/port values are entered).
lanpower {slot chassis/slot | port chassis/slot/port} type string

Syntax Definitions

chassis/slot The slot on which the port type is being defined.

chassis/slot/port The specific port on which the port type is being defined.
string A user-defined text string of up to nine (9) characters. This text string
will be listed in the “Type” column in the lanpower slot update-from
command output.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Be sure to use the syntax, “slot” or “port”, before the chassis/slot or chassis/slot/port values in the
command line. Refer to the examples below for more information.

Examples
-> lanpower slot 1/1 type test
-> lanpower port 1/1/23 type PDs

Release History
Release 8.1.1; command was introduced.

Related Commands

lanpower slot update-from Displays the PoE status and related statistics for all ports in a
specified slot.

MIB Objects
pethPsePortTable
pethPsePortType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 2-5
lanpower power Power over Ethernet (PoE) Commands

lanpower power
Specifies the amount of power, in milliwatts, provided for a specific port (when chassis/slot/port values
are provided)
entered) ororacross
acrossallallports
portsinina aslot
slot(if(ifonly
onlyslot/port
slot/portvalues
valuesare
areentered).
specified).
lanpower {slot chassis/slot | port chassis/slot/port} power milliwatts

Syntax Definitions
chassis/slot
chassis/slot The slot
The slot on
on which
which the
the maximum
port type is being defined.
chassis/slot/port The specific
A PoE port
port on on which
which the port type
the maximum is being
amount defined.
of inline power is being
milliwatts configured.
The maximum amount of power for a specified port or slot. Refer to
milliwatts default and range
The maximum information
amount below.
of power for the specified port or slot. Ranges he
maximum limit for the port power setting is 30000 milliwatts on
Defaults OS6860 and 60000 milliwatts on OS6860E.

model
Defaults ports default range
OS6860 all 30000 3000-30000
model ports default range
OS6860E (Enhanced) 1 through 4 60000 3000-60000
OS6860 (not Enhanced) 1 through 4 15400 3000-18000
OS6860E (Enhanced) 5 and higher 30000 3000-30000
OS6860 (not Enhanced) 5 and higher 15400 3000-18000
OS6860 (not Supported
Platforms Enhanced) 1 through 4 15400 3000-20000

OmniSwitch 6860, 6860E

milliwatts (OS6850E/OS9000E) 5 and higher 30000 3000-30000

Usage Guidelines
• Using this command does not immediately allocate the power to the slot or port. Any unused power is
still available and remains a part of the overall PoE budget.
Defaults
• To globally specify the amount of inline power available to all ports in a slot, refer to the lanpower
slot maxpower command on page 2-8.
port number default
• Be sure to use the syntax, “slot” or “port”, before the chassis/slot or chassis/slot/port values in the
Ports 1 through
command 4 Refer to the examples
line. 60000below for more information.
Ports 5 and higher 30000
• Be sure that the value specified complies with specific power requirements for all attached PDs.

• Note that the power value for the lanpower power command is specified in milliwatts (mW); the
Platforms Supported
related command, lanpower slot maxpower, is specified in watts (W).
OmniSwitch 6860, 6860E

Usage Guidelines
• Using this command does not immediately allocate the power to the slot or port. Any unused power is
still available and remains a part of the overall PoE budget.
• To globally specify the amount of inline power available to all ports in a slot, refer to the lanpower
slot maxpower command on page 2-8

page 2-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Power over Ethernet (PoE) Commands lanpower power

Examples
-> lanpower slot 3/1 power 3200
-> lanpower port 1/1/24 power 25000

Release History
Release 8.1.1; command was introduced.

Related Commands

lanpower slot maxpower Specifies the maximum amount of inline power, in watts,
available to all PoE ports in a specified slot.
lanpower slot update-from Displays the PoE status and related statistics for all ports in a
specified slot.

MIB Objects
alaPethPsePortTable
alaPethPsePortPowerMaximum

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 2-7
lanpower slot maxpower Power over Ethernet (PoE) Commands

lanpower slot maxpower

Specifies the maximum amount of power, in watts, assigned to a specified slot.
lanpower slot chassis/slot maxpower watts

Syntax Definitions

chassis/slot The slot containing PoE ports on which the maximum amount of inline
power allowed is being configured.
watts The maximum amount of inline power, in watts, available to all PoE
ports in the corresponding slot. Refer to the OmniSwitch Hardware
Users Guide for additional PoE specifications.

Defaults

installed power supply default range

920W Power Supply 780W 37-780
600W Power Supply 450W 37-450

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• To specify the maximum amount of inline power available to a single port, refer to the lanpower
power command on page 2-6.
• Note that the power value for the lanpower slot maxpower command is specified in watts (W); the
related command, lanpower power, is specified in milliwatts (mW).

Examples
-> lanpower slot 3/1 maxpower 400

Release History
Release 8.1.1; command was introduced.

page 2-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Power over Ethernet (PoE) Commands lanpower slot maxpower

Related Commands

lanpower power Specifies the amount of power, in milliwatts, provided for a

specific port (when chassis/slot/port values are entered) or
across all ports in a slot (if only slot/port values are entered).
lanpower slot update-from Displays the PoE status and related statistics for all ports in a
specified slot.

MIB Objects
alaPethMainPseTable
alaPethMainPseMaxPower

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 2-9
lanpower priority Power over Ethernet (PoE) Commands

lanpower priority
Specifies PoE power priority level to a port (when chassis/slot/port values are entered) or across all ports
in a slot (if only slot/port values are entered). Levels include critical, high, and low.
lanpower {slot chassis/slot | port chassis/slot/port} priority {critical | high | low}

Syntax Definitions

chassis/slot The slot on which the PoE power priority is being set.
chassis/slot/port The specific port on which the PoE power priority is being set.
critical Intended for ports that have mission-critical devices attached, and
therefore require top (i.e., critical) priority. In the event of a power
management issue, power to critical ports is maintained as long as
possible.
high Intended for ports that have important, but not mission-critical, devices
attached. If other ports in the chassis have been configured as critical,
power to high-priority ports is given second priority to critical devices.
low Intended for ports that have low-priority devices attached. In the event
of a power management issue, power to low-priority ports is interrupted
first (i.e., before critical- and high-priority ports).

Defaults

parameter default
low | high | critical low

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Be sure to use the syntax, “slot” or “port”, before the chassis/slot or chassis/slot/port values in the
command line. Refer to the examples below for more information.
• For OS6860 switches using 920W power supplies, priority disconnect supports up to a maximum of
780W of PoE power. For switches using 600W power supplies, priority disconnect supports up to a
maximum of 450W of PoE power.

Examples
-> lanpower slot 2/1 priority low
-> lanpower port 1/1/6 priority critical

Release History
Release 8.1.1; command was introduced.

page 2-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Power over Ethernet (PoE) Commands lanpower priority

Related Commands

lanpower slot priority-disconnect Enables or disables the priority disconnect function on all
ports in a specified slot.
lanpower slot update-from Displays the PoE status and related statistics for all ports in a
specified slot.

MIB Objects
pethPsePortTable
pethPsePortPowerPriority

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 2-11
lanpower slot priority-disconnect Power over Ethernet (PoE) Commands

lanpower slot priority-disconnect

Enables or disables the priority disconnect function on all ports in a specified slot. Priority disconnect is
used by the system software in determining whether an incoming PD will be granted or denied power
when there are too few watts remaining in the PoE power budget for an additional device.
lanpower slot chassis/slot priority-disconnect {enable | disable}

Syntax Definitions

chassis/slot The particular slot on which the priority disconnect function is being
enabled or disabled.
enable Enables priority disconnect on a specified port. When this function is
enabled and a power budget deficit occurs in which there is inadequate
power for an incoming device, the system software uses priority
disconnect rules to determine whether an incoming device will be
granted or denied power.
disable Disables priority disconnect on a specified port. When priority
disconnect is disabled and there is inadequate power in the budget for an
additional device, power will be denied to any incoming PD, regardless
of its priority status.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
For OS6860 switches using 920W power supplies, priority disconnect supports up to a maximum of 780W
of PoE power (per power supply installed). For switches using 600W power supplies, priority disconnect
supports up to a maximum of 450W of PoE power (per power supply installed).

Examples
-> lanpower slot 2/1 priority-disconnect enable

Release History
Release 8.1.1; command was introduced.

page 2-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Power over Ethernet (PoE) Commands lanpower slot priority-disconnect

Related Commands

lanpower priority Specifies PoE power priority level to a port (when chassis/
slot/port values are entered) or across all ports in a slot (if
only slot/port values are entered).
lanpower slot update-from Displays the PoE status and related statistics for all ports in a
specified slot.
show lanpower slot priority-disconnect Displays current priority disconnect status for a
specified slot.

MIB Objects
alaPethMainPseTable
alaPethMainPsePriorityDisconnect

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 2-13
lanpower power-rule Power over Ethernet (PoE) Commands

lanpower power-rule
Specifies user-defined power rules that can be assigned to PoE ports.
lanpower power-rule rule-name [admin-state {enable | disable}] [power {on | off}] [at {minutes mm |
time hh:mm}] [days {all | day [day...] | date [date...]} [months {all | month}] [timezone {local-server |
utc | originator-server}]
no lanpower power-rule rule-name [admin-state {enable | disable}] [power {on | off}] [at {minutes mm
| time hh:mm}] [days {all | day [day...] | date [date...]} [months {all | month}] [timezone {local-server |
utc | originator-server}]

Syntax Definitions

rule-name A user-defined name (up to 128 characters) for the power rule being
configured.
admin-state Specifies the admin-state for the power rule.
enable Enables the power rule.
disable Disables the power rule.
power Specifies the power status (on or off) for devices connected to ports
within the power rule.
on Powers on devices on ports for which the rule is assigned.
off Powers off devices on ports for which the rule is assigned.
at Activates a a power rule timer. Power rules are triggered on a specified
date or day of the week or at a particular time, or after a specified
amount of time has elapsed.
minutes Sets a timer. Power rules will take effect when a specified number of
minutes have elapsed.
mm The number of minutes that will elapse before the power rules take
effect.
time Sets a timer. Power rules will take effect at a specified time of day.
hh:mm The time of day that the power rule will take effect.
days Specifies that the power rule will take effect on a particular day of the
week.
all Specifies that the power rule will take effect on all days of the week
(Monday through Sunday).
day Specifies a particular day of the month or week the power rule will take
effect. When entering a day of the month, enter one or more numbers
from 1 to 31. When entering a day of the week, use three-digit
abbreviations (e.g., mon, tue, wed, thu, fri, sat and sun). Any
combination of days may be entered in any order. Refer to command
line examples for more information.
month Specifies that the power rule will take effect during a particular month.
all Specifies that the power rule will take effect during all months of the
year (January through December).

page 2-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Power over Ethernet (PoE) Commands lanpower power-rule

month Specifies a particular month of the year the power rule will take effect.
When entering a month, use three-digit abbreviations (e.g., jan, feb,
mar, apr, may, jun, jul, aug, sep, oct, nov and dec). Any combination
of months may be entered in any order. Refer to command line
examples for more information.
timezone Sets a timezone in which timer-based power rules will take effect.
local-server Time as specified by a local server.
utc Specifies that timer-based rules fall under Universal Time Coordinated
(UTC) time.
originator-server Time as specified via the network.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Before a power rule can take effect, the rule must first be assigned to particular slots or ports via the
lanpower power-policy command.

Examples
->lanpower power-rule RuleTest2 admin-state enable power on at minutes 10 days fri
thu tue months all timezone utc
-> lanpower power-rule new power on at time 18:30 days all months all timezone utc
->lanpower power-rule OutgoingPDs power off at time 6:00 days 1 2 3 6 9 12 31
months all timezone utc
-> lanpower power-rule NewRule admin-state enable power off at minutes 4 days all
months all timezone utc

Release History
Release 8.1.1; command was introduced.

Related Commands

lanpower power-policy Allows users to bind existing power rules to particular slots
or ports.
show lanpower power-rule Displays current PoE power rule settings.
show lanpower power-policy Displays existing power policies assigned to a slot, port or
rule.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 2-15
lanpower power-rule Power over Ethernet (PoE) Commands

MIB Objects
alaPethPowerRuleTable
alaPethPowerRuleAdminStatus
alaPethPowerRulePowerStatus
alaPethPowerRuleAtMinute
alaPethPowerRuleAtTime
alaPethPowerRuleDaysOfMonth
alaPethPowerRuleDaysOfWeek
alaPethPowerRuleMonths
alaPethPowerRuleTimezone
alaPethPowerRuleRowStatus

page 2-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Power over Ethernet (PoE) Commands lanpower power-policy

lanpower power-policy
Allows users to bind existing power rules to particular slots or ports.
lanpower [slot chassis/slot | port chassis/slot/port-port] power-policy policy-name [power-rule rule-
name]
no lanpower power-policy name

Syntax Definitions

chassis/slot The slot on which the power policy (with its associated power rule) is
being assigned. This syntax is used the first time the lanpower power-
policy command is entered, where a policy is being assigned to a
particular slot. See Usage Guidelines below for more information.
chassis/slot/port-port The specific slot on which the power policy (with its associated power
rule) is being assigned. Port values may be entered as a single port or
range of ports. This syntax is used the first time the lanpower power-
policy command is entered, where a policy is being assigned to a
particular slot. See Usage Guidelines below for more information
policy-name A user-defined name (up to 128 characters) for the power policy being
configured (or assigned to an existing power rule).
rule-name This syntax is used the second time the lanpower power-policy
command is entered, where a policy is being assigned to an existing
power rule. See Usage Guidelines below for more information.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• One or more power rules must be created before using the lanpower power-policy command. For
information on creating power rules, see the lanpower power-rule command on page 2-14.
• Using the lanpower power-policy command is a two-step process. First, use the command to assign
the policy to specific slots or ports. For example:
-> lanpower slot 1/1 power-policy NewPolicy
-> lanpower port 1/1/23 power-policy NewPolicy
-> lanpower port 1/1/1-12 power-policy NewPolicy

Next, run the command again to assign the policy (with its associated slots or ports) to an existing
power rule. For example:
-> lanpower power-policy NewPolicy power-rule NewRule

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 2-17
lanpower power-policy Power over Ethernet (PoE) Commands

• When assigning a policy to a slot or port, be sure to use the syntax, “slot” or “port”, before the
chassis/slot or chassis/slot/port values in the command line. Refer to the examples below for more
information.

Examples
-> lanpower slot 1/1 power-policy NewPolicy
-> lanpower port 1/1/23 power-policy NewPolicy
-> lanpower power-policy NewPolicy power-rule NewRule
-> no lanpower power-policy NewPolicy

Release History
Release 8.1.1; command was introduced.

Related Commands

lanpower power-rule Specifies user-defined power rules that can be assigned to

PoE ports.
show lanpower power-rule Displays current PoE power rule settings.
show lanpower power-policy Displays existing power policies assigned to a slot, port or
rule.

MIB Objects
alaPethPowerPolicyTable
alaPethPowerPolicyRowStatus
alaPethPowerPortTable
alaPethPowerPortPolicyName
alaPethPowerPortRowStatus

page 2-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Power over Ethernet (PoE) Commands lanpower slot class-detection

lanpower slot class-detection

Enables or disables class detection of attached devices. When class detection is enabled, attached devices
will automatically be limited to their class power, regardless of port power configuration.
lanpower slot chassis/slot class-detection {enable | disable}

Syntax Definitions

chassis/slot The particular slot on which class detection is being enabled or disabled.
enable Enables class detection on the specified slot.
disable Disables class detection on the specified slot.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Although class-detection is disabled by default, the OS6860 still provides power to incoming PDs (if
available in the power budget). However, to strictly enforce class detection as specified in the 802.3at
standard, class detection must be enabled using the lanpower slot class-detection command.
• Enabling class detection will reset all PoE ports on the chassis.

Examples
-> lanpower slot 1/1 class-detection enable
-> lanpower slot 4/1 class-detection disable

Release History
Release 8.1.1; command was introduced.

Related Commands

show lanpower slot class-detection Displays class detection status on a specified slot.

MIB Objects
alaPethMainPseTable
alaPethMainPseClassDetection

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 2-19
lanpower capacitor-detection Power over Ethernet (PoE) Commands

lanpower capacitor-detection
Enables or disables the capacitor detection method.
lanpower slot chassis/slot capacitor-detection {enable | disable}

Syntax Definitions

chassis/slot The particular slot on which class detection is being enabled or disabled.
enable Enables the capacitor detection method on the specified slot.
disable Disables the capacitor detection method on the specified slot.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The capacitor detection method should only be enabled if there are legacy IP phones attached to the
corresponding slot—this feature is not compatible with IEEE specifications. Please contact your Alcatel-
Lucent sales engineer or Customer Support representative to find out which Alcatel-Lucent IP phones
models need capacitive detection enabled.

Examples
-> lanpower slot 3/1 capacitor-detection enable
-> lanpower slot 1/1 capacitor-detection disable

Release History
Release 8.1.1; command was introduced.

Related Commands

show lanpower slot capacitor-detection Displays capacitor detection status on a specified slot.

MIB Objects
alaPethMainPseTable
alaPethMainPseCapacitorDetect

page 2-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Power over Ethernet (PoE) Commands lanpower slot usage-threshold

lanpower slot usage-threshold

Tells the switch to watch for a user-defined, slot-wide threshold for PoE power usage, in percent. When
the usage threshold is reached or exceeded, a notification is sent to the user.
lanpower slot chassis/slot usage-threshold num

Syntax Definitions

chassis/slot The slot for which usage threshold monitoring is being set.
num The percentage of allowed usage from attached PoE devices before a
notification is sent to the user.

Defaults

parameter default
num 99

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The lanpower slot usage-threshold does not affect the amount of PoE power allocated to a particular
slot. The command is a monitoring method that tells the switch to send a “specified usage exceeded”
notification (i.e., trap) only when a specified percentage has been reached.

Examples
-> lanpower slot 1/1 usage-threshold 50

Release History
Release 8.1.1; command was introduced.

Related Commands

show lanpower slot usage-threshold Displays current usage threshold, in percent.

MIB Objects
pethMainPseTable
pethMainPseUsageThreshold

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 2-21
lanpower slot update-from Power over Ethernet (PoE) Commands

lanpower slot update-from

This command is used to update the PoE microcontroller firmware.
lanpower slot {chassis/slot | all} update-from filename

Syntax Definitions

chassis/slot The slot to be updated.

all Update all the chassis in a virtual chassis.
filename The file name of the PoE firmware.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The binary file must be placed in the /flash directory of the Master.

• Once started, console messages will be displayed during the update procedure which may take up to 10
minutes.
• The lanpower service must be disabled during the update and minimal load should be placed on the
switch. The update process must be allowed to finish prior to unplugging or configuring the units.

Examples
-> lanpower slot 1/1 update-from poe_binary_version.bin

Release History
Release 8.1.1; command was introduced.

Related Commands

show lanpower slot update-from Displays current PoE firmware update status.

MIB Objects
N/A

page 2-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Power over Ethernet (PoE) Commands show lanpower slot

show lanpower slot

Displays the PoE status and related statistics for all ports in a specified slot.
show lanpower slot chassis/slot

Syntax Definitions

chassis The virtual chassis ID for which current inline power status and related
statistics are to be displayed.
slot The slot for which current inline power status and related statistics are to
be displayed.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show lanpower slot 1/1
Port Maximum(mW) Actual Used(mW) Status Priority On/Off Class Type
----+-----------+---------------+-----------+---------+--------+-------+----------
1 60000 0 Powered Off Low OFF .
2 60000 0 Powered Off Low OFF .
3 60000 0 Powered Off Low OFF .
4 60000 0 Powered Off Low OFF .
5 30000 0 Powered Off Low OFF .
6 30000 0 Powered Off Low OFF .
7 30000 0 Powered Off Low OFF .
8 30000 0 Powered Off Low OFF .
9 30000 0 Powered Off Low OFF .
10 30000 0 Powered Off Low OFF .
...
45 30000 0 Powered Off Low OFF .
46 30000 0 Powered Off Low OFF .
47 30000 0 Powered Off Low OFF .
48 30000 0 Powered Off Low OFF .

ChassisId 1 Slot 1 Max Watts 780

0 Watts Total Power Budget Used
750 Watts Total Power Budget Available
1 Power Supplies Available
BPS power: Not Available

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 2-23
show lanpower slot Power over Ethernet (PoE) Commands

output definitions
Port A PoE port for which current status and related statistics are being
displayed.
Maximum (mW) The current maximum amount of power available to the corresponding
PoE port, in milliwatts. For more information on this parameter,
including default values and changing the settings, refer to the
lanpower power command on page 2-6.
Actual Used (mW) The actual amount of power being used by an attached device (if
applicable), in milliwatts. If no device is attached to the corresponding
port, this row displays a value of 0.
Status Displays the port’s current operational status. Options include Powered
On, Powered Off, Searching, Fault, Deny and Test. Powered On
indicates that PoE power activation is complete and the attached device
is receiving power. Powered Off indicates that no PoE device is
attached and/or the port is not receiving PoE power. Searching
indicates that PoE activation has started and a powered device PD has
been detected, but activation or class detection is incomplete. Fault
indicates that PoE activation or class detection has failed. Deny
indicates that PoE power management has denied power to the port due
to priority disconnect or over subscription. Test indicates that the port
has been forced on and will remain on until it is forced off by RTP
functions.
Priority The current priority level for the corresponding PoE port. Options
include Critical, High, and Low. Critical should be reserved for ports
that have mission-critical devices attached, and therefore require top
(i.e., critical) priority. In the event of a power management issue, inline
power to critical ports is maintained as long as possible. High indicates
ports that have important, but not mission-critical, devices attached. If
other ports in the chassis have been configured as critical, inline power
to high-priority ports is given second priority. Low priority is for ports
that have low-priority devices attached. In the event of a power
management issue, inline power to low-priority ports is interrupted first
(i.e., before critical and high-priority ports).

The default value is Low. Priority levels can be changed using the
lanpower priority command.
On/Off Displays whether a port has been manually turned on or off by the user.
ON indicates that the port has been turned on by the user via the
lanpower slot service command. OFF is the default value and can also
indicate that the port has been turned off by the user via the lanpower
slot service command.
Class PoE class detected on the attached Powered Device. See the lanpower
slot class-detection command on page 2-19 for more information.
Type A user-defined name port type (i.e., text string) for the port. See the
lanpower type command on page 2-5 for more information.
Max Watts The maximum watts available to the corresponding slot. The maximum
watts value for a slot can be changed using the lanpower slot
maxpower command.
Total Power Budget Used The amount of power being used by attached PoE devices.

page 2-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Power over Ethernet (PoE) Commands show lanpower slot

output definitions (continued)

Total Power Budget Available The amount of power budget remaining for PoE . If the total power
budget remaining is exceeded, a power error will occur and the switch’s
chassis management software will begin shutting down power to PoE
ports according to their priority levels.
Power Supplies Available The number of power supplies currently installed and operating in the
switch.
BPS power The amount of power available from an OSBPS backup power supply.
If no OSBPS is installed, the default value is Not Available.

Release History
Release 8.1.1; command was introduced.

Related Commands
N/A

MIB Objects
alaPethPsePortPowerActual
alaPethPsePortPowerMaximum
alaPethPsePortPowerStatus
pethPsePortPowerPriority
pethPsePortAdminEnable
pethPsePortPowerClass

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 2-25
show lanpower power-rule Power over Ethernet (PoE) Commands

show lanpower power-rule

Displays current PoE power rule settings.
show lanpower power-rule [name]

Syntax Definitions

name The name of an existing power rule.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Entering the show lanpower power-rule command without the name string provides top-level
information for all existing power rules. To view detailed information for a particular rule (e.g., timer and
timezone settings, etc.), specify the name string in the command line.

Examples
-> show lanpower power-rule
Power-Rule Admin-state Power
----------------------------------+------------+---------------------
test Disabled Off

-> show lanpower power-rule test

Power-Rule : test
Admin-state : Disabled
Power : Off
At HH:MM : 00:00
Day-of-Week : All
Month-of-Year : All
Timezone : Local

output definitions
Power-Rule The name(s) of existing PoE power rule(s).
Admin-state The port PoE status assigned to the rule. Refer to page 2-14 for more
information.
Power The PoE power status assigned to the rule. Refer to page 2-14 for more
information.
At HH:MM The time of day the power rule takes effect. Refer to page 2-14 for more
information.

page 2-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Power over Ethernet (PoE) Commands show lanpower power-rule

output definitions (continued)

Day-of-Week The day of the week the power rule takes effect. Refer to page 2-15 for
more information.
Month-of-Year The month of year the power rule takes effect.Refer to page 2-15 for
more information.
Timezone The timezone under which the power rule takes effect. Options include
local-server, originator-server and utc. Refer to page 2-15 for more
information.

Release History
Release 8.1.1; command was introduced.

Related Commands

lanpower power-rule Specifies user-defined power rules that can be assigned to

PoE ports.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 2-27
show lanpower power-policy Power over Ethernet (PoE) Commands

show lanpower power-policy

Displays existing power policies assigned to a slot, port or rule.
show lanpower power-policy [policy-name slot | policy-name power-rule | policy-name port]

Syntax Definitions

policy-name The text string for an existing power policy.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Entering the show lanpower power-policy command without the policy-name string provides top-level
information for all existing policies, including associated power rules (if any). To view detailed
information for a particular policy, specify the policy-name string in the command line, along with the
policy’s associated slot, port or rule. See Examples below for additional information.

Examples
-> show lanpower power-policy
Power-Policy name Power-rules
----------------------------------+----------------------------------
Mar25 RuleTest2

-> show lanpower power-policy Mar25 power-rule

Power-Policy name : Mar25
Power-rules : RuleTest2

output definitions
Power-Policy name The names of existing PoE power policies.
Power-rules The power rules associated with the existing power policies.

Release History
Release 8.1.1; command was introduced.

page 2-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Power over Ethernet (PoE) Commands show lanpower power-policy

Related Commands

lanpower power-policy Allows users to bind existing power rules to particular slots
or ports.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 2-29
show lanpower slot class-detection Power over Ethernet (PoE) Commands

show lanpower slot class-detection

Displays class detection status on a specified slot.
show lanpower slot chassis/slot class-detection

Syntax Definitions

chassis/slot The slot for which class detection is being displayed.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Although class-detection is disabled by default, the OS6860 still provides power to incoming PDs (if
available in the power budget). However, to strictly enforce class detection as specified in the 802.3at
standard, class detection must be enabled using the lanpower slot class-detection command.
• Enabling class detection will reset all PoE ports on the chassis.

Examples
-> show lanpower slot 1/1 class-detection
Class Detection disabled on ChassisId 1 Slot 1

Release History
Release 8.1.1; command was introduced.

Related Commands

lanpower slot class-detection Enables or disables class detection of attached devices.

MIB Objects
N/A

page 2-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Power over Ethernet (PoE) Commands show lanpower slot capacitor-detection

show lanpower slot capacitor-detection

Displays capacitor detection status on a specified slot.
show lanpower slot chassis/slot capacitor-detection

Syntax Definitions

chassis/slot The slot for which capacitor detection is being displayed.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show lanpower slot 1/1 capacitor-detection
Capacitor Detection disabled on ChassisId 1 Slot 1

Release History
Release 8.1.1; command was introduced.

Related Commands

lanpower capacitor-detection Enables or disables the capacitor detection method.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 2-31
show lanpower slot priority-disconnect Power over Ethernet (PoE) Commands

show lanpower slot priority-disconnect

Displays current priority disconnect status for a specified slot.
show lanpower slot chassis/slot priority-disconnect

Syntax Definitions

chassis/slot The particular slot on which priority disconnect status is being

displayed.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
For OS6860 switches using 920W power supplies, priority disconnect supports up to a maximum of 780W
of PoE power (per power supply installed). For switches using 600W power supplies, priority disconnect
supports up to a maximum of 450W of PoE power (per power supply installed).

Examples
-> show lanpower slot 1/1 priority-disconnect
Priority Disconnect enabled on ChassisId 1 Slot 1

Release History
Release 8.1.1; command was introduced.

Related Commands

lanpower slot priority-disconnect Enables or disables the priority disconnect function on all
ports in a specified slot.

MIB Objects
N/A

page 2-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Power over Ethernet (PoE) Commands show lanpower slot usage-threshold

show lanpower slot usage-threshold

Displays current usage threshold, in percent.
show lanpower slot chassis/slot usage-threshold]

Syntax Definitions

chassis/slot The particular slot on which priority disconnect status is being

displayed.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show lanpower slot 1/1 usage-threshold
Usage Threshold 99% on ChassisId 1 Slot 1

Release History
Release 8.1.1; command was introduced.

Related Commands

lanpower slot usage-threshold Sets a slot-wide threshold for PoE power usage, in percent.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 2-33
show lanpower slot update-from Power over Ethernet (PoE) Commands

show lanpower slot update-from

Displays the PoE firmware update status.
show lanpower slot {chassis/slot | all} update-from

Syntax Definitions

chassis/slot Display the update status for a slot.

all Display the update status for all chassis.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command can be used to display the update progress from a remote session such as Telnet or SSH.

Examples
-> show lanpower slot all update-from
Tue Apr 8 16:48:16 : lpCmm LanCmm info message:
+++ Reprogramming Sequence Started 0 chassisId 1 slot 1
+++ Reprogramming Sequence Started 0 chassisId 2 slot 1

Tue Apr 8 16:48:19 : lpCmm LanCmm info message:

+++ Controller Memory Sequence Begining 0 chassisId 1 slot 1
+++ Controller Memory Sequence Begining 0 chassisId 2 slot 1

Tue Apr 8 16:48:33 : lpCmm LanCmm info message:

+++ Controller Memory Please Wait... 0 chassisId 1 slot 1
+++ Controller Memory Please Wait... 0 chassisId 2 slot 1

Tue Apr 8 16:52:22 : lpCmm LanCmm info message:

+++ Reprogram Pass 0 chassisId 1 slot 1
+++ Reprogram Pass 0 chassisId 2 slot 1

Release History
Release 8.1.1; command was introduced.

page 2-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Power over Ethernet (PoE) Commands show lanpower slot update-from

Related Commands

lanpower slot update-from This command is used to update the PoE microcontroller
firmware.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 2-35
show lanpower slot update-from Power over Ethernet (PoE) Commands

page 2-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 3 UDLD Commands

This chapter describes the CLI commands used to configure the UDLD (UniDirectional Link Detection)
protocol. UDLD operates at Layer 2 in conjunction with IEEE 802.3 Layer 1 fault detection mechanism. It
is a protocol used for detecting and disabling unidirectional Ethernet fiber or copper connections to avoid
interface malfunctions, Spanning Tree loops, media faults, and so on. It operates in two main modes
normal and aggressive.
The two basic mechanisms that UDLD follows are:cha
• Advertises port identity and learns about its neighbors. This information is maintained in a cache table.

• It sends continuous echo messages when fast notifications are required.

MIB information for the UDLD commands is as follows:

Filename: AlcatelIND1UDLD.mib
Module: ALCATEL-IND1-UDLD-MIB
A summary of available commands is listed here:

udld
udld port
udld mode
udld probe-timer
udld echo-wait-timer
clear udld statistics port
show udld configuration
show udld configuration port
show udld statistics port
show udld neighbor port
show udld status port

Configuration procedures for UDLD are explained in “Configuring UDLD,” OmniSwitch AOS Release 8
Network Configuration Guide.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 3-1
udld UDLD Commands

udld
Globally enables or disables UDLD protocol on the switch.
udld {enable | disable}

Syntax Definitions

enable Globally enables UDLD on the switch.

disable Globally disables UDLD on the switch.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The port shutdown by this command can be reset by using the interfaces admin command.

Examples
-> udld enable
-> udld disable

Release History
Release 8.1.1; command introduced.

Related Commands

udld port Enables or disables UDLD status on a specific port or a range of ports.
show udld configuration Displays the global status of UDLD configuration.
show udld configuration port Displays the configuration information for all UDLD ports or for a
particular UDLD port on the switch.

MIB Objects
alaUdldGlobalStatus
alaUdldGlobalConfigUdldStatus

page 3-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UDLD Commands udld port

udld port
Enables or disables UDLD status on a specific port or a range of ports.
udld port chassis/slot/port[-port2] {enable | disable}

Syntax Definitions

chassis The chassis identifier.

slot/port The slot number for the module and the physical port number on that
module.
port2 The last port number in a range of ports that you want to configure on
the same slot.
enable Enables UDLD status on a port.
disable Disables UDLD status on a port.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The UDLD protocol must be enabled before using this command.

Examples
-> udld port 1/1/3 enable
-> udld port 1/1/6-10 enable
-> udld port 2/1/4 disable

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 3-3
udld port UDLD Commands

Related Commands

udld Globally enables or disables UDLD protocol on the switch.

show udld configuration port Displays the configuration information for all UDLD ports or for a
particular UDLD port on the switch.

MIB Objects
alaUdldPortConfigTable
alaUdldPortConfigUdldStatus

page 3-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UDLD Commands udld mode

udld mode
Configures the UDLD operational mode on a specific port, a range of ports, or all ports.
udld [port [chassis/slot/port[-port2]] mode {normal | aggressive}

Syntax Definitions

chassis The chassis identifier.

slot/port The slot number for the module and the physical port number on that
module.
port2 The last port number in a range of ports that you want to configure on
the same slot.
normal Specifies UDLD operation in the normal mode.
aggressive Specifies UDLD operation in the aggressive mode.

Defaults

parameter default
normal | aggressive normal

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The UDLD protocol must be enabled before using this command.

• The UDLD protocol is not supported on aggregate ports.

• In case of faulty cable connection, the port which is configured in normal mode of operation is
considered to be in the shutdown state.

Examples
-> udld mode aggressive
-> udld mode normal
-> udld port 1/1/3 mode aggressive
-> udld port 2/1/4 mode normal
-> udld port 2/1/9-18 mode aggressive

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 3-5
udld mode UDLD Commands

Related Commands

udld Globally enables or disables UDLD protocol on the switch.

show udld configuration port Displays the configuration information for all UDLD ports or for a
particular UDLD port on the switch.

MIB Objects
alaUdldPortConfigTable
alaUdldPortConfigUdldMode

page 3-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UDLD Commands udld probe-timer

udld probe-timer
Configures the probe-message advertisement timer on a specific port, a range of ports, or all ports. Probe
messages are transmitted periodically after this timer expires.
udld [port [chassis/slot/port[-port2]] probe-timer seconds
no udld [port [chassis/slot/port[-port2]] probe-timer

Syntax Definitions

chassis The chassis identifier.

slot/port The slot number for the module and the physical port number on that
module.
port2 The last port number in a range of ports that you want to configure on
the same slot.
seconds The probe-message transmission interval, in seconds.

Defaults

parameter default
seconds 15

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to reset the probe-message timer to the default value. Note that it is
not necessary to specify the probe-message interval to reset it.
• The UDLD protocol must be enabled before using this command.

• Configure probe-advertisement timer with values varying in a range of 12-18 seconds for better
convergence time and to avoid burst of probe advertisements.

Examples
-> udld probe-timer 20
-> udld port 1/1/3 probe-timer 16
-> udld port 1/1/8-21 probe-timer 18
-> no udld probe-timer
-> no udld port 1/1/3 probe-timer

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 3-7
udld probe-timer UDLD Commands

Related Commands

udld Globally enables or disables UDLD protocol on the switch.

show udld configuration port Displays the configuration information for all UDLD ports or for a
particular UDLD port on the switch.

MIB Objects
alaUdldPortConfigTable
alaUdldPortConfigUdldProbeIntervalTimer

page 3-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UDLD Commands udld echo-wait-timer

udld echo-wait-timer
Configures the echo based detection timer on a specific port, a range of ports, or all the ports. This is
known as link detection period.
udld [port [chassis/slot/port[-port2]] echo-wait-timer seconds
no udld [port [chassis/slot/port[-port2]] echo-wait-timer

Syntax Definitions

chassis The chassis identifier.

slot/port The slot number for the module and the physical port number on that
module.
port2 The last port number in a range of ports that you want to configure on
the same slot.
seconds The echo based detection period, in seconds.

Defaults

parameter default
seconds 8

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to reset the echo based detection timer to the default value. Note that
it is not necessary to specify the echo based timer to reset it.
• The UDLD protocol must be enabled before using this command.

• An echo message is expected in reply from the neighbor within this time duration, otherwise, the port
is considered as faulty.

Examples
-> udld echo-wait-timer 9
-> udld port 1/1/5 echo-wait-timer 12
-> udld port 1/1/7-16 echo-wait-timer 12
-> no udld echo-wait-timer
-> no udld port 1/1/3 echo-wait-timer

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 3-9
udld echo-wait-timer UDLD Commands

Related Commands

udld Globally enables or disables UDLD protocol on the switch.

show udld configuration port Displays the configuration information for all UDLD ports or for a
particular UDLD port on the switch.

MIB Objects
alaUdldPortConfigTable
alaUdldPortConfigUdldDetectionPeriodTimer

page 3-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UDLD Commands clear udld statistics port

clear udld statistics port

Clears the UDLD statistics for a specific port or for all the ports.
clear udld statistics [port chassis/slot/port]

Syntax Definitions

chassis The chassis identifier.

slot/port The slot number for the module and the physical port number on that
module.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If the slot/port option is not specified, UDLD statistics for the switch is cleared.

Examples
-> clear udld statistics port 1/1/4
-> clear udld statistics

Release History
Release 8.1.1; command introduced.

Related Commands

udld Globally enables or disables UDLD protocol on the switch.

show udld statistics port Displays the UDLD statistics for a specific port.

MIB Objects
alaUdldGlobalClearStats

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 3-11
show udld configuration UDLD Commands

show udld configuration

Displays the global status of UDLD configuration.
show udld configuration

Syntax Definitions
N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show udld configuration

Global UDLD Status : disabled,

Global UDLD Mode : normal,
Global UDLD Probe Timer (Sec) : 15,
Global UDLD Echo-Wait Timer (Sec) : 8
Global UDLD Status : Disabled

output definitions
Global UDLD Status Indicates the UDLD status on the switch. Options include enabled or
disabled.
Global UDLD Mode Indicates the UDLD mode on the switch. Options include normal or
aggressive.
Global UDLD Probe Timer A probe-message is expected after this time period.
(Sec)
Global UDLD Echo-Wait The detection of neighbor is expected with in this time period.
Timer (Sec)
Global UDLD Status Indicates the UDLD status on the switch. Options include enabled or
disabled.

Release History
Release 8.1.1; command introduced.

page 3-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UDLD Commands show udld configuration

Related Commands

udld Globally enables or disables UDLD protocol on the switch.

show udld configuration port Displays the configuration information for all UDLD ports or for a
particular UDLD port on the switch.

MIB Objects
alaUdldGlobalStatus
alaUdldGlobalConfigUdldStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 3-13
show udld configuration port UDLD Commands

show udld configuration port

Displays the configuration information for all UDLD ports or for a particular UDLD port on the switch.
show udld configuration port [chassis/slot/port]

Syntax Definitions

chassis The chassis identifier.

slot/port The slot number for the module and the physical port number on that
module.

Defaults
By default, a list of all UDLD ports is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show udld configuration port

Slot/Port Admin State Oper Mode Probe-Timer Echo-Wait-Timer

-----------+---------------+------------+-------------+----------------
1/1/1 disabled normal 15 10
1/1/2 disabled normal 45 10
1/1/17 disabled normal 33 8
1/1/18 disabled normal 33 8
1/1/19 disabled normal 33 8
1/1/20 disabled aggresive 55 8
1/1/21 disabled aggresive 55 8
1/1/22 disabled aggresive 55 8
1/1/41 disabled aggresive 77 8
1/1/42 enabled aggresive 77 8
1/1/43 enabled aggresive 77 8
1/1/44 enabled aggresive 77 8
1/1/45 enabled aggresive 77 8

-> show udld configuration port 1/1/44

Global UDLD Status : enabled,

Port UDLD Status : enabled,
Port UDLD State : bidirectional,
UDLD Op-Mode : aggresive,
Probe Timer (Sec) : 77,
Echo-Wait Timer (sec) : 8

page 3-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UDLD Commands show udld configuration port

output definitions
Slot/Port Slot number for the module and physical port number on that module.
UDLD-State Indicates the state of interface determined by UDLD operation, which
can be notapplicable, shutdown, undetermined or bidirectional.
Oper-Mode Indicates the operational mode of UDLD protocol. Options include
normal or aggressive.
Global UDLD Status Indicates the UDLD status on the switch. Options include enabled or
disabled.
Port UDLD Status Indicates the UDLD status on a port. Options include enable or dis-
able.
Probe Timer A probe-message is expected after this time period.
Echo-Wait Timer The detection of neighbor is expected with in this time period.

Release History
Release 8.1.1; command introduced.

Related Commands

udld mode Configures the operational mode of UDLD on a specific port, a range of
ports, or all the ports.
udld probe-timer Configures the probe-message advertisement timer on a specific port, a
range of ports, or all the ports.
udld echo-wait-timer Configures the echo based detection timer on a specific port, a range of
ports, or all the ports.

MIB Objects
alaUdldGlobalStatus
alaUdldGlobalConfigUdldStatus
alaUdldPortConfigTable
alaUdldPortConfigUdldOperationalStatus
alaUdldPortConfigUdldMode
alaUdldPortConfigUdldStatus
alaUdldPortConfigUdldProbeintervalTimer
alaUdldPortConfigUdldDetectionPeriodTimer
alaUdldPortNeighborStatsTable
alaUdldNeighborName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 3-15
show udld statistics port UDLD Commands

show udld statistics port

Displays the UDLD statistics for a specific port.
show udld statistics port chassis/slot/port

Syntax Definitions

chassis The chassis identifier.

slot/port The slot number for the module and the physical port number on that
module.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show udld statistics port 1/1/42

UDLD Port Statistics

Hello Packet Send :8,
Echo Packet Send :8,
Flush Packet Recvd :0
UDLD Neighbor Statistics
Neighbor ID Hello Pkts Recv Echo Pkts Recv
--------------+--------------------+--------------
1 8 15
2 8 15
3 8 21
4 8 14
5 8 15
6 8 20

output definitions
Hello Packet Send The number of hello messages sent by a port.
Echo Packet Send The number of echo messages sent by a port.
Flush Packet Recvd The number of UDLD-Flush message received by a port.
Neighbor ID The name of the neighbor.
Hello Pkts Recv The number of hello messages received from the neighbor.
Echo Pkts Recv The number of echo messages received from the neighbor.

page 3-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UDLD Commands show udld statistics port

Release History
Release 8.1.1; command introduced.

Related Commands

udld probe-timer Configures the probe-message advertisement timer on a specific port, a

range of ports, or all the ports.
udld echo-wait-timer Configures the echo based detection timer on a specific port, a range of
ports, or all the ports.

MIB Objects
alaUdldPortNeighborStatsTable
alaUdldNeighborName
alaUdldNumHelloSent
alaUdldNumHelloRcvd
alaUdldNumEchoSent
alaUdldNumEchoRcvd
alaUdldNumFlushRcvd

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 3-17
show udld neighbor port UDLD Commands

show udld neighbor port

Displays the UDLD neighbor ports.
show udld neighbor port chassis/slot/port

Syntax Definitions

chassis The chassis identifier.

slot/port The slot number for the module and the physical port number on that
module.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show udld neighbor port 1/1/42

Neighbor ID Device Id Port Id

-----------------+--------------------+----------------
1 00:d0:95:ea:b2:48 00:d0:95:ea:b2:78
2 00:d0:95:ea:b2:48 00:d0:95:ea:b2:79
3 00:d0:95:ea:b2:48 00:d0:95:ea:b2:74
4 00:d0:95:ea:b2:48 00:d0:95:ea:b2:75
5 00:d0:95:ea:b2:48 00:d0:95:ea:b2:76
6 00:d0:95:ea:b2:48 00:d0:95:ea:b2:77

output definitions
Neighbor ID The name of the neighbor.
Device ID The device ID.
Port ID The port ID.

Release History
Release 8.1.1; command introduced.

page 3-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UDLD Commands show udld neighbor port

Related Commands

udld echo-wait-timer Configures the echo based detection timer on a specific port, a range of
ports, or all the ports. This is known as link detection period.
show udld statistics port Displays the UDLD statistics for a specific port.

MIB Objects
alaUdldPortNeighborStatsTable
alaUdldNeighborName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 3-19
show udld status port UDLD Commands

show udld status port

Displays the UDLD status for all ports or for a specific port.
show udld status port [chassis/slot/port]

Syntax Definitions

chassis The chassis identifier.

slot/port The slot number for the module and the physical port number on that
module.

Defaults
By default, a list of all UDLD ports is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show udld status port
Slot/Port Admin State Operational State
--------------+------------------+------------------------
1/1/1 disabled not applicable
1/1/2 disabled not applicable
1/1/3 disabled not applicable
1/1/21 disabled not applicable
1/1/40 disabled not applicable
1/1/41 disabled not applicable
1/1/42 enabled bidirectional
1/1/43 enabled bidirectional

-> show udld status port 1/1/44

Admin State : enabled,
Operational State : bidirectional

output definitions
Slot/Port Slot number for the module and physical port number on that module.
Admin State Indicates whether UDLD is administratively enabled or disabled.
Operational State Indicates the state of interface determined by UDLD operation, which
can be notapplicable, shutdown, undetermined or bidirectional.

Release History
Release 8.1.1; command introduced.

page 3-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UDLD Commands show udld status port

Related Commands

udld port Enables or disables UDLD status on a specific port or a range of ports.
show udld configuration port Displays the configuration information for all UDLD ports or for a
particular UDLD port on the switch.

MIB Objects
alaUdldGlobalStatus
alaUdldPortConfigTable
alaUdldPortConfigUdldOperationalStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 3-21
show udld status port UDLD Commands

page 3-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 4 Source Learning
Commands

The Source Learning capability of OmniSwitch is responsible for creating, updating, and deleting source
and destination MAC Address entries in the MAC Address Table. This chaptebr includes descriptions of
Source Learning commands used to create or delete static MAC addresses, define the aging time value for
static and dynamically learned MAC addresses, and display MAC Address Table entries and statistics.
MIB information for Source Learning commands is as follows:
Filename: AlcatelInd1MacAddress.mib
Module: ALCATEL-IND1-MAC-ADDRESS-MIB
A summary of the available commands is listed here:

mac-learning
mac-learning flush
mac-learning flush domain
mac-learning static mac-address
mac-learning multicast mac-address
mac-learning aging-time
mac-learning mode
mac-ping
show mac-learning
show mac-learning domain
show mac-learning remote
show mac-learning aging-time
show mac-learning learning-state
show mac-learning mode

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 4-1
mac-learning Source Learning Commands

mac-learning
Configures the status of source MAC address learning on a single port, a range of ports, or on a link
aggregate of ports.
mac-learning {vlan vlan[-vlan2] | port chassis/slot/port | linkagg linkagg} {enable | disable}

Syntax Definitions

vlan The VLAN ID number.

-vlan2 The last VLAN ID in a range of VLAN IDs.
chassis The chassis identifier.
slot/port The slot number for the module and the physical port number on that
module.
linkagg Specifies the link aggregate ID number.
enable Enables source learning.
disable Disables source learning.

Defaults
By default, source learning is enabled on all ports.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Configuring source learning is not supported on Learned Port Security (LPS) and Universal Network
Profile (UNP) ports, as well as individual ports that are members of a link aggregate.
• When port-based source learning is configured for a link aggregate ID, it affects all the ports that are
members of the link aggregate.
• When source learning is disabled on a port or link aggregate, dynamic learning of MAC addresses is
stopped.
• Static MAC addresses associated with a port or link aggregate are not cleared when source learning is
disabled. Also, new static MAC address configurations are allowed on ports or link aggregates on
which source learning is disabled.
• Disabling source learning on a port or link aggregate is useful on a ring configuration, where switch A
does not have to learn MAC addresses from switch B, or for a Transparent LAN Service, where service
provider does not require the MAC addresses of the customer network.
• When mac-learning is disabled there may be an increase in flooded/broadcast traffic. In the case of an
Eservice VLAN throughput may be decreased slightly due to the removal of the 4-byte outer VLAN in
the case of traffic going from NNI to UNI. However there is no loss of data.

page 4-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Source Learning Commands mac-learning

Examples
-> mac-learning port 1/1/2 enable
-> mac-learning linkagg 10 disable

Release History
Release 8.1.1; command added.

Related Commands

show mac-learning learning- Displays the source learning status of a port or link aggregate on the
state switch.

MIB Objects
slMacLearningControlTable
slMacLearningControlStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 4-3
mac-learning flush Source Learning Commands

mac-learning flush
Clears the specified MAC addresses from the Source Learning MAC Address Table on the local switch.
mac-learning flush {dynamic | static | multicast | vlan vlan_id | } [mac-address mac_address]

Syntax Definitions

dynamic Clears dynamically learned MAC addresses.

static Removes static MAC addresseses.
multicast Removes static multicast MAC addresses.
mac_address Enter the MAC Address to clear from the MAC Address Table (for
example, 00:00:39:59:f1:0c).

Defaults

parameter default
mac-address all MAC addresses

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command flushes dynamically learned addresses from the MAC Address Table.

• Static unicast and static multicast addresses are removed. This command replaces the no form of the
mac-learning command that was used in previous releases.

Examples
-> mac-learning flush vlan 20 port 1/12 dynamic
-> mac-learning flush vlan 20 linkagg 10 static

Release History
Release 8.1.1; command added.

Related Commands

show mac-learning Displays Source Learning MAC Address Table information for the
local switch.

MIB Objects
slMacLearningControlTable
slMacLearningControlStatus

page 4-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Source Learning Commands mac-learning flush domain

mac-learning flush domain

Clears the specified MAC addresses from the Source Learning MAC Address Table for the specified
learning domain on the local switch.
mac-learning flush domain {all | vlan {vlan vlan_id [port chassis/slot/port | linkagg agg_id ]} | spb
{serviceid service_id | sap chassis/slot/port:encap | mesh-sdp mesh_id | isid instance_id} | evb {serviceid
service_id}} {dynamc | static | static-multicast} [mac-address mac_address]

Syntax Definitions

all Selects all learning domains.

vlan Selects the VLAN domain.
vlan_id VLAN ID number.
chassis The chassis identifier.
slot/port The slot and port number that is assigned to the static MAC address.
agg_id Enter a link aggregate ID number.
spb Selectes the Shortest Path Bridging (SPB) service domain.
service_id An existing SPB service ID.
slot/port:encap The SPB access port and encapsulation (0, all, qtag, or
outer_qtag.inner_qtag) for a SPB service access point (SAP).
mesh_id A SPB service distribution point (SDP) ID.
isid instance_id A SPB backbone service instance identifier (I-SID).
evb Selectes the Shortest Path Bridging (SPB) service domain.
service_id An existing Edge Virtual Bridging (EVB) service ID.
dynamic Clears dynamically learned MAC addresses from the specified domain.
static Removes static MAC addresseses from the specified domain.
static-multicast Removes static multicast MAC addresses from the specified domain.
This parameter is not available for use with the all, spb, or evb
parameters.
mac_address Enter a specific MAC Address to clear from the MAC Address Table
(for example, 00:00:39:59:f1:0c) for the specified domain.

Defaults

parameter default
mac-address all MAC addresses

Platforms Supported
OmniSwitch 6860, 6860E

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 4-5
mac-learning flush domain Source Learning Commands

Usage Guidelines
• This command flushes dynamically learned addresses from the MAC Address Table that were learned
or statically configured for the specifie domain.
• Static unicast and static multicast addresses are removed.

• The mac-learning flush command replaces the no form of the mac-learning command that was used
in previous releases.

Examples
-> mac-learning flush domain vlan vlan 20 port 1/1/2 dynamic
-> mac-learning flush domain vlan linkagg 10 static
-> mac-learning flush domain spb sap 1/12:0 dynamic
-> mac-learning flush domain all

Release History
Release 8.1.1; command added.

Related Commands

mac-learning flush Clears the MAC Address Table for the local switch.
show mac-learning Displays Source Learning MAC Address Table information for the
local switch.

MIB Objects
slMacLearningControlTable
slMacLearningControlStatus

page 4-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Source Learning Commands mac-learning static mac-address

mac-learning static mac-address

Configures a static destination unicast MAC address. The configured MAC address is assigned to a fixed
switch port or link aggregate ID and VLAN. If the destination of the data packets received on the VLAN
ports is the configured MAC address, then they are forwarded to the specific MAC address port.
mac-learning {vlan vlan_id {port chassis/slot/port | linkagg linkagg_id}} static mac-address
mac_address [bridging | filtering]
mac-learning flush [vlan vlan_id [port chassis/slot/port | linkagg linkagg_id]] static [mac-address
mac_address]

Syntax Definitions

vlan_id VLAN ID number.

chassis The chassis identifier.
slot/port The slot and port number that is assigned to the static MAC address.
linkagg_id Enter a link aggregate ID number. See Chapter 10, “Link Aggregation
Commands.”
static Specifies a permanent static MAC address that is retained even after the
switch reboots.
dynamic Specifies a dynamic MAC address that is removed when the switch
reboots.
mac_address Enter a destination MAC Address (for example, 00:00:39:59:f1:0c).
bridging Specifies that all packets to or from this MAC address are bridged.
filtering Specifies that all packets to or from this MAC address are filtered or
dropped.

Defaults

parameter default
bridging | filtering bridging

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the mac-learning flush command to remove a static MAC address from the Source Learning
MAC Address Table. Note that If no parameters are specified with this command, then all static
addresses are removed.
• Enter a port number or link aggregate ID that is already associated with the specified VLAN ID. Only
traffic from other ports associated with the same VLAN is directed to the static MAC address port.
• Select the filtering parameter to set up a denial of service to block potential hostile attacks. Traffic sent
to or from a filtered MAC address is dropped. Select the bridging parameter for regular traffic flow to
or from the MAC address.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 4-7
mac-learning static mac-address Source Learning Commands

• The destination MAC addresses are maintained in the Source Learning MAC address table.

• If a packet received on a port associated with the same VLAN contains a source address that matches a
static MAC address, then the packet is discarded.

Examples
-> mac-learning vlan 10 port 1/1/10 static mac-address 00:00:39:59:f1:0c bridging
-> mac-learning vlan 20 linkagg 5 static mac-address 00:00:9a:55:e0:01 filtering
-> mac-learning flush vlan 500 static
-> mac-learning flush vlan 10 port 1/1/10 static mac-address 00:00:39:59:f1:0c
-> mac-learning flush vlan 20 linkagg 5 static
-> mac-learning flush static

Release History
Release 8.1.1; command introduced.

Related Commands

vlan members untagged Assigns ports and link aggregates to a VLAN.

mac-learning multicast mac- Configures a static multicast MAC address and assigns the address to
address one or more egress ports or link aggregates.
show mac-learning Displays Source Learning MAC Address Table information.

MIB Objects
alaSlMacAddressGlobalTable
slOriginId
slServiceId
slMacAddressGbl
slMacAddressGblManagement
slMacAddressGblDisposition

page 4-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Source Learning Commands mac-learning multicast mac-address

mac-learning multicast mac-address

Configures a static multicast MAC address and assigns the address to one or more egress ports. Packets
received on ports associated with the specified VLAN that contain a destination MAC address that
matches the static multicast address are forwarded to the specified egress ports. Static multicast MAC
addresses are maintained in the Source Learning MAC address table.
mac-learning {vlan vlan_id { port chassis/slot/port | linkagg linkagg_id }} multicast mac-address
multicast_address [group group_id]
mac-learning flush [vlan vlan_id [port chassis/slot/port | linkagg linkagg_id ]] multicast [mac-address
multicast_address]

Syntax Definitions

vlan_id VLAN ID number.

chassis The chassis identifier.
slot/port The egress slot and port number that is assigned to the static multicast
MAC address.
linkagg_id Enter a link aggregate ID number. See Chapter 10, “Link Aggregation
Commands.”
multicast_address Enter the destination multicast MAC Address to add to the MAC
Address Table (for example, 01:00:39:59:f1:0c).
group_id This keyword cannot be user defined.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the mac-learning flush command to remove a static multicast MAC address from the Source
Learning MAC Address Table. Note that If no parameters are specified with this command, then all
static multicast addresses are removed.
• Note that a MAC address is considered a multicast MAC address if the least significant bit of the most
significant octet of the address is enabled. For example, MAC addresses with a prefix of 01, 03, 05, 13,
and so on, are multicast MAC addresses.
• If a multicast prefix value is not present, then the address is treated as a regular MAC address and not
allowed when using the mac-learning vlan multicast mac-address command. Also note that
multicast addresses within the following ranges are not supported:
01:00:5E:00:00:00 to 01:00:5E:7F:FF:FF
01:80:C2:XX.XX.XX
33:33:XX:XX:XX:XX

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 4-9
mac-learning multicast mac-address Source Learning Commands

• The configured (static) multicast MAC address is assigned to a fixed switch port or link aggregate ID
and VLAN.
• In addition to configuring the same static multicast address for multiple ports within a given VLAN, it
is also possible to use the same multicast address across multiple VLANs.
• Enter a port number or link aggregate ID that is already associated with the specified VLAN ID. Only
traffic from other ports associated with the same VLAN is directed to the static MAC address port.
• If the configuration snapshot or write memory command is entered after a static multicast MAC
address is configured, the resulting ASCII file or vcboot.cfg file includes the “group group_id” as the
additional syntax for the mac-learning static-multicast command. The “group group_id” indicates
the number of the multicast group that the switch has assigned to the multicast MAC address for the
given VLAN association. Each multicast address – VLAN association is treated as a unique instance
and assigned a group number specific to that instance.
• Note that if the port assigned to a multicast MAC address is down or administratively disabled when
the configuration snapshot or write memory command is used, the multicast MAC address is not
saved to the resulting ASCII file or vcboot.cfg file.

Examples
-> mac-learning vlan 1500 port 1/1/10 multicast mac-address 03:00:00:3a:44:12
-> mac-learning vlan 355 port 4/1/2-10 multicast mac-address 02:00:39:59:f1:0c
-> mac-learning vlan 455 linkagg 10 multicast mac-address 04:00:00:3a:44:13
-> mac-learning flush vlan 500 multicast
-> mac-learning flush vlan 1500 port 1/1/10 multicast mac-address 03:00:00:3a:44:12
-> mac-learning flush vlan 455 linkagg 10 multicast mac-address 04:00:00:3a:44:13
-> mac-learning flush multicast

Release History
Release 8.1.1; command introduced.

Related Commands

vlan members untagged Assigns ports and link aggregates to a VLAN.

mac-learning static mac- Configures a static MAC address and assigns the address to a port or
address link aggregate.
show mac-learning Displays Source Learning MAC Address Table information.

MIB Objects
alaSlMacAddressGlobalTable
slOriginId
slServiceId
slMacAddressGbl
slMacAddressGblManagement
slMacAddressGblDisposition

page 4-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Source Learning Commands mac-learning aging-time

mac-learning aging-time
Configures aging time, in seconds, for static and dynamically learned MAC addresses. When a MAC
address has aged beyond the aging-time value, the MAC address is discarded.
mac-learning aging-time {seconds | default}
no mac-learning aging-time

Syntax Definitions

seconds Aging time value (in seconds). Do not use commas in value.
default The aging time is set to the default value of 300 seconds.

Defaults
By default, the aging time is set to 300 seconds.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the default parameter to set the aging-time back to the default value of 300 seconds.

• The aging time value is a global value that applies to all VLANs. Configuring this value on a per
VLAN basis is not supported.
• Note that an inactive MAC address can take up to twice as long as the aging time value specified to be
removed from the MAC address table. For example, if an aging time of 60 seconds is specified, the
MAC address ages out any time between 60 and 120 seconds of inactivity.
• The MAC address table aging time is also used as the timeout value for the Address Resolution
Protocol (ARP) table. This timeout value determines how long the switch retains dynamically learned
ARP table entries.

Examples
-> mac-learning aging-time 1200
-> mac-learning aging-time default

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 4-11
mac-learning aging-time Source Learning Commands

Related Commands

show mac-learning Displays Source Learning MAC Address Table information.

show mac-learning aging-time Displays the current aging time value for the Source Learning MAC
Address Table.

MIB Objects
slMacAddressAgingTable
slMacAgingValue

page 4-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Source Learning Commands mac-learning mode

mac-learning mode
Specifies the source learning mode for the chassis.
mac-learning mode [centralized | distributed]

Syntax Definitions

centralized Enables centralized MAC source learning mode.

distributed Enables distributed MAC source learning mode.

Defaults
By default, centralized MAC source learning mode is enabled for the chassis.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
After the distributed MAC mode is either enabled or disabled using this command, immediately save the
switch configuration using the write memory command and then reboot the switch.

Examples
-> mac-learning mode centralized
-> mac-learning mode distributed

Release History
Release 8.1.1; command introduced.

Related Commands

show mac-learning mode Displays the current status of the MAC source learning mode.

MIB Objects
slDistributedMacMode

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 4-13
show mac-learning Source Learning Commands

show mac-learning
Displays Source Learning MAC Address Table information for the switch.
show mac-learning [summary | dynamic | static | multicast | bmac] [port chassis/slot/port] [linkagg
agg_id] [mac-address mac_address] [remote [mac-address mac_address]]

Syntax Definitions

summary Displays a summary of all the MAC address information.

dynamic Displays only dynamically learned MAC addresses.
static Displays only static MAC addresses with a permanent status.
multicast Displays only multicast MAC addresses.
bmac Displays only backbone MAC addresses (BMACs). A BMAC is the
bridge MAC address of a Shortest Path Bridging (SPB) switch.
chassis The chassis identifier.
slot/port The slot and port number.
agg_id The link aggregate ID number.
mac_address A MAC Address (for example, 00:00:39:59:f1:0c).

Defaults
By default, information is displayed for all MAC addresses contained in the table.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If a static MAC address is configured on a port link that is down or disabled, an asterisk appears to the
right of the MAC address in the show mac-learning command display. The asterisk indicates that this
is an invalid MAC address. When the port link comes up, however, the MAC address is then
considered valid and the asterisk no longer appears next to the address in the display.
• If there is a duplicate static MAC address occurence, a “&” will appear to the right of the address in the
show mac-learning command display.

page 4-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Source Learning Commands show mac-learning

Examples
-> show mac-learning summary
Mac Address Table Summary:

Domain Static Static-Multicast Bmac Dynamic

------------+------------+-------------------+------------+------------
VLAN 0 0 12 12
VPLS 0 0 0 0
SPB 0 0 0 6
EVB 0 0 0 0

Total MAC Address In Use = 30

-> show mac-learning

Legend: Mac Address: * = address not valid,

Mac Address: & = duplicate static address,

Domain Vlan/SrvcId/ISId Mac Address Type Operation Interface

-------+----------------+------------------+-----------+----------+----------------
VLAN 10 e8:e7:32:11:d4:78 dynamic bridging 1/1/14
VLAN 52 e8:e7:32:42:e0:4d dynamic bridging 1/5/3
VLAN 60 e8:e7:32:40:10:7e dynamic bridging 1/5/14
VLAN 60 e8:e7:32:00:24:a5 dynamic bridging 0/1
VLAN 60 e8:e7:32:00:24:b3 dynamic bridging 0/1
VLAN 60 e8:e7:32:6c:5c:de dynamic bridging 0/92
VLAN 100 e8:e7:32:42:e0:4d dynamic bridging 0/98
VLAN 108 e8:e7:32:42:d8:6d dynamic bridging 0/16
VLAN 208 e8:e7:32:42:e0:dd dynamic bridging 0/15
VLAN 1000 e8:e7:32:00:27:e1 dynamic bridging 1/1/14
VLAN 1000 e8:e7:32:00:27:ee dynamic bridging 1/1/14
VLAN 1000 e8:e7:32:40:10:7e dynamic bridging 1/1/14
VLAN 4000 e8:e7:32:00:27:e1 bmac bridging 1/5/14
VLAN 4000 e8:e7:32:40:10:7e bmac bridging 1/5/14
VLAN 4000 e8:e7:32:00:24:a5 bmac bridging 0/1
VLAN 4000 e8:e7:32:6c:5c:de bmac bridging 0/91
VLAN 4051 e8:e7:32:00:27:e1 bmac bridging 1/5/14
VLAN 4051 e8:e7:32:40:10:7e bmac bridging 1/5/14
VLAN 4051 e8:e7:32:00:24:a5 bmac bridging 0/1
VLAN 4051 e8:e7:32:6c:5c:de bmac bridging 0/91
VLAN 4052 e8:e7:32:00:27:e1 bmac bridging 1/5/14
VLAN 4052 e8:e7:32:40:10:7e bmac bridging 1/5/14
VLAN 4052 e8:e7:32:00:24:a5 bmac bridging 0/1
VLAN 4052 e8:e7:32:6c:5c:de bmac bridging 0/91
SPB 1000:1000 e8:e7:32:11:db:72 dynamic servicing sap:1/1/13:1000
SPB 1000:1000 e8:e7:32:40:10:7e dynamic servicing sdp:32867:1000
SPB 1000:1000 e8:e7:32:00:27:e1 dynamic servicing sdp:32904:1000
SPB 1000:1000 e8:e7:32:00:27:ee dynamic servicing sdp:32904:1000
SPB 3899:3899 e8:e7:32:42:e0:4d dynamic servicing sap:0/99:99
SPB 3899:3899 e8:e7:32:42:e0:5c dynamic servicing sap:0/99:99

Total number of Valid MAC addresses above = 30

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 4-15
show mac-learning Source Learning Commands

-> show mac-learning bmac

Legend: Mac Address: * = address not valid,

Mac Address: & = duplicate static address,

Domain Vlan/SrvcId/ISId Mac Address Type Operation Interface

-------+----------------+------------------+-----------+----------+----------------
VLAN 4000 e8:e7:32:00:27:e1 bmac bridging 1/5/14
VLAN 4000 e8:e7:32:40:10:7e bmac bridging 1/5/14
VLAN 4000 e8:e7:32:00:24:a5 bmac bridging 0/1
VLAN 4000 e8:e7:32:6c:5c:de bmac bridging 0/91
VLAN 4051 e8:e7:32:00:27:e1 bmac bridging 1/5/14
VLAN 4051 e8:e7:32:40:10:7e bmac bridging 1/5/14
VLAN 4051 e8:e7:32:00:24:a5 bmac bridging 0/1
VLAN 4051 e8:e7:32:6c:5c:de bmac bridging 0/91
VLAN 4052 e8:e7:32:00:27:e1 bmac bridging 1/5/14
VLAN 4052 e8:e7:32:40:10:7e bmac bridging 1/5/14
VLAN 4052 e8:e7:32:00:24:a5 bmac bridging 0/1
VLAN 4052 e8:e7:32:6c:5c:de bmac bridging 0/91

Total number of Valid MAC addresses above = 12

output definitions
Domain The domain in which the MAC address was learned or statically
configured (VLAN, SPB, EVB, VPLS). Note that VPLS is currently
not supported.
Vlan/ServcId/ISId The VLAN ID number associated with the MAC address in the VLAN
domain or the SPB service and ISID number associated with the MAC
address in the SPB domain.
Mac Address MAC address that is currently learned or statically assigned.
Type MAC address management status (dynamic, static, bmac).
Operation The disposition of the MAC address (bridging, filtering, servicing).
Interface The port number that is associated with the static or dynamically
learned MAC address. If the interface is a link aggregate ID, zero is
displayed as the slot number (for example, 0/29). In the SPB domain,
this field displays the service access point (SAP) associated with the
MAC address.

Release History
Release 8.1.1; command introduced.

page 4-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Source Learning Commands show mac-learning

Related Commands

show mac-learning domain Displays MAC Address Table information for a specific source
learning domain.
show mac-learning aging-time Displays the current aging time value for the Source Learning MAC
Address Table.

MIB Objects
alaSlMacAddressGlobalTable
slMacDomain
slLocaleType
slOriginId
slServiceId
slSubId
slMacAddressGbl
slMacAddressGblManagement
slMacAddressGblDisposition
slMacAddressGblRowStatus
slMacAddressGblGroupField
slSvcISID

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 4-17
show mac-learning domain Source Learning Commands

show mac-learning domain

Displays MAC Address Table information for a specific source learning domain.
show mac-learning domain {all | vlan | spb | evb | vpls} [summary]
show mac-learning domain vlan [vlan vlan_id] [port chassis/slot/port | linkagg agg_id] [dynamic |
static | static-multicast | bmac] [mac-address mac_address]
show mac-learning domain spb [isid instance_id | serviceid service_id [isid instance_id]] [sap chassis/
slot/port:encap | mesh-sdp mesh_id] [dynamic | static] [mac-address mac_address]
show mac-learning evb [serviceid service_id] [sap chassis/slot/port:encap] [dynamic | static]
[mac-address mac_address]

Syntax Definitions

all Selects all learning domains.

vlan Selects the VLAN domain.
spb Selectes the Shortest Path Bridging (SPB) service domain.
evb Selectes the Edge Virtual Bridging (EVB) service domain. EVB does not
support services at this time.
vpls Virtual LAN Service (VPLS) domain. The VPLS feature is not
supported at this time.
summary Displays a summary count of the MAC addresses known to the MAC
address table for the specified domain.
vlan_id VLAN ID number.
chassis The chassis identifier.
slot/port The slot and port number that is assigned to the static MAC address.
agg_id A link aggregate ID number.
instance_id A service instance identifier (I-SID) that is used to identify the SPB
service in a provider backbone bridge (PBB) network. The valid range is
256–16777214.
service_id An existing SPB service ID (EVB services not supported).
slot/port:encap The SPB access port and encapsulation (0, all, qtag, or
outer_qtag.inner_qtag) for a SPB service access point (SAP).
mesh_id A SPB service distribution point (SDP) ID.
dynamic Displays dynamically learned MAC addresses.
static Displays static MAC addresses with a permanent status.
static-multicast Displays static multicast MAC addresses. This parameter applies only to
the VLAN domain.
bmac Displays backbone MAC addresses (BMACs). A BMAC is the bridge
MAC address of a SPB switch. This parameter applies only to the
VLAN domain.
mac_address A MAC Address (for example, 00:00:39:59:f1:0c).

page 4-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Source Learning Commands show mac-learning domain

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If a static MAC address is configured on a port link that is down or disabled, an asterisk appears to the
right of the MAC address in the show mac-learning command display. The asterisk indicates that this
is an invalid MAC address. When the port link comes up, however, the MAC address is then
considered valid and the asterisk no longer appears next to the address in the display.
• If there is a duplicate static MAC address occurence, a “&” will appear to the right of the address in the
show mac-learning command display.

Examples
-> show mac-learning domain spb summary
Mac Address Table Summary:

Domain Static Static-Multicast Bmac Dynamic

------------+------------+-------------------+------------+------------
SPB 0 0 0 6

Total MAC Address In Use = 6

-> show mac-learning domain spb

Legend: Mac Address: * = address not valid,

Mac Address: & = duplicate static address,

Domain Vlan/SrvcId/ISId Mac Address Type Operation Interface

-------+----------------+------------------+-----------+----------+----------------
SPB 1000:1000 e8:e7:32:11:db:72 dynamic servicing sap:1/1/13:1000
SPB 1000:1000 e8:e7:32:40:10:7e dynamic servicing sdp:32867:1000
SPB 1000:1000 e8:e7:32:00:27:e1 dynamic servicing sdp:32904:1000
SPB 1000:1000 e8:e7:32:00:27:ee dynamic servicing sdp:32904:1000
SPB 3899:3899 e8:e7:32:42:e0:4d dynamic servicing sap:0/99:99
SPB 3899:3899 e8:e7:32:42:e0:5c dynamic servicing sap:0/99:99

Total number of Valid MAC addresses above = 6

-> show mac-learning domain spb serviceid 3899

Legend: Mac Address: * = address not valid,

Mac Address: & = duplicate static address,

Domain Vlan/SrvcId/ISId Mac Address Type Operation Interface

-------+----------------+------------------+-----------+----------+----------------
SPB 3899:3899 e8:e7:32:42:e0:4d dynamic servicing sap:0/99:99
SPB 3899:3899 e8:e7:32:42:e0:5c dynamic servicing sap:0/99:99

Total number of Valid MAC addresses above = 2

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 4-19
show mac-learning domain Source Learning Commands

-> show mac-learning domain vlan summary

Mac Address Table Summary:

Domain Static Static-Multicast Bmac Dynamic

------------+------------+-------------------+------------+------------
VLAN 0 0 12 14

Total MAC Address In Use = 26

-> show mac-learning domain vlan bmac

Legend: Mac Address: * = address not valid,

Mac Address: & = duplicate static address,

Domain Vlan/SrvcId/ISId Mac Address Type Operation Interface

-------+----------------+------------------+-----------+----------+----------------
VLAN 4000 e8:e7:32:00:27:e1 bmac bridging 1/5/14
VLAN 4000 e8:e7:32:40:10:7e bmac bridging 1/5/14
VLAN 4000 e8:e7:32:00:24:a5 bmac bridging 0/1
VLAN 4000 e8:e7:32:6c:5c:de bmac bridging 0/91
VLAN 4051 e8:e7:32:00:27:e1 bmac bridging 1/5/14
VLAN 4051 e8:e7:32:40:10:7e bmac bridging 1/5/14
VLAN 4051 e8:e7:32:00:24:a5 bmac bridging 0/1
VLAN 4051 e8:e7:32:6c:5c:de bmac bridging 0/91
VLAN 4052 e8:e7:32:00:27:e1 bmac bridging 1/5/14
VLAN 4052 e8:e7:32:40:10:7e bmac bridging 1/5/14
VLAN 4052 e8:e7:32:00:24:a5 bmac bridging 0/1
VLAN 4052 e8:e7:32:6c:5c:de bmac bridging 0/91

Total number of Valid MAC addresses above = 12

output definitions
Domain The domain in which the MAC address was learned or statically
configured (VLAN, SPB, EVB, VPLS). Note that VPLS is not
supported at this time.
Vlan/ServcId/ISId The VLAN ID number associated with the MAC address in the VLAN
domain or the SPB service and ISID number associated with the MAC
address in the SPB domain.
Mac Address MAC address that is currently learned or statically assigned.
Type MAC address management status (dynamic, static, bmac).
Operation The disposition of the MAC address (bridging, filtering, servicing).
Interface The port number that is associated with the static or dynamically
learned MAC address. If the interface is a link aggregate ID, zero is
displayed as the slot number (for example, 0/29). In the SPB domain,
this field displays the service access point (SAP) associated with the
MAC address.

Release History
Release 8.1.1; command introduced.

page 4-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Source Learning Commands show mac-learning domain

Related Commands

show mac-learning Displays Source Learning MAC Address Table information for the
switch.
show mac-learning aging-time Displays the current aging time value for the Source Learning MAC
Address Table.

MIB Objects
alaSlMacAddressGlobalTable
slMacDomain
slLocaleType
slOriginId
slServiceId
slSubId
slMacAddressGbl
slMacAddressGblManagement
slMacAddressGblDisposition
slMacAddressGblRowStatus
slMacAddressGblGroupField
slSvcISID

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 4-21
show mac-learning remote Source Learning Commands

show mac-learning remote

Note: This command is not supported in this release.

Displays Source Learning MAC Address Table information for devices learned on a fixed port connected
to the remote (peer) switch in a Multi-Chassis Link Aggregation (MCLAG) network configuration.
show mac-learning [summary | dynamic | multicast | static | bmac] remote [mac-address mac_ad-
dress]
show mac-learning domain vlan [vlan vlan_id [-vlan_id2]] remote [summary | dynamic | static-multi-
cast | static | bmac] [mac-address mac_address]

Syntax Definitions

summary Displays a summary of remote permanent (static), dynamic, and static

multicast MAC address information.
multicast Display all the static multicast MAC addresses information contained in
the MAC address table.
static Display static MAC addresses with a permanent status.
dynamic Display dynamically learned MAC addresses.
vlan_id [-vlan_id2] VLAN ID number. Use a hyphen to specify a range of VLAN ID
numbers (1-20).
mac_address MAC Address (for example, 00:00:39:59:f1:0c).

Defaults
By default, information is displayed for all remote MAC addresses contained in the table.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If a static MAC address is configured on a port link that is down or disabled, an asterisk appears to the
right of the MAC address in the show mac-learning command display. The asterisk indicates that this
is an invalid MAC address. When the port link comes up, however, the MAC address is then
considered valid and the asterisk no longer appears next to the address in the display.
• If there is a duplicate static MAC address occurence, a “&” will appear to the right of the address in the
show mac-learning command display.

Examples
-> show mac-learning summary remote
Mac Address Table Summary:

Domain Static Static-Multicast Bmac Dynamic

------------+------------+-------------------+------------+------------
VLAN 0 0 12 3

page 4-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Source Learning Commands show mac-learning remote

VPLS 0 0 0 0
SPB 0 0 0 0
EVB 0 0 0 0

Total MAC Address In Use = 15

-> show mac-learning remote

Legend: Mac Address: * = address not valid,

Mac Address: & = duplicate static address,

Domain Vlan/SrvcId/ISId Mac Address Type Operation Interface

---------+----------------+------------------+-----------+-----------+-------------
VLAN 1 e8:e7:32:11:ce:b1 dynamic bridging remote
VLAN 1 e8:e7:32:11:cd:c0 dynamic bridging remote
VLAN 1 e8:e7:32:11:cd:c3 dynamic bridging remote
VLAN 1000 e8:e7:32:11:ce:a9 bmac bridging remote
VLAN 1000 e8:e7:32:11:cb:d9 bmac bridging remote
VLAN 1000 e8:e7:32:11:cd:b9 bmac bridging remote
VLAN 1001 e8:e7:32:11:cb:d9 bmac bridging remote
VLAN 1001 e8:e7:32:11:ce:a9 bmac bridging remote
VLAN 1001 e8:e7:32:11:cd:b9 bmac bridging remote
VLAN 1002 e8:e7:32:11:ce:a9 bmac bridging remote
VLAN 1002 e8:e7:32:11:cb:d9 bmac bridging remote
VLAN 1002 e8:e7:32:11:cd:b9 bmac bridging remote
VLAN 1004 e8:e7:32:11:cb:d9 bmac bridging remote
VLAN 1004 e8:e7:32:11:ce:a9 bmac bridging remote
VLAN 1004 e8:e7:32:11:cd:b9 bmac bridging remote

Total number of Valid MAC addresses above = 15

-> show mac-learning domain vlan vlan 1000 remote

Legend: Mac Address: * = address not valid,

Mac Address: & = duplicate static address,

Domain Vlan/SrvcId/ISId Mac Address Type Operation Interface

---------+----------------+------------------+-----------+-----------+-------------
VLAN 1000 e8:e7:32:11:ce:a9 bmac bridging remote
VLAN 1000 e8:e7:32:11:cb:d9 bmac bridging remote
VLAN 1000 e8:e7:32:11:cd:b9 bmac bridging remote

Total number of Valid MAC addresses above = 4

output definitions
Domain The domain in which the MAC address was learned or statically
configured (VLAN, SPB, EVB, VPLS). Note that this command only
displays VLAN domain MAC addresses known to the peer MCLAG
switch. SPB and EVB information is not included. In addition, VPLS is
not supported at this time.
Vlan/ServcId/ISId The VLAN ID number associated with the MAC address in the VLAN
domain.
Mac Address The remote peer MAC address that is currently learned or statically
assigned.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 4-23
show mac-learning remote Source Learning Commands

output definitions
Type The management status of the remote peer MAC address (dynamic,
static, bmac).
Operation The disposition of the MAC address (bridging or filtering).
Interface In an MCLAG configuration, this field displays remote if the address
was learned on a fixed port of the MCLAG peer switch.

Release History
Release 8.1.1; command introduced.

Related Commands

show mac-learning Displays source learning MAC address table information.

show mac-learning aging-time Displays the current aging time value for the Source Learning MAC
Address Table.

MIB Objects
alaSlMacAddressGlobalTable
slOriginId
slServiceId
slMacAddressGbl
slMacAddressGblManagement
slMacAddressGblDisposition
slMacAddressGblProtocol

page 4-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Source Learning Commands show mac-learning aging-time

show mac-learning aging-time

Displays the current aging time value for the Source Learning MAC Address Table.
show mac-learning aging-time

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Note that the aging time is the same for all VLANs because it is not configurable on a per-VLAN basis.
The aging time value on this platform is a global parameter that applies to all VLANs.

Examples
-> show mac-learning aging-time
Mac Address Aging Time (seconds) = 300

Release History
Release 8.1.1; command introduced.

Related Commands

show mac-learning Displays Source Learning MAC Address Table information.

MIB Objects
slMacAddressAgingTable
slMacAgingValue

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 4-25
show mac-learning learning-state Source Learning Commands

show mac-learning learning-state

Displays the source learning status of a VLAN, port, or link aggregate.
show mac-learning learning-state [vlan vlan[-vlan2] | port chassis/slot/port | linkagg linkagg]

Syntax Definitions

vlan The VLAN ID number.

-vlan2 The last VLAN ID in a range of VLAN IDs.
chassis The chassis identifier.
slot/port The slot number for the module and the physical port number on that
module.
linkagg Specifies the link aggregate identifier.

Defaults
By default, the source learning status for all switch ports and link aggregates is displayed.

Platforms Supported
OmniSwitch

Usage Guidelines
• Use the port or linkagg keywords along with the port ID and link aggregate ID to display the source
learning status for a specific port or link aggregate ID.
• Use the vlan keyword along with the VLAN ID or a range of VLAN IDs to display the source learning
status for the specified VLAN or range of VLANs.
• Output display for a range of port IDs is supported with this command. However, output display for a
range of link aggregate IDs is not supported.
• When the source learning status is configured for a link aggregate ID, it affects all the ports that are
members of the link aggregate. However, the source learning status cannot be configured on individual
ports which are members of the link aggregate.

Example
-> show mac-learning learning-state

port source-learning
-----+----------------
1/1/1 disabled
1/1/2 enabled
1/1/3 disabled

page 4-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Source Learning Commands show mac-learning learning-state

-> show mac-learning learning-state port 1/2

port source-learning
-----+----------------
1/1/2 enabled

-> show mac-learning learning-state linkagg 10

port source-learning
-----+----------------
0/10 disabled

output definitions
port The port number for a switch port or a link aggregate ID number. If the
interface is a link aggregate ID, zero is displayed as the slot number (for
example, 0/29).
source-learning The source learning status of the port or link aggregate (enabled or
disabled). Configured through the mac-learning command.

-> show mac-learning learning-state vlan 1-5

Vlan Learning State

------------+---------------------
1 Enabled
5 Enabled

output definitions
Vlan The VLAN ID numbers of the VLANs that are active.
Learning State The MAC learning state of the VLANs.

Release History
Release 8.1.1; command introduced

Related Commands

mac-learning Configures the status of source MAC address learning on a single

port, a range of ports or on a link aggregate of ports.

MIB Objects
slMacAddressTable
slMacLearningControlTable
slMacLearningControlEntry
slMacLearningControlStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 4-27
show mac-learning mode Source Learning Commands

show mac-learning mode

Displays the current source learning mode (centralized or distributed) for the switch.
show mac-learning mode

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show mac-learning mode
MAC Learning Mode Configuration = CENTRALIZED
New Configured MAC Learning Mode After Reboot = DISTRIBUTED

-> show mac-learning mode

MAC Learning Mode Configuration = DISTRIBUTED

Release History
Release 8.1.1; command introduced.

Related Commands

mac-learning mode Enables or disables the distributed MAC source learning mode.

MIB Objects
slMacAddressTable
slDistributedMacMode

page 4-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Source Learning Commands mac-ping

mac-ping
Configure a MAC address ping for testing Layer 2 connectivity.
mac-ping dst-mac mac vlan vlan-id [priority vlan-priority] [drop-eligible {true | false}] [count count]
[interval delay] [size size] [isid-check isid]

Syntax Definitions

mac The destination MAC address to ping.

vlan-id The VLAN on which the packets will be sent out.Valid range is 1-4094.
vlan-priority Specifies both the internal priority of the Mac ping and the 802.1p value
on the vlan tag header. Valid range is 0-7.
true | false Specifies both the internal drop precedence of the MAC ping and the
CFI bit on the vlan tag header. Default is false.
count The number of packets to send in one ping iteration.Valid range is 1–5.
delay The delay between packets sent during a ping iteration, in milliseconds.
Valid range is from 100 ms to 1000 ms in multiples of 100 ms.
size The size of the ICMP payload to be used for the ping iteration. Valid
range is 32–1500 bytes.
isid A service instance identifier (I-SID) that is used to identify the SPB
service in a provider backbone bridge (PBB) network.

Defaults

parameter default
vlan-priority 0
drop-eligible false
count 5
delay 1000 ms
size 36 bytes

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The timeout for each ping request packet is 1 sec. This value is not configurable.

• Destination MAC cannot be a broadcast, multicast, or NULL address.

Examples
-> mac-ping dst-mac 00:11:11:11:11:11 vlan 10
-> mac-ping dst-mac 00:11:11:11:11:11 vlan 10 count 5 size 100
-> mac-ping dst-mac 00:11:11:11:11:11 vlan 1001 isid-check 1002

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 4-29
mac-ping Source Learning Commands

Release History
Release 8.1.1; command was introduced.

Related Commands

show mac-learning Displays Source Learning MAC Address Table information.

MIB Objects
N/A

page 4-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 5 VLAN Management
Commands

VLAN management software handles VLAN configuration and the reporting of VLAN configuration
changes to other switch tasks. A VLAN defines a broadcast domain that contains physical ports and can
span across multiple switches. All switches contain a default VLAN 1. Physical switch ports are initially
assigned to VLAN 1 until they are statically or dynamically assigned to other VLANs.
This chapter includes descriptions of VLAN management commands used to create, modify or remove
VLANs. These commands allow you to enable or disable Spanning Tree Protocol (STP), add or remove
virtual router interfaces, statically assign physical switch ports to a default VLAN, and display VLAN
configuration information.
MIB information is as follows:
Filename: AlcatelIND1VlanManager.mib
Module: ALCATEL-IND1-VLAN-MGR-MIB
A summary of the available commands is listed here:

vlan
vlan members untagged
vlan members tagged
vlan mtu-ip
show vlan
show vlan members

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 5-1
vlan VLAN Management Commands

vlan
Creates a new VLAN with the specified VLAN ID (VID) and an optional description.
vlan vlan_id [admin-state {enable | disable}] [name description]
no vlan vlan_id

Syntax Definitions

vlan_id A numeric value that uniquely identifies an individual VLAN. This

value becomes the VLAN ID for the new VLAN.
enable Enable VLAN administrative status.
disable Disable VLAN administrative status.
description An alphanumeric string. Optional name description for the VLAN ID.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete a VLAN from the configuration.

• All VLAN ports and routers are detached before the VLAN is removed. If the VLAN deleted is a
default VLAN on the port, the port returns to default VLAN 1.

• If the VLAN deleted is not a default VLAN, then the ports are directly detached from the VLAN.

• A VLAN is not operationally active until at least one of the member ports of the VLAN is active and
can forward traffic.
• Note that specifying multiple VLAN IDs and/or a range of VLAN IDs on the same command line is
allowed. Use a hyphen to indicate a contiguous range of VLAN ID entries (for example, vlan 10-15).
• When a VLAN is administratively disabled, static port assignments are retained but traffic is not
forwarded from these ports.
• The description can be any alphanumeric string. Enclose the description in double quotes if it contains
more than one word with space in between.

Examples
-> vlan 200 name “Corporate VLAN”
-> vlan 720 admin-state disable
-> no vlan 1020

page 5-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Management Commands vlan

Release History
Release 8.1.1; command introduced.

Related Commands

vlan members untagged Statically assigns ports to a VLAN.

show vlan Displays a list of existing VLANs.
show vlan members Displays VLAN port assignments.

MIB Objects
vlanTable
vlanNumber
vlanDescription
vlanAdmStatus
vlanOperStatus
vlanStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 5-3
vlan members untagged VLAN Management Commands

vlan members untagged

Configures a new default VLAN for a single port or an aggregate of ports. The VLAN specified with this
command is referred to as the configured default VLAN for the port.
vlan vlan_id [-vlan_id2] members {port chassis/slot/port[-port1] | linkagg linkagg_id[-linkagg_id2]}
untagged
no vlan vlan_id [-vlan_id2] members {port chassis/slot/port[-port1]| linkagg linkagg_id[-linkagg_id2]}

Syntax Definitions

chassis The chassis identifier.

vlan_id An existing VLAN ID number of the VLAN to assign as the default
VLAN configured for the port.
slot/port[-port1] The slot and port number for the module and the physical port number
linkagg_id[-linkagg_id2] The link aggregate ID number or range of IDs to be assigned to the
specified VLAN.

Defaults
VLAN 1 is the default VLAN for all ports.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a port or link aggregate from its configured default VLAN
and restore VLAN 1 as the default VLAN.
• The VLAN ID and link aggregate ID specified with this command must already exist in the switch
configuration.
• This command configures the port or link aggregate to send and receive untagged packets for the
specified VLAN ID, which becomes the default VLAN of the port.
• Every switch port or link aggregate has only one configured default VLAN. The 802.1Q tagged ports,
however, can have additional VLAN assignments, which are often referred to as secondary VLANs.

Examples
-> vlan 20 members port 4/1/1-24 tagged
-> vlan 20 members linkagg 2-4 untagged
-> no vlan 1-4 members port 4/1/1-24
-> no vlan 20 members linkagg 2-4

Release History
Release 8.1.1; command introduced.

page 5-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Management Commands vlan members untagged

Related Commands

vlan Creates a VLAN.

vlan members tagged Configures a port to accept 802.1q-tagged packets for a specific VLAN.
show vlan Displays list of existing VLANs.
show vlan members Displays VLAN port assignments.

MIB Objects
vpaTable
vpaVlanNumber
vpaIfIndex
vpaType
vpaState
vpaStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 5-5
vlan members tagged VLAN Management Commands

vlan members tagged

Configures a port or link aggregate ID to send and receive 802.1q-tagged packets with the specified
VLAN ID.
vlan vlan_id[-vlan_id2] members {port chassis/slot/port[-port2] | linkagg linkagg_id[-linkagg_id2]}
tagged
no vlan vlan_id[-vlan_id2] members {port chassis/slot/port[-port2] | linkagg linkagg_id[-linkagg_id2]}

Syntax Definitions

vlan_id The VLAN ID number for a preconfigured VLAN that will handle the
802.1Q-tagged traffic for this port. The valid range is 1–4094.
chassis The chassis identifier.
slot The slot number for the 802.1Q tagging.
port The port number for the 802.1Q tagging.
-port2 The last port number in a range of ports.
linkagg_id The link aggregation ID, which allows you to configure 802.1Q tagging
on an aggregate of ports. The valid range is 1 to 31.
-linkagg_id2 The last link aggregate ID in a range.

Defaults
By default, all ports are untagged (they only carry untagged traffic for the default VLAN to which the port
belongs).

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete 802.1Q tagging on a port or an aggregate of ports.

• The VLAN ID and link aggregate ID specified with this command must already exist in the switch
configuration.
• A port or link aggregate cannot be tagged with its own default VLAN ID.

Examples
-> vlan 2 members port 3/1/1 tagged
-> vlan 100 members port 4/1/1-10
-> vlan 100 members linkagg 10
-> vlan 100 members linkagg 1-4
-> no vlan 2 members port 3/1/1

Release History
Release 8.1.1; command introduced.

page 5-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Management Commands vlan members tagged

Related Commands

vlan Creates a VLAN.

vlan members untagged Configures the default VLAN for the specified port or link aggregate.
show vlan members Displays VLAN port assignments.

MIB Objects
qPortVlanTable
qPortVlanSlot
qPortVlanPort
qPortVLanStatus
qPortVlanTagValue
qPortVlanDescription
qAggregateVlanTagValue
qAggregateVlanAggregateId
qAggregateVlanStatus
qAggregateVlanDescription

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 5-7
vlan mtu-ip VLAN Management Commands

vlan mtu-ip
Configures the maximum transmission unit (MTU) packet size allowed for all ports associated with a
VLAN. This value is configured on a per VLAN basis, so all IP interfaces assigned to the VLAN apply the
same MTU value to packets sent on VLAN ports.
vlan vlan_id mtu-ip size

Syntax Definitions

vlan_id An existing VLAN ID number of the VLAN to assign as the default

VLAN configured for the port.
size Packet size value specified in bytes.

Defaults
By default, the MTU size is set to 1500 bytes (the standard Ethernet MTU size).

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The MTU size applies to traffic sent on all switch ports that are associated with the specified VLAN
regardless of the port speed (for example, 10/100 Ethernet, gigabit Ethernet). Therefore, assign only
ports that are capable of handling the MTU size restriction to the VLAN. If the VLAN MTU size is
greater than 1500, do not assign 10/100 Ethernet ports to the VLAN.
• By default, packets that exceed the MTU size are dropped. To enable MTU discovery and
fragmentation, use the icmp type command to enable the “frag needed but DF bit set” control (for
example, icmp type 3 code 4 enable).
• The maximum MTU size value for a VLAN is 9198.

Examples
-> vlan 200 mtu-ip 1280
-> vlan 1503 mtu-ip 9198

Release History
Release 8.1.1; command introduced.

page 5-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Management Commands vlan mtu-ip

Related Commands

vlan Creates a VLAN.

vlan members tagged Configures a port to accept 802.1q-tagged packets for a specific VLAN.
show vlan Displays list of existing VLANs.

MIB objects
vlanTable
vlanMtu

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 5-9
show vlan VLAN Management Commands

show vlan
Displays a list of VLANs configured on the switch.
show vlan [vlan_id]

Syntax Definitions

vlan_id VLAN ID number.

Defaults
By default, a list of all VLANs is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Specify a VLAN ID with this command to display information about a specific VLAN.

• Note that specifying a range of VLAN IDs is also allowed. Use a hyphen to indicate a contiguous range
(for example, show vlan 10-15). Note that only one VLAN entry - a single VLAN ID or a range of
VLAN IDs is allowed with this command. Multiple entries are not accepted.

Examples
-> show vlan

vlan type admin oper ip mtu name

-----+------+-----+-----+-----+-----+------------
1 std Ena Dis Dis 1500 Finance IP
10 unpd Ena Dis Dis 1500 UNP-DYN-VLAN
11 std Ena Dis Dis 1500 VLAN 11
500 fcoe Ena Dis Dis 1500 VLAN 500

output definitions
vlan The numerical VLAN ID. Use the vlan command to create or remove
VLANs.
type The type of VLAN (mtp, ipc, std, vip, unpd, spb, fcoe).
admin VLAN administrative status: Ena specifies that VLAN functions are
enabled; Dis specifies that VLAN functions are disabled. Use the vlan
command to change the VLAN administrative status.
oper VLAN operational status: Ena (enabled) or Dis (disabled). The
operational status remains disabled until an active port is assigned to
the VLAN. When the operational status is enabled, then VLAN
properties (for example router interfaces, Spanning Tree) are applied to
ports and traffic flow. A VLAN must have an enabled administrative
status before it can become operationally enabled.

page 5-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Management Commands show vlan

output definitions (continued)

ip IP router interface status: Ena (IP interface exists for the VLAN) or Dis
(no IP router interface exists for the VLAN). Use the ip interface
command to define an IP router interface for a VLAN.
mtu Maximum Transmission Unit: Size of largest data packet that the
VLAN port can transmit. Configured through the vlan mtu-ip
command.
name The user-defined text description for the VLAN. By default, the VLAN
ID is displayed if the VLAN description is not specified. Configured
through the vlan command.

-> show vlan 10

Name : UNP-DYN-VLAN,
Type : UNP Dynamic Vlan,
Administrative State : enabled,
Operational State : disabled,
IP Router Port : disabled,
IP MTU : 1500

output definitions
Name The user-defined text description for the VLAN. By default, the VLAN
ID is displayed if the VLAN description is not specified.
Type The type of VLAN (Static VLAN, MTP VLAN, MCM IPC, VIP
VLAN, UNP Dynamic VLAN, Backbone VLAN, Fibre Channel
over Ethernet VLAN)
Administrative State VLAN administrative status: enabled VLAN functions are enabled;
disabled specifies that VLAN functions are disabled. Use the vlan
command to change the VLAN administrative status.
Operational State VLAN operational status: Ena (enabled) or Dis (disabled). The
operational status remains disabled until an active port is assigned to
the VLAN. When the operational status is enabled, then VLAN
properties (for example router interfaces, Spanning Tree) are applied to
ports and traffic flow.
IP Router Port IP router port status: Ena (IP interface exists for the VLAN) or Dis (no
IP router interface exists for the VLAN). Use the ip interface
command to define an IP router interface for a VLAN.
IP MTU Maximum Transmission Unit: Size of largest data packet that the
VLAN port can transmit.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 5-11
show vlan VLAN Management Commands

Related Commands

show vlan members Displays VLAN port assignments.

MIB Objects
vlanMgrVlan
vlanTable
vlanNumber
vlanDescription
vlanAdmStatus
vlanOperStatus
vlanStatus

page 5-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Management Commands show vlan members

show vlan members

Displays VLAN port associations (VPAs) for all VLANs, a specific VLAN, or for a specific port.
show vlan [vlan_id [-vlan_id2]] members [port [chassis/slot/port[-port2]| linkagg linkagg_id
[-linkagg_id2]]

Syntax Definitions

vlan_id VLAN ID number.

-vlan_id2 The last VLAN ID in a range of VLAN IDs.
chassis The chassis identifier.
slot/port Enter the slot number for the module and the physical port number on
that module.
linkagg_id Enter the link aggregate ID number to assign to the specified VLAN.
linkagg_id2 The last link aggregate ID in a range of IDs to be assigned to a specified
VLAN.

Defaults
If no parameters are specified with this command, a list of all VLANs and their assigned ports is displayed
by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the vlan_id is specified without a slot/port or linkagg_id, then all port assignments for that VLAN
are displayed.
• If the slot/port or linkagg_id is specified without a vlan_id, then all VLAN assignments for that port
are displayed.
• If both the vlan_id and slot/port or linkagg_id are specified, then information only for that VLAN and
slot/port or link aggregate ID is displayed.
• Note that specifying a range of VLAN IDs is also allowed. Use a hyphen to indicate a contiguous
range (for example, show vlan 10-15 port). Note that only one VLAN entry - a single VLAN ID or a
range of VLAN IDs is allowed with this command. Multiple entries are not accepted.
• The following types of VPAs may appear in the “type” field based on the switch configuration:

VPA Type Description

default Statically configured default VLAN assignment for the port.
qtagged Statically configured 802.1Q tagged secondary VLAN assignment
for the port.
dynamic VPA created dynamically as learned by MVRP.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 5-13
show vlan members VLAN Management Commands

VPA Type Description

mirror Port is mirroring the VLAN assignment of another port created
according to rules/policies.
mirrored VPA created dynamically for remote port mirroring.
spb Port is associated with a Shortest Path Bridging (SPB) Backbone
VLAN (BVLAN). When a port is configured as an SPB interface,
the port is dynamically assigned to all BVLANs in the switch
configuration.
UNP Untagged Untagged VPA created dynamically for UNP.
UNP QTagged 802.1Q tagged VPA created dynamically for UNP.

Examples
-> show vlan members
vlan port type status
+-----+-------+---------+------------+
1 1/1/1 default inactive
2 1/1/2 default blocking
3 1/1/2 qtagged blocking
4 2/1/5 dynamic forwarding

-> show vlan 10 members

port type status
+------+--------+------------+
1/1/1 default forwarding
1/1/2 qtagged forwarding

-> show vlan members port 3/1/2

vlan type status
+------+---------+------------+
1 default forwarding
2 qtagged forwarding
5 dynamic blocking
3 qtagged blocking

-> show vlan 1-11 members port 1/1/3

type : default,
status : inactive,
vlan admin : enabled,
vlan oper : disabled,

output definitions
vlan Numerical VLAN ID. Identifies the VLAN assignment of the port.
port The slot number for the module and the physical port number on that
module.
type The type of VPA: default (configured default VLAN assignment for
the port), qtagged (802.1Q-tagged secondary VLAN assignment for
the port), mirror (port is mirroring the VLAN assignment of another
port), dynamic (dynamically configured VLAN assignment for the
port).

page 5-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Management Commands show vlan members

output definitions
status The VPA status: inactive (port is not active), forwarding (traffic is
forwarding on this VPA), blocking (traffic is not forwarding on this
VPA)
vlan admin VLAN administrative status: enabled enables VLAN functions to
operate; disabled disables VLAN functions without deleting the
VLAN. Use the vlan command to change the VLAN administrative
status.
vlan oper VLAN operational status: enabled or disabled. The operational status
remains disabled until an active port is assigned to the VLAN. When
the operational status is enabled, then VLAN properties (for example
router interfaces, Spanning Tree) are applied to ports and traffic flow. A
VLAN must have an enabled administrative status before it can become
operationally enabled.

Release History

Release 8.1.1; command introduced.

Related Commands

show vlan Displays list of VLANs configured on the switch.

show ip interface Displays IP router information.

MIB Objects
vlanMgrVpa
vpaTable
vpaVlanNumber
vpaIfIndex
vpaType
vpaState
vpaStatus
vlanMgrVlan
vlanTable
vlanAdmStatus
vlanOperStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 5-15
show vlan members VLAN Management Commands

page 5-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 6 High Availability VLAN
Commands

High availability (HA) VLANs send traffic intended for a single destination MAC address to multiple
switch ports. The OmniSwitch HA VLAN feature provides an elegant and flexible way to connect server
cluster nodes directly to the ingress network. This involves multicasting the service requests on the config-
ured ports. The multicast criteria is configurable based on destination MAC and destination IP address.
Egress ports can be statically configured on a server cluster or they can be registered by IGMP reports.
The HA VLAN server cluster feature multicasts the incoming packets based on the server cluster configu-
ration on the ports associated with the server cluster.
An HAVLAN is configured by specifying the match criteria, a VLAN and a port list. Match criteria is
used to identify the incoming traffic that has to be processed by the HA VLAN server-clusters. The speci-
fied VLAN is an ingress and egress VLAN in the case of a L2 server-cluster. In the case of a L3 server-
cluster, the VLAN is not configured explicitly, but the IP address specified in the match criteria deter-
mines the VLAN. The port list specifies the egress switch ports within the VLAN. The cluster is connected
to these switch ports.
There are typically two modes of implementation of server clusters in HA VLAN.
Layer 2 - The server cluster is attached to a L2 switch on which the frames destined to the cluster MAC
address are to be flooded on all interfaces.
Layer 3 - The server cluster is attached to a L3 switch on which the frames destined to the server cluster
IP address are to be routed to the server cluster IP and then flooded on all interfaces.
For more information, see the application examples in Chapter 28, “Configuring High Availability
VLANs” in the OmniSwitch AOS Release 8 Network Configuration Guide.
MIB information is as follows:
Filename: AlcatelIND1VlanManager.mib
Module: ALCATEL-IND1-VLAN-MGR-MIB
Filename: AlcatelIND1MacAddress.mib
Module: ALCATEL-IND1-MAC-ADDRESS-MIB
A summary of the available commands is listed here:

server-cluster
server-cluster vlan
server-cluster mac-address
server-cluster ip
server-cluster igmp mode
server-cluster ip-multicast
server-cluster port
show server-cluster

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 6-1
server-cluster High Availability VLAN Commands

server-cluster
Configures a cluster with an ID, name, mode and the administrative state.
server-cluster cluster-id [name cluster-name] [mode {L2 | L3}] [admin-state {enable|disable}]
no server-cluster cluster-id

Syntax Definitions

cluster-id A numerical identifier of the cluster. The valid range is 1–32.

cluster-name Specifies a name (up to 32 characters) to represent the cluster.
L2 Specifies L2 for the cluster mode.
L3 Specifies L3 for the cluster mode.
enable Enables the administrative state of the cluster.
disable Disables the administrative state of the cluster.

Defaults

parameter default
mode L2
admin-state enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use no form of this command to remove the cluster ID from the switch configuration.

• Once the cluster mode is set, the mode cannot be changed.

• Use the admin-state disable parameter option to disable an existing cluster before attempting to
modify any of the cluster parameters.

Examples
-> server-cluster 1
-> server-cluster 1 mode l2
-> server-cluster 1 name l2_cluster mode l2
-> server-cluster 2 name l3_cluster mode l3
-> no server-cluster 1

Release History
Release 8.1.1; command was introduced.

page 6-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
High Availability VLAN Commands server-cluster

Related Commands

vlan Creates and deletes VLANs.

server-cluster mac-address Configures a MAC address, VLAN of the specified cluster.
server-cluster port Configures the specified IP, ARP entry to a given cluster and/or a multi-
cast IP.
show server-cluster Displays the clusters configured in the system.

MIB Objects
alaHAVlanClusterTable
alaHAVlanClusterId
alaHAVlanClusterName
alaHAVlanClusterAdminStatus
alaHAVlanClusterMode
alaHAVlanClusterRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 6-3
server-cluster vlan High Availability VLAN Commands

server-cluster vlan
Configures a VLAN assignment for the specified cluster. This command is used to assign VLANs to an L2
cluster.
server-cluster cluster-id vlan vlan_id

Syntax Definitions

cluster-id The numerical identifier of an existing server cluster.

vlan_id The VLAN identifier to assign to the cluster. The valid range is 1–4094.

Defaults
NA

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The cluster ID specified with this command must already exist in the switch configuration.

• If the specified VLAN ID does not exist in the switch configuration, the cluster will remain operation-
ally disabled.
• Modifying the existing VLAN assignment for a cluster is only allowed when the cluster is administra-
tively disabled.

Examples
-> server-cluster 1 vlan 10
-> server-cluster 5 vlan 10
-> server-cluster 6 mac-address 00 :11 :22 :33 :44 :55

Release History
Release 8.1.1; command was introduced.

page 6-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
High Availability VLAN Commands server-cluster vlan

Related Commands

server-cluster ip Configures the specified IP, ARP entry to a given cluster.

server-cluster port Configures the specified IP, ARP entry to a given cluster and/or a multi-
cast IP.
show server-cluster Displays the clusters configured in the system.
show mac-learning Displays Source Learning MAC Address Table information.

MIB Objects
alaHAVlanClusterTable
alaHAVlanClusterId
alaHAVlanClusterVlan
alaHAVlanClusterMacAddress
alaHAVlanClusterRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 6-5
server-cluster mac-address High Availability VLAN Commands

server-cluster mac-address
Configures a MAC address assignment for the specified cluster. This command is used to assign a MAC
address to an L2 cluster.
server-cluster cluster-id mac-address mac-address

Syntax Definitions

cluster-id The numerical identifier of an existing server cluster.

mac-address The MAC address of the cluster.

Defaults
NA

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The cluster ID specified with this command must already exist in the switch configuration.

• Modifying the existing MAC address assignment for a cluster is only allowed when the cluster is
administratively disabled.
• The MAC address that is assigned to a cluster can be a unicast, L2 multicast, or IP multicast address.
However reserved multicast MAC addresses cannot be assigned to the cluster.

Examples
-> server-cluster 1 vlan 10 mac-address 00 :11 :22 :33 :44
-> server-cluster 5 vlan 10
-> server-cluster 5 mac-address 01:
-> server-cluster 6 mac-address 00 :11 :22 :33 :44 :55

Release History
Release 8.1.1; command was introduced.

page 6-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
High Availability VLAN Commands server-cluster mac-address

Related Commands

server-cluster ip Configures the specified IP, ARP entry to a given cluster.

server-cluster port Configures the port or linkagg to be assigned to a specific cluster.
show server-cluster Displays the clusters configured in the system.
show mac-learning Displays Source Learning MAC Address Table information.

MIB Objects
alaHAVlanClusterTable
alaHAVlanClusterId
alaHAVlanClusterVlan
alaHAVlanClusterMacAddress
alaHAVlanClusterRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 6-7
server-cluster ip High Availability VLAN Commands

server-cluster ip
Configures an IP address and ARP entry for the specified cluster. This command is used to assign an IP
address to an L3 cluster.
server-cluster cluster-id ip ip-address [ mac-address {static mac-address | dynamic}]

Syntax Definitions

cluster-id The numerical identifier of an existing server cluster.

ip-address The unicast IP address to assign to the cluster.
mac-address The MAC address for the static ARP entry.
dynamic Dynamically resolve the ARP entry for the cluster.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The cluster ID specified with this command must already exist in the switch configuration.

• A cluster can be assigned an IP address an ARP entry MAC address. Each cluster should have a unique
IP address.
• Reserved MAC address cannot be configured as an ARP.

• Modifying the existing IP address parameters for a cluster is only allowed when the cluster is adminis-
tratively disabled.

Examples
-> server-cluster 1 ip 10.135.33.203 mac-address static 00 :11 :22 :33 :44
-> server-cluster 3 ip 10.135.33.205 mac-address dynamic
-> server-cluster 5 ip 10.135.33.207
-> server-cluster 6 mac-address dynamic
-> server-cluster 7 mac-address static 00 :11 :22 :33 :44

Release History
Release 8.1.1; command was introduced.

page 6-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
High Availability VLAN Commands server-cluster ip

Related Commands

server-cluster mac-address Configures a MAC address of the specified cluster.

server-cluster port Configures the port or linkagg to be assigned to a specific cluster.
show server-cluster Displays the clusters configured in the system.

MIB Objects
alaHAVlanClusterTable
alaHAVlanClusterId
alaHAVlanClusterIfIndex
alaHAVlanClusterInetAddressType
alaHAVlanClusterInetAddress
alaHAVlanClusterMacAddressType
alaHAVlanClusterMacAddress
alaHAVlanClusterMulticastStatus
alaHAVlanClusterMulticastInetAddressType
alaHAVlanClusterMulticastInetAddress
alaHAVlanClusterRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 6-9
server-cluster igmp mode High Availability VLAN Commands

server-cluster igmp mode

Configures the IGMP mode status for specified cluster.
server-cluster cluster-id igmp-mode {enable | disable}

Syntax Definitions

cluster-id The numerical identifier of an existing server cluster.

enable Enables IGMP mode for cluster ports.
disable Disables IGMP mode for cluster ports.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The cluster ID specified with this command must already exist in the switch configuration.

• When the IGMP mode is enabled for the cluster, the port list is dynamically learned using the IGMP
protocol for the configured IP multicast address.
• For HA VLAN IGMP to work, IGMP must be enabled globally on the switch using the command ip
multicast admin-state enable command.

Examples
-> server-cluster 4 igmp-mode enable
-> server-cluster 4 igmp-mode disable

Release History
Release 8.1.1; command was introduced.

Related Commands

server-cluster ip Configures the specified IP, ARP entry to a given cluster.

show server-cluster Displays the clusters configured in the system.

page 6-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
High Availability VLAN Commands server-cluster igmp mode

MIB Objects
alaHAVlanClusterTable
alaHAVlanClusterId
alaHAVlanClusterIfIndex
alaHAVlanClusterInetAddressType
alaHAVlanClusterInetAddress
alaHAVlanClusterMacAddressType
alaHAVlanClusterMacAddress
alaHAVlanClusterMulticastStatus
alaHAVlanClusterMulticastInetAddressType
alaHAVlanClusterMulticastInetAddress
alaHAVlanClusterRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 6-11
server-cluster ip-multicast High Availability VLAN Commands

server-cluster ip-multicast
Configures a multicast IP address for the specified cluster. This command configures an IP multicast
address for an L3 cluster.
server-cluster cluster-id ip-multicast ipm-address

Syntax Definitions

cluster-id The numerical identifier of an existing server cluster.

ipm-address The multicast IP address to assign to the cluster.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The cluster ID specified with this command must already exist in the switch configuration.

• A cluster can be assigned an IP address an ARP entry MAC address. Each cluster should have a
uniqueIP-address. IP address is configurable only for L3 clusters
• Cluster parameters like IP, multicast IP and MAC address can be modified only when the cluster admin
status is disabled.

Examples
-> server-cluster 2 ip-multicast 226.0.0.12
-> server-cluster 4 ip-multicast 226.0.0.14

Release History
Release 8.1.1; command was introduced.

Related Commands

server-cluster Configures cluster parameters to create or modify a cluster ID.

show server-cluster Displays the clusters configured in the system.

page 6-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
High Availability VLAN Commands server-cluster ip-multicast

MIB Objects
alaHAVlanClusterTable
alaHAVlanClusterId
alaHAVlanClusterIfIndex
alaHAVlanClusterInetAddressType
alaHAVlanClusterInetAddress
alaHAVlanClusterMacAddressType
alaHAVlanClusterMacAddress
alaHAVlanClusterMulticastStatus
alaHAVlanClusterMulticastInetAddressType
alaHAVlanClusterMulticastInetAddress
alaHAVlanClusterRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 6-13
server-cluster port High Availability VLAN Commands

server-cluster port
Configures a port port assignment for the port list of the specified cluster.
server-cluster cluster-id port {chassis//slot/port[-port2] | all}
no server-cluster cluster-id port {chassis//slot/port[-port2] | all}

Syntax Definitions

chassis The chassis identifier.

cluster-id The numerical identifier of an existing server cluster.
slot/port The slot and port number to assign to the cluster port list. Use a hypen to
specify a range of ports..
all Assigns all of the ports that belong to the associated VLAN and NOT all
ports on the NI. This parameter applies only to L3 clusters.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a port from the specified cluster port list.

• The cluster ID specified with this command must already exist in the switch configuration.

• Using a port list is not valid for a cluster operating with IGMP mode enabled.

• The all parameter does not apply to L2 clusters.

Examples
-> server-cluster 1 port 1/1/21
-> server-cluster 2 port 1/1/21-23
-> server-cluster 5 port all
-> no server-cluster 1 port 1/1/21
-> no server-cluster 2 port 1/1/21-23
-> no server-cluster 3 port all

Release History
Release 8.1.1; command was introduced.

page 6-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
High Availability VLAN Commands server-cluster port

Related Commands

server-cluster Configures cluster parameters to create or modify a cluster ID.

show server-cluster Displays the clusters configured in the system.
show mac-learning Displays Source Learning MAC Address table information.
show vlan Displays a list of existing VLANs.
show vlan members Displays VLAN port assignments.

MIB Objects
alaHAVlanClusterPortTable
alaHAVlanClusterId
alaHAVlanClusterPortIfIndex
alaHAVlanClusterPortRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 6-15
server-cluster linkagg High Availability VLAN Commands

server-cluster linkagg
Configures a link aggregate assignment for the port list of the specified cluster.
server-cluster cluster-id linkagg agg_id[-agg_id2]
no server-cluster cluster-id linkagg agg_id[-agg_id2]}

Syntax Definitions

cluster-id The numerical identifier of an existing server cluster.

agg_id[-agg_id2] The link aggregate ID number to assign to the cluster port list. Use a
hyphen to specify a range of IDs (10-15).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a link aggregate ID from the specified cluster port list.

• The cluster ID and link aggregate ID specified with this command must already exist in the switch
configuration.
• Using a port list is not valid for a cluster operating with IGMP mode enabled.

Examples
-> server-cluster 3 linkagg 1
-> server-cluster 4 linkagg 1-3
-> no server-cluster 3 linkagg 1

Release History
Release 8.1.1; command was introduced.

page 6-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
High Availability VLAN Commands server-cluster linkagg

Related Commands

server-cluster Configures cluster parameters to create or modify a cluster ID.

show server-cluster Displays the clusters configured in the system.
show mac-learning Displays Source Learning MAC Address table information.
show vlan Displays a list of existing VLANs.
show vlan members Displays VLAN port assignments.

MIB Objects
alaHAVlanClusterPortTable
alaHAVlanClusterId
alaHAVlanClusterPortIfIndex
alaHAVlanClusterPortRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 6-17
show server-cluster High Availability VLAN Commands

show server-cluster
Displays the cluster configuration information for the switch.
show server-cluster [cluster-id [port]]

Syntax Definitions

cluster-id The numerical identifier of an existing server cluster.

port Displays the ports and/or link aggregates assigned to a specific cluster.

Defaults
Displays a list of all server clusters configured for the switch.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Specify a cluster ID with this command to display information for a single cluster.

• Use the port parameter with the cluster-id parameter to display information about the ports assigned to
the specified cluster.
• An asterisk (*) is displayed to indicate invalid cases, as shown in the command example.

Examples
-> show server-cluster
Legend: * = not valid

Cluster Mode Vlan Mac Address Ip Address IGMP Address Name

---------+-----+-----+-------------------+---------------+-------------+-----------
* 10 L2 100 01:10:11:22:33:44 - - cluster1
11 L2 100 01:10:11:22:33:44 - - cluster2
12 L2 100 01:10:11:22:33:44 - - -
13 L3 - 01:12:11:22:33:44 10.135.33.203 - -
* 14 L3 - 01:12:11:22:33:45 10.135.33.203 - -
15 L3 - 01:00:5e:00:00:44 10.135.33.203 225.0.1.2 cluster-igmp

-> show server-cluster 10 port

Legend: * = not valid
Cluster Port Port Type
----------+-------+--------------
* 10 1/1/3 Static
10 1/1/21 Static
* 10 0/2 Static

page 6-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
High Availability VLAN Commands show server-cluster

-> show server-cluster 11 port

Legend: * = not valid
Cluster Port Port Type
----------+-------+--------------
10 1/1/3 Dynamic
10 1/1/21 Dynamic
10 0/2 Dynamic

output definitions
Cluster The numerical identifier of a cluster.
Mode Displays the cluster mode as L2 or L3.
Vlan Displays the VLAN identifier of the cluster.
MAC-Address The MAC address associated with the cluster.
IP Address The IP address associated with the cluster.
IGMP Address The IGMP address associated with the cluster.
IGMP-Mode Displays the status of IGMP-mode, Enabled or Disabled.
Name The name representing the cluster.
Port Displays the port list of the cluster.
Port Type Displays the port type, Static or Dynamic.

-> show server-cluster 1

Cluster Id : 1,
Cluster Name : L2-cluster,
Cluster Mode : L2,
Cluster Mac-Address : 01:10:11:22:33:44,
Cluster Vlan : 12,
Administrative State: Enabled,
Operational State : Disabled,
Operational Flag : VPA is not forwarding
Multi-Chassis Status : OutOfSync,
Multi-Chassis OutOfSync Reason : Multi-Chassis Down,
VFL Status : Not-used

-> show server-cluster 2

Cluster Id : 2,
Cluster Name : -,
Cluster Mode : L3,
Cluster IP : 10.135.33.203,
Cluster Mac-Address : 01:10:11:22:33:44,
Cluster Mac Type : Dynamic,
IGMP-Mode : Disabled,
Cluster Multicast IP: -,
Administrative State: Enabled,
Operational State : Enabled,
Operational Flag : -,
Multi-Chassis Status : OutOfSync,
Multi-Chassis OutOfSync Reason : Synch In Progress,
VFL Status : Not-used

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 6-19
show server-cluster High Availability VLAN Commands

-> show server-cluster 3

Cluster Id : 3,
Cluster Name : L3-cluster,
Cluster Mode : L3,
Cluster IP : 10.135.33.203,
Cluster Mac Type : Dynamic,
Cluster Mac-Address : 01:00:5e:00:11:22,
IGMP-Mode : Enabled,
Cluster Multicast IP: 225.0.1.2,
Administrative State: Disabled,
Operational State : Disabled,
Operational Flag : No IGMP reports received
Multi-Chassis Status : InSync,
Multi-Chassis OutOfSync Reason : -,
VFL Status : Used

output definitions
Cluster ID The numerical identifier of a cluster.
Cluster Name The name representing the cluster.
Cluster Mode Displays the cluster mode as L2 or L3.
Cluster IP The IP address associated with the cluster.
Cluster Mac Type The type of cluster, Static or Dynamic.
Cluster Mac-Address The MAC address associated with the cluster.
IGMP-mode Specifies the status of IGMP-mode, Enabled or Disabled.
Cluster Multicast IP The multicast IP address associated with the cluster.
Administrative State Specifies the administrative status of the cluster, Enabled or Disabled.
Operational State Specifies the operational status of the cluster, Enabled or Disabled.
Operational Flag Specifies the reason the cluster is operationally down.
Multi-Chassis Status Note. This field is not supported in this release.
Multi-Chassis OutOfSync Note. This field is not supported in this release.
Reason
VFL Status Note. This field is not supported in this release.

Release History
Release 8.1.1; command was introduced.

Related Commands

show mac-learning Displays Source Learning MAC Address Table information.

show vlan Displays a list of existing VLANs.
show vlan members Displays VLAN port assignments.

page 6-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
High Availability VLAN Commands show server-cluster

MIB Objects
alaHAVlanClusterPortTable
alaHAVlanClusterId
alaHAVlanClusterPortIfIndex
alaHAVlanClusterPortRowStatus
alaHAVlanClusterTable
alaHAVlanClusterId
alaHAVlanClusterInetAddress
alaHAVlanClusterMacAddressType
alaHAVlanClusterMacAddress
alaHAVlanClusterMulticastStatus
alaHAVlanClusterMulticastInetAddress
alaHAVlanClusterVlan
alaHAVlanClusterName
alaHAVlanClusterAdminStatus
alaHAVlanClusterMode
alaHAVlanClusterOperStatus
alaHAVlanClusterOperStatusFlag
alaHAVlanClusterMcmStatus
alaHAVlanClusterMcmStatusFlag
alaHAVlanClusterVflStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 6-21
show server-cluster High Availability VLAN Commands

page 6-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 7 Distributed Spanning
Tree Commands

The Spanning Tree Algorithm and Protocol (STP) is a self-configuring algorithm that maintains a loop-
free topology while providing data path redundancy and network scalability. Based on the IEEE 802.1D
standard, the Alcatel-Lucent STP implementation distributes the Spanning Tree load between the primary
management module and the network interface modules. This functionality improves network robustness
by providing a Spanning Tree that continues to respond to BPDUs and port link up and down states in the
event of a fail over to a backup management module or switch.
In addition to a distributed architecture, this implementation also provides the following Spanning Tree
features:
• Automatic configuration of a physical topology into a single Spanning Tree to ensure that there is only
one data path between any two switches.
• Fault tolerance within the network topology. The Spanning Tree is reconfigured in the event of a data
path or bridge failure or when a new switch is added to the topology.
• Support for four Spanning Tree protocols: 802.1D (STP), 802.1W (RSTP), and 802.1Q 2005 (MSTP).

• A flat Spanning Tree operating mode. If STP or RSTP is used, this mode applies a single STP instance
across all VLANs. If MSTP is used, this mode applies a single STP instance to each Multiple Spanning
Tree Instance (MSTI), which identifies a set of VLANs.
• A per-VLAN Spanning Tree operating mode that applies a single STP instance for each defined VLAN
on the switch.
• An STP topology that includes 802.1Q tagged ports and link aggregate logical ports in the calculation
of the physical topology.
MIB information for Distributed Spanning Tree commands is as follows:
Filename: AlcatelIND1VlanSTP.MIB
Module: STP-MGMT-MIB

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-1
 Distributed Spanning Tree Commands

A summary of the available commands is listed here:

Bridge commands spantree mode

spantree protocol
spantree priority
spantree hello-time
spantree max-age
spantree forward-delay
spantree bpdu-switching
spantree path-cost-mode
spantree vlan admin-state
spantree auto-vlan-containment
show spantree
show spantree cist
show spantree msti
show spantree vlan
show spantree mode
Port commands spantree cist
spantree vlan
spantree priority
spantree cist path-cost
spantree msti path-cost
spantree vlan path-cost
spantree cist mode
spantree loop-guard
spantree cist connection
spantree vlan connection
spantree cist admin-edge
spantree vlan admin-edge
spantree cist auto-edge
spantree vlan auto-edge
spantree cist restricted-role
spantree vlan restricted-role
spantree cist restricted-tcn
spantree vlan restricted-tcn
spantree cist txholdcount
spantree vlan txholdcount
show spantree ports
show spantree cist ports
show spantree msti ports
show spantree vlan ports
MST region commands spantree mst region name
spantree mst region revision-level
spantree mst region max-hops
show spantree mst
MST instance commands spantree msti
spantree msti vlan
show spantree msti vlan-map
show spantree cist vlan-map
show spantree map-msti
PVST+ commands spantree pvst+compatibility

page 7-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree mode

spantree mode
Selects the flat Spanning Tree or per-VLAN Spanning Tree operating mode for the switch. These modes
are exclusive; however, it is not necessary to reboot the switch when the STP modes are changed.
spantree mode {flat | per-vlan}

Syntax Definitions

flat One Spanning Tree instance per switch.

per-vlan One Spanning Tree instance for each VLAN configured on a switch.

Defaults
By default, the Spanning Tree mode for the switch is set to per-VLAN.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The Multiple Spanning Tree Protocol (MSTP), as defined in the IEEE 802.1Q 2005 standard, is only
supported on switches operating in the flat Spanning Tree mode.
• If standard STP or RSTP is used when the switch is running in the flat mode, a single STP instance is
applied across all VLANs. For example, if a port belonging to VLAN 10 and a port belonging to
VLAN 20 connect to the same switch together, then STP blocks one of these ports.
• If MSTP is used when the switch is running in the flat mode, a single STP instance is applied to each
Multiple Spanning Tree Instance (MSTI). Each MSTI represents a set of VLANs.
• Flat Spanning Tree mode supports fixed (untagged) and 802.1Q tagged ports in each VLAN. However,
Bridge Protocol Data Units (BPDUs) are always untagged.
• If the per-VLAN mode is selected, a single Spanning Tree instance is enabled for each VLAN
configured on the switch. For example, if there are five VLANs configured on the switch, then there
are five separate Spanning Tree instances. In essence, a VLAN is a virtual bridge that has its own
bridge ID and configurable STP parameters, such as protocol, priority, hello time, max-age, and
forward delay.
• When operating in per-VLAN mode, 802.1Q tagged ports participate in an 802.1Q Spanning Tree
instance that allows the Spanning Tree to extend across tagged VLANs. As a result, a tagged port can
participate in more than one Spanning Tree instance; one for each VLAN that the port carries.
• If a VLAN contains both fixed and tagged ports and the switch is operating in per-VLAN Spanning
Tree mode, then a hybrid of the two Spanning Tree instances (single and 802.1Q) is applied. If a
VLAN appears as a tag on a port, then the BPDU for that VLAN are also tagged. However, if a VLAN
appears as the configured default VLAN for the port, then BPDU are not tagged and the single
Spanning Tree instance applies.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-3
spantree mode Distributed Spanning Tree Commands

• Regardless of which mode the switch is running in, it is possible to administratively disable the
Spanning Tree status for an individual VLAN (see Chapter 5, “VLAN Management Commands”).

Note. Active ports associated with such a VLAN are excluded from any Spanning Tree calculations
and remain in a forwarding state.

Examples
-> spantree mode flat
-> spantree mode per-vlan

Release History
Release 8.1.1; command introduced.

Related Commands

spantree protocol Selects the Spanning Tree protocol for the specified instance.
spantree bpdu-switching Enables the switching of Spanning Tree BPDU on a VLAN that has
Spanning Tree disabled.
show spantree Displays VLAN Spanning Tree parameter values.

MIB Objects
vStpTable
vStpNumber
vStpMode

page 7-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree protocol

spantree protocol
Configures the Spanning Tree protocol for the flat mode Common and Internal Spanning Tree (CIST)
instance or for an individual VLAN instance.
spantree [cist | vlan vlan_id] protocol {stp | rstp | mstp}

Syntax Definitions

cist The CIST instance (also known as MSTI 0). This parameter is
configurable in both modes (flat or per-VLAN).
vlan_id An existing VLAN ID number. This parameter is configurable in both
modes (flat or per-VLAN).
stp IEEE 802.1D standard Spanning Tree Algorithm and Protocol.
rstp IEEE 802.1W Rapid Spanning Tree Protocol.
mstp IEEE 802.1Q 2005 Multiple Spanning Tree Protocol. This protocol is
not supported on a per-VLAN basis.

Defaults
By default, the Spanning Tree protocol is set to RSTP.

parameter default
cist | vlan vlan_id cist

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the optional cist or vlan parameter is not specified with this command, the protocol is set for the
CIST instance by default. This is true regardless of which mode (flat or per-VLAN) is active.

Note. Selecting MSTP is only an option for the flat mode CIST instance and is required to configure
Multiple Spanning Tree Instances (MSTI).

• MSTP is only active when the switch is operating in the flat Spanning Tree mode. STP and RSTP are
active when the switch is operating in either the flat or per-VLAN Spanning Tree mode.
• Deleting all existing MSTIs is required before changing the protocol from MSTP to STP or RSTP.

Note. When the protocol is changed to/from MSTP, the bridge priority and port path cost values for
the flat mode CIST instance are reset to their default values. However, if the path cost mode was set to
32-bit prior to the protocol change, the path cost is not reset to the default value. See the spantree
path-cost-mode command page for more information.

Examples
-> spantree protocol mstp

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-5
spantree protocol Distributed Spanning Tree Commands

-> spantree cist protocol mstp

-> spantree vlan 5 protocol rstp

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
show spantree Displays the Spanning Tree instance configuration.

MIB Objects
vStpInsTable
vStpInsNumber
vStpInsMode
vStpInsProtocolSpecification

page 7-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree vlan admin-state

spantree vlan admin-state

Enables or disables the Spanning Tree status for a VLAN.
spantree vlan vlan_id [-vlan_id2] admin-state {enable | disable}

Syntax Definitions

vlan_id[-vlan_id2] An existing VLAN ID number. Use a hyphen to specify a range of

VLANs (10-15).
enable Enables Spanning Tree for the specified VLAN.
disable Disables Spanning Tree for the specified VLAN.

Defaults
By default, the Spanning tree status is enabled for a VLAN instance.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
VLAN Spanning Tree instances are only active when the switch is running in the per-VLAN mode.
However, configuring the VLAN Spanning Tree status is allowed in both modes (per-VLAN and flat).

Examples
-> spantree vlan 850-900 admin-state enable
-> spantree vlan 720-750 admin-state disable
-> spantree vlan 500 admin-state disable

Release History
Release 8.1.1; command introduced.

Related Commands

vlan Creates a VLAN.

show vlan Displays a list of existing VLANs.
show vlan members Displays VLAN port assignments.

MIB Objects
vlanTable
vlanNumber
vlanAdmStatus
vlanOperStatus
vlanStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-7
spantree mst region name Distributed Spanning Tree Commands

spantree mst region name

Defines the name for a Multiple Spanning Tree (MST) region. One of three attributes (name, revision
level, and a VLAN to MST instance association table) that defines an MST region as required by the IEEE
802.1Q 2005 standard. Switches that share the same attribute values are all considered part of the same
MST region. Currently each switch can belong to one MST region at a time.
spantree mst region name name
no spantree mst region name

Syntax Definitions

name An alphanumeric string. Use quotes around string if the name contains
multiple words with spaces between them (for example “Alcatel-Lucent
Marketing”).

Defaults
By default, the MST region name is left blank.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to remove the MST region name.

Note. It is not necessary to specify the region name to remove it.

• To change the existing region, use this command with a string value that is different than the existing
region name.
• Specifying an MST region name is allowed regardless of which Spanning Tree operating mode or
protocol is currently active on the switch. However, MST configuration values, such as region name,
only apply when the switch is operating in the flat Spanning Tree mode and using MSTP.

Examples
-> spantree mst region name SalesRegion
-> spantree mst region name “Alcatel-Lucent Marketing”
-> no spantree mst region name

Release History
Release 8.1.1; command introduced.

page 7-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree mst region name

Related Commands

spantree mst region revision- Defines the revision level for an MST region.
level
spantree mst region max-hops Defines the maximum number of hops for the MST region.
spantree msti Defines a MSTI number that identifies an association between a range
of VLANs and a Spanning Tree instance.
spantree msti vlan Defines an association between a range of VLANs and a single MSTI.

MIB Objects
vStpMstRegionTable
vStpMstRegionNumber
vStpMstRegionConfigName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-9
spantree mst region revision-level Distributed Spanning Tree Commands

spantree mst region revision-level

Defines the revision level for a Multiple Spanning Tree (MST) region. One of three attributes (name,
revision level, and a VLAN to MST instance association table) that defines an MST region as required by
the IEEE 802.1Q 2005 standard. Switches that share the same attribute values are all considered part of the
same MST region. Currently each switch can belong to one MST region at a time.
spantree mst region revision-level rev_level

Syntax Definitions

rev_level A numeric value that identifies the MST region revision level for the
switch.

Defaults
By default, the MST revision level is set to zero.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
An MST region revision level can be assigned to the MST region regardless of which Spanning Tree
operating mode or protocol is currently active on the switch. However, MST configuration values, such as
revision level, only apply when the switch is operating in the flat Spanning Tree mode, using the MSTP.

Examples
-> spantree mst region revision-level 1000
-> spantree mst region revision-level 2000

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mst region name Defines the name for an MST region.
spantree mst region max-hops Defines the maximum number of hops for the MST region.
spantree msti Defines a MSTI number that identifies an association between a range
of VLANs and a Spanning Tree instance.
spantree msti vlan Defines an association between a range of VLANs and a single MSTI.

MIB Objects
vStpMstRegionTable
vStpMstRegionNumber
vStpMstRegionConfigRevisionLevel

page 7-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree mst region max-hops

spantree mst region max-hops

Configures the maximum number of hops that are authorized to receive Multiple Spanning Tree (MST)
regional information. Use this command to assign the maximum number of hops a BPDU is allowed to
traverse, before it is discarded and related information is aged out.
spantree mst region max-hops max_hops

Syntax Definitions

max_hops A numeric value that designates the maximum number of hops.

Defaults
By default, the maximum number of hops is set to 20.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The value configured with this command is a regional value that applies to all instances and is used to
determine the size of the region.
• The maximum hop count value is the initial value of the “remaining hops” parameter in the MST
BPDU that originates from the bridge that is serving as the root bridge for the region. Each bridge that
in turn receives the MST BPDU decrements the “remaining hops” count value by one and passes the
new value along to the next bridge. When the count reaches 0, the BPDU is discarded.
• Specifying an MST maximum hop count is allowed regardless of which Spanning Tree operating mode
or protocol is currently active on the switch. However, MST configuration values only apply when the
switch is operating in the flat Spanning Tree mode and using the MSTP.

Examples
-> spantree mst region max-hops 40

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-11
spantree mst region max-hops Distributed Spanning Tree Commands

Related Commands

spantree mst region name Defines the name for an MST region.
spantree mst region revision- Defines the revision level for an MST region.
level
spantree msti Defines a MSTI number that identifies an association between a range
of VLANs and a Spanning Tree instance.
spantree msti vlan Defines an association between a range of VLANs and a single MSTI.

MIB Objects
vStpMstRegionTable
vStpMstRegionNumber
vStpMstRegionMaxHops

page 7-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree msti

spantree msti
Defines a Multiple Spanning Tree Instance (MSTI) number. This number identifies an association
between a range of VLANs and a single Spanning Tree instance. In addition, it is possible to assign an
optional name to the MSTI for further identification.
spantree msti msti_id [name name]
no spantree msti msti_id [name]

Syntax Definitions

msti_id A numeric MSTI ID number. A range of VLANs is associated to an

MSTI ID number.
name An alphanumeric string. Use quotes around string if the name contains
multiple words with spaces between them (for example “Alcatel-Lucent
Marketing”).

Defaults
By default, a flat mode Common and Internal Spanning Tree (CIST) instance always exists. The MSTI ID
number for this instance is 0.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the MSTI from the switch configuration.

• Use the no form of this command along with the name parameter to remove the optional MSTI name
from the specified instance. The instance itself is not removed; only the name.
• There is always one CIST per switch. Initially all VLANs are associated with the CIST instance.

• Creating an MSTI is allowed when the switch is operating in either the per-VLAN or flat Spanning
Tree mode, as long as MSTP is the selected flat mode protocol. The MSTI configuration, however, is
not active unless the switch is running in the flat mode.

Examples
-> spantree msti 10
-> spantree msti 20 name BldgOneST10
-> no spantree msti 20 name
-> no spantree msti 10

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-13
spantree msti Distributed Spanning Tree Commands

Related Commands

spantree mst region name Defines the name for an MST region.
spantree mst region revision- Defines the revision level for an MST region.
level
spantree mst region max-hops Defines the maximum number of hops for the MST region.
spantree msti vlan Defines an association between a range of VLANs and a single MSTI.

MIB Objects
vStpMstInstanceTable
vStpMstInstanceNumber
vStpMstInstanceName
vStpMstInstanceVlanBitmapAddition
vStpMstInstanceVlanBitmapDeletion
vStpMstInstanceVlanBitmapState

page 7-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree msti vlan

spantree msti vlan

Defines an association between a range of VLANs and a single Multiple Spanning Tree Instance (MSTI).
The MSTI-to-VLAN mapping created with this command is one of three attributes (name, revision level,
and a VLAN to MST instance association table) that defines an MST region as required by the IEEE
802.1Q 2005 standard. Switches that share the same attribute values are all considered part of the same
MST region. Currently each switch can belong to one MST region at a time.
spantree msti msti_id vlan vlan_id[-vlan_id2]
no spantree msti msti_id vlan vlan_id[-vlan_id2]

Syntax Definitions

msti_id A numeric MSTI identification number. A range of VLANs are

associated to an MSTI ID number.
vlan_id A VLAN ID number.
[vlan_id2] The last VLAN ID in a range of VLAN IDs.

Defaults
By default, all VLANs are associated with the flat mode Common and Internal Spanning Tree (CIST)
instance, which is also known as MSTI 0.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a VLAN or a range of VLANs from the specified MSTI
association.
• Note that the VLAN ID specified with this command does not have to already exist in the switch
configuration. This command maps VLAN IDs to MSTIs, but does not create VLANs.
• A VLAN is associated with only one MSTI at a time, but it is possible to move a VLAN from one
MSTI to another. In addition, it is also possible to assign only one VLAN to an MSTI; a range of
VLANs is not required.
• To associate multiple VLANS in a single command, use a hyphen to specify a range of VLAN IDs and
a space to separate multiple VLAN IDs and/or ranges (for example 100-115 122 135 200-210).
• Configuring an MSTI-to-VLAN mapping is allowed when the switch is operating in either the per-
VLAN or flat Spanning Tree mode, as long as MSTP is the selected flat mode protocol. The MSTI
configuration, however, is not active unless the switch is running in the flat mode.

Examples
-> spantree msti 10 vlan 100-115
-> spantree msti 20 vlan 122
-> no spantree msti 10 vlan 100-115

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-15
spantree msti vlan Distributed Spanning Tree Commands

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mst region name Defines the name for an MST region.
spantree mst region revision- Defines the revision level for an MST region.
level
spantree mst region max-hops Defines the maximum number of hops for the MST region.
spantree msti Defines a MSTI number that identifies an association between a range
of VLANs and a Spanning Tree instance.

MIB Objects
vStpMstVlanAssignmentTable
vStpMstVlanAssignmentVlanNumber
vStpMstVlanAssignmentEntry
vStpMstVlanAssignmentMstiNumber

page 7-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree priority

spantree priority
Configures the bridge priority value for the Common and Internal Spanning Tree (CIST) instance, a
Multiple Spanning Tree Instance (MSTI), or a VLAN instance. This command is also used to configure
the priority value for a port or link aggregate associated with the CIST, an MSTI, or a VLAN.
spantree [cist | msti msti_id | vlan vlan_id] [port chassis/slot/port[-port2] | linkagg linkagg_id
[-linkagg_id2]] priority priority

Syntax Definitions

cist The CIST instance (also known as MSTI 0). This parameter is
configurable in both modes (flat or per-VLAN).
msti_id An existing MSTI ID number. If MSTI 0 is specified, the priority
applies to the CIST instance. This parameter is configurable in both
modes (flat or per-VLAN) but only if the flat mode protocol is set to
MSTP.
vlan_id An existing VLAN ID number. This parameter is configurable in both
modes (flat or per-VLAN).
chassis The chassis identifier.
slot/port[-port2] The slot number and port number of the physical port. Use a hyphen to
specify a range of ports.
linkagg_id[-linkagg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
priority A bridge or port priority value. The valid range for the bridge priority is
0–65535. The valid range for the port priority is 0–15. If MSTP is the
active flat mode protocol, enter a value that is a multiple of 4096 (for
example, 4096, 8192, 12288).

Defaults
• By default, the bridge priority value is set to 32768 for the CIST, an MSTI, and a VLAN instance.

• By default, the port or link aggregate priority value is set to 7.

parameter default
cist | msti msti_id | vlan vlan_id cist

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The bridge priority is used to determine which bridge the Spanning Tree algorithm designates as the
root bridge. The port priority value is used to determine the most favorable port when a bridge has
multiple ports with the same path cost to the root bridge.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-17
spantree priority Distributed Spanning Tree Commands

• The lower the bridge or port priority number assigned, the higher the priority that is associated with the
bridge or port.
• If none of the optional instance parameters (cist, msti, or vlan) or port and linkagg parameters are
specified with this command, the bridge priority is configured for the CIST instance by default. This is
true regardless of which mode (flat or per-VLAN) is active for the switch.
• Although the cist, msti, and vlan parameters are configurable in both the flat and per-VLAN mode, the
specified priority values are not applied unless the supporting mode (flat for CIST/MSTI or per-VLAN
for a VLAN instance) is active.
• To configure the bridge priority with this command, specify the instance (cist, msti, or vlan) and the
priority value; do not specify a port number or link aggregate ID.
• The bridge priority value for an MSTI is calculated by adding the configured priority value to the
Spanning Tree instance number. For example, if the priority value of MSTI 10 equals 32768 (the
default), then the Spanning Tree priority value advertised for this instance is 32770 (32768 + 10).
• When the protocol is changed to/from MSTP, the bridge priority for the flat mode CIST instance is
reset to the default value.
• The bridge priority specifies the priority value for the first two octets of the Bridge ID (eight octets
long). The remaining six octets of the Bridge ID contain a dedicated bridge MAC address. In regards to
the priority for an MSTI, only the four most significant bits are used.
• To configure the port priority with this command, specify the instance (cist, msti, or vlan), a port
number or link aggregate ID that is associated with that instance, and the priority value.
• The port priority value configured with this command is only applied to the specified instance. As a
result, a single port can have different priority values for each instance. For example, in flat mode, port
1/24 can have a priority value of 7 for MSTI 2 and a priority value of 5 for MSTI 3.
• The port priority specifies the value of the priority field contained in the first byte of the port ID. The
second byte contains the physical switch port number.

Examples
The following command examples set the bridge priority for the specified instance:
-> spantree priority 8192
-> spantree cist priority 8192
-> spantree vlan 2 priority 32679
-> spantree msti 1 priority 2500
ERROR: Valid bridge priority values are multiples of 4096: 0, 4096,
8192, 12288, 16384 ... 61440
-> spantree msti 1 priority 8192

The following command examples set the port priority for the specified instance:
-> spantree port 1/1/10 priority 10
-> spantree cist port 1/1/10 priority 10
-> spantree cist linkagg 10 priority 1
-> spantree vlan 200 port 2/1/1 priority 15
-> spantree vlan 2 linkagg 5 priority 2
-> spantree msti 2 port 1/1/24 priority 5
-> spantree msti 3 linkagg 6-8 priority 10

page 7-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree priority

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
show spantree Displays the Spanning Tree instance configuration.
show spantree ports Displays the Spanning Tree port configuration.

MIB Objects
vStpInsTable
vStpInsNumber
vStpInsMode
vStpInsPriority
vStpInsBridgeAddress

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-19
spantree hello-time Distributed Spanning Tree Commands

spantree hello-time
Configures the Spanning Tree hello time value for the flat mode Common and Internal Spanning Tree
(CIST) instance or for a per-VLAN mode VLAN instance. This value specifies the amount of time, in
seconds, between each transmission of a BPDU on any port that is the Spanning Tree root or is attempting
to become the Spanning Tree root.
spantree [cist | vlan vlan_id] hello-time seconds

Syntax Definitions

cist The CIST instance (also known as MSTI 0). This parameter is
configurable in both modes (flat or per-VLAN).
vlan_id An existing VLAN ID number. This parameter is configurable in both
modes (flat or per-VLAN).
seconds Specifies the Hello time value in seconds. The valid range is 1–10.

Defaults
By default, the bridge hello time value is set to 2 seconds.

parameter default
cist | vlan vlan_id cist

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Lowering the Hello Time interval improves the robustness of the Spanning Tree Algorithm. Increasing
the Hello Time interval lowers the overhead of the Spanning Tree Algorithm.
• If the optional cist or vlan parameter is not specified with this command, the hello time is configured
for the CIST instance by default. This is true regardless of which mode (flat or per-VLAN) is active for
the switch.
• Although the cist and vlan parameters are configurable in both the flat and per-VLAN mode, the
specified hello time value is not applied unless the supporting mode (flat for CIST or per-VLAN for a
VLAN instance) is active.
• Note that for Multiple Spanning Tree Instances (MSTI), the hello time value is inherited from the CIST
instance and is not a configurable parameter.

Examples
-> spantree hello-time 5
-> spantree cist hello-time 5
-> spantree vlan 10 hello-time 3

page 7-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree hello-time

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
show spantree Displays the Spanning Tree instance configuration.

MIB Objects
vStpInsTable
vStpInsNumber
vStpInsMode
vStpInsBridgeHelloTime

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-21
spantree max-age Distributed Spanning Tree Commands

spantree max-age
Configures the bridge maximum age time value for the flat mode Common and Internal Spanning Tree
(CIST) instance or for a per-VLAN mode VLAN instance. This value is the amount of time, in seconds,
that the Spanning Tree Protocol information learned from the network on any port is retained. This
information is discarded when it ages beyond the maximum age value.
spantree [cist | vlan vlan_id] max-age seconds

Syntax Definitions

cist The CIST instance (also known as MSTI 0). This parameter is
configurable in both modes (flat or per-VLAN).
vlan_id An existing VLAN ID number. This parameter is configurable in both
modes (flat or per-VLAN).
seconds Max-age time in seconds. The valid range is 6–40.

Defaults
By default, the bridge maximum age time value is set to 20 seconds.

parameter default
cist | vlan vlan_id cist

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• A low maximum age time causes the Spanning Tree Algorithm to reconfigure more often.

• If the optional cist or vlan parameter is not specified with this command, the maximum age time is
configured for the CIST instance by default. This is true regardless of which mode (flat or per-VLAN)
is active for the switch.
• Although the cist and vlan parameters are configurable in both the flat and per-VLAN mode, the
specified maximum age time value is not applied unless the supporting mode (flat for CIST or per-
VLAN for a VLAN instance) is active.
• Note that for Multiple Spanning Tree Instances (MSTI), the maximum age time value is inherited from
the CIST instance and is not a configurable parameter.

Examples
-> spantree max-age 10
-> spantree cist max-age 10
-> spantree vlan 10 max-age 30

page 7-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree max-age

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
show spantree Displays the Spanning Tree instance configuration.

MIB Objects
vStpInsTable
vStpInsNumber
vStpInsBridgeMaxAge

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-23
spantree forward-delay Distributed Spanning Tree Commands

spantree forward-delay
Configures the bridge forward delay time for the flat mode Common and Internal Spanning Tree (CIST)
instance or for a per-VLAN mode VLAN instance. This value is the amount of time, in seconds, that
determines how fast a port changes its Spanning Tree state until it reaches a forwarding state. The forward
delay time specifies how long a port stays in the listening and learning states, which precede the
forwarding state.
spantree [cist | vlan vlan_id] forward-delay seconds

Syntax Definitions

cist The CIST instance (also known as MSTI 0). This parameter is
configurable in both modes (flat or per-VLAN).
vlan_id An existing VLAN ID number. This parameter is configurable in both
modes (flat or per-VLAN).
seconds Forward delay time, in seconds.The valid range is 4–30.

Defaults
By default, the bridge forward delay time value is set to 15 seconds.

parameter default
cist | vlan vlan_id cist

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• A low forward delay time can cause temporary loops in the network, because data may get forwarded
before the reconfiguration message has reached all nodes on the network.
• The forward delay time is also used to age out all dynamic MAC address entries in the forwarding
table (MAC address table) when a topology change occurs.
• If the optional cist or vlan parameter is not specified with this command, the forward delay time is
configured for the CIST instance by default. This is true regardless of which mode (flat or per-VLAN)
is active for the switch.
• Although the cist and vlan parameters are configurable in both the flat and per-VLAN mode, the
specified forward delay time value is not applied unless the supporting mode (flat for CIST or per-
VLAN for a VLAN instance) is active.
• Note that for Multiple Spanning Tree Instances (MSTI), the forward delay time is inherited from the
CIST instance and is not a configurable parameter.

page 7-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree forward-delay

Examples
-> spantree forward-delay 30
-> spantree cist forward-delay 30
-> spantree vlan 5 forward-delay 10

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
show spantree Displays the Spanning Tree instance configuration.

MIB Objects
vStpInsTable
vStpInsNumber
vStpInsMode
vStpInsBridgeForwardDelay

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-25
spantree bpdu-switching Distributed Spanning Tree Commands

spantree bpdu-switching
Enables or disables the switching of Spanning Tree BPDU for VLAN and CIST instances if the switch is
running in the per-VLAN mode.
spantree {vlan vlan_id | cist} bpdu-switching {enable | disable}

Syntax Definitions

vlan_id An existing VLAN ID number.

enable Enables BPDU switching for the specified instance.
disable Disables BPDU switching for the specified instance.

Defaults
By default, BPDU switching is disabled for VLAN or CIST instance.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Specifying the BPDU switching status for a VLAN does not depend on the current VLAN Spanning
Tree status. For example, setting the BPDU switching status to enabled is allowed on a VLAN that also
has Spanning Tree enabled.
• Use the vlan parameter along with the vlan_id to enable or disable BPDU switching for a particular
VLAN.
• Use the cist parameter to enable or disable BPDU switching for the CIST instance.

Examples
-> spantree mode flat
-> spantree bpdu-switching enable
-> spantree bpdu-switching disable
-> spantree cist bpdu-switching enable
-> spantree cist bpdu-switching disable

-> spantree mode per-vlan

-> spantree vlan 10 bpdu-switching enable
-> spantree vlan 10 bpdu-switching disable

Release History
Release 8.1.1; command introduced.

page 7-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree bpdu-switching

Related Commands

vlan members untagged Enables or disables Spanning Tree instance for the specified VLAN.
show spantree Displays VLAN Spanning Tree parameter values.

MIB Objects
vStpInsTable
vStpInsBpduSwitching

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-27
spantree path-cost-mode Distributed Spanning Tree Commands

spantree path-cost-mode
Configures the automatic selection of a 16-bit path cost for STP/RSTP ports and a 32-bit path cost for
MSTP ports or sets all path costs to use a 32-bit value.
spantree path-cost-mode {auto | 32bit}

Syntax Definitions

auto The port path cost value is automatically set depending on which
protocol is active on the switch (32-bit for MSTP, 16-bit for STP/
RSTP).
32bit Specifies that a 32-bit value is used for the port path cost value
regardless of which protocol is active on the switch.

Defaults
By default, the path cost mode is set to auto.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• All path cost values, except those for MSTIs, are reset to the default path cost value when this mode is
changed.
• When connecting a switch running in the 32-bit path cost mode to a switch running in the 16-bit mode,
the 32-bit switch has a higher path cost value and thus an inferior path cost to the 16-bit switch. To
avoid this, use the spantree path-cost-mode command to change the 32-bit switch to a 16-bit switch.
• Note that when the protocol is changed to/from MSTP, the bridge priority and port path cost values for
the flat mode CIST instance are reset to their default values. The exception to this is if the path cost
mode is set to 32-bit prior to the protocol change, the path cost is not reset to its default value

Examples
-> spantree path-cost-mode 32bit
-> spantree path-cost-mode auto

Release History
Release 8.1.1; command introduced.

Related Commands

spantree protocol Configures the protocol for the flat mode CIST instance or a per-VLAN
mode VLAN instance.

page 7-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree path-cost-mode

MIB Objects
vStpBridge
vStpPathCostMode

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-29
spantree pvst+compatibility Distributed Spanning Tree Commands

spantree pvst+compatibility
Enables or disables PVST+ mode on the switch, port or link aggregate enabling them to operate with
Cisco switches.
spantree pvst+compatibility {port chassis/slot/port] | linkagg linkagg_id} {enable | disable | auto}

Syntax Definitions

enable Enables the PVST+ mode.

disable Disables the PVST+ mode.
auto IEEE BPDUs are used until a PVST+ BPDU is detected.
chassis The chassis identifier.
slot/port Specifies the slot number for the module and the physical port number
or a range of ports on that module.
linkagg_id Link aggregate ID number.

Defaults
PVST+ is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• In order to handle PVST+ mode, the ports must be configured in per-VLAN mode.

• Specify pvst+compatibility enable to enable all the ports on the switch to handle PVST+ BPDUs.

• Initially, a port sends or receive IEEE BPDUs. Once a PVST+ BPDU is received, the port sends and
receives only PVST+ BPDUs for tagged VLANs and IEEE BPDUs for default VLANs.

Examples
-> spantree pvst+compatibility enable
-> spantree pvst+compatibility disable
-> spantree port 1/1/3 pvst+compatibility enable
-> spantree port 2/1/2 pvst+compatibility auto
-> spantree linkagg 2 pvst+compatibility enable

Release History
Release 8.1.1; command introduced.

page 7-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree pvst+compatibility

Related Commands

show spantree Displays Spanning Tree bridge information for all flat mode Common
and Internal Spanning Tree (CIST) instance and per-VLAN mode
VLAN instance.
show spantree ports Displays Spanning Tree port information for the flat mode Common and
Internal Spanning Tree (CIST) instance or a per-VLAN mode VLAN
instance.
show spantree cist ports Displays Spanning Tree port information for the flat mode Common and
Internal Spanning Tree (CIST) instance.
show spantree msti ports Displays Spanning Tree port information for a flat mode Multiple
Spanning Tree Instance (MSTI).

MIB Objects
vStpPortConfigPVST
vStpPortConfigStatePVST
vStpBridgeModePVST

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-31
spantree auto-vlan-containment Distributed Spanning Tree Commands

spantree auto-vlan-containment
Enables or disables Auto VLAN Containment (AVC). When enabled, AVC prevents a port that has no
VLANs mapped to an Multiple Spanning Tree Instance (MSTI) from becoming the root port for that
instance. Such ports are automatically assigned an infinite path cost value to make them an inferior choice
for root port.
spantree [msti msti_id] auto-vlan-containment {enable | disable}

Syntax Definitions

msti_id An existing MSTI ID number. A range of VLANs are associated to an

MSTI ID number.
enable Enables automatic VLAN containment.
disable Disables automatic VLAN containment.

Defaults
By default, automatic VLAN containment is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The AVC feature is not active for any MSTI until it is globally enabled. To globally enable this feature,
use the spantree auto-vlan-containment command but do not specify an msti_ id.
• When AVC is globally enabled, it is active for all MSTIs. To disable AVC for a single instance,
specify the msti_id for the instance and use the disable form of this command.
• Use the enable form of this command and specify an msti_id to enable AVC for an instance that was
previously disabled.
• An administratively set port path cost takes precedence and prevents AVC configuration of the path
cost. However, if the port path cost is administratively set to zero, then the path cost is reset to the
default value.
• Note that when AVC is disabled, a port assigned to a VLAN that is not mapped to a specific instance,
can become the root port for that instance and cause a loss of connectivity between other VLANs.
• AVC does not have any effect on root bridges.

Examples
-> spantree auto-vlan-containment enable
-> spantree auto-vlan-containment disable
-> spantree msti 1 auto-vlan-containment disable
-> spantree msti 1 auto-vlan-containment enable

page 7-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree auto-vlan-containment

Release History
Release 8.1.1; command introduced.

Related Commands

show spantree msti ports Displays Spanning Tree port information for a flat mode Multiple
Spanning Tree Instance (MSTI).

MIB Objects
vStpInsTable
vStpInsAutoVlanContainment
vStpBridge
vStpBridgeAutoVlanContainment

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-33
spantree cist Distributed Spanning Tree Commands

spantree cist
Enables or disables the Spanning Tree status on a port or a link aggregate of ports for the flat mode
Common and Internal Spanning Tree (CIST) instance.
spantree cist {port chassis/slot/port[-port2] | linkagg linkagg_id[-linkagg_id2]} {enable | disable}

Syntax Definitions

chassis The chassis identifier.

slot/port[-port2] The slot number and port number of the physical port. Use a hyphen to
specify a range of ports.
linkagg_id[-linkagg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
enable Enables Spanning Tree on the specified port for the CIST instance.
disable Disables Spanning Tree on the specified port for the CIST instance.

Defaults
By default, the Spanning Tree status is enabled on eligible ports.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command only applies to the CIST instance regardless of which Spanning Tree operating mode
(flat or per-VLAN) or protocol is active for the switch.
• If the switch is running in per-VLAN mode when this command is used, the Spanning Tree status
configured for the port is not active for the CIST instance until the operating mode for the switch is
changed to the flat mode.
• When the Spanning Tree status is disabled on a port, the port is set to a forwarding state for the
specified instance.
• Physical ports that are reserved for link aggregation do not participate in the Spanning Tree Algorithm.
Instead, the algorithm is applied to the aggregate logical link (virtual port) that represents a collection
of physical ports.

Examples
-> spantree cist port 4/1/1 enable
-> spantree cist port 4/1/2-5 disable
-> spantree cist linkagg 16 disable
-> spantree cist linkagg 22-26 enable

Release History
Release 8.1.1; command introduced.

page 7-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree cist

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
spantree vlan Configures the Spanning Tree status on a port or a link aggregate of
ports for a VLAN instance.

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortEnable

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-35
spantree vlan Distributed Spanning Tree Commands

spantree vlan
Enables or disables the Spanning Tree status on a port or a link aggregate of ports for the specified VLAN
instance.
spantree vlan vlan_id [-vlan2] {port chassis/slot/port[-port2] | linkagg linkagg_id[-linkagg_id2]} {enable
| disable}

Syntax Definitions

vlan_id An existing VLAN ID number.

chassis The chassis identifier.
slot/port[-port2] The slot number and port number of the physical port. Use a hyphen to
specify a range of ports.
linkagg_id[-linkagg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
enable Enables Spanning Tree on the specified port for the specified instance.
disable Disables Spanning Tree on the specified port for the specified instance.

Defaults
By default, the Spanning Tree status is enabled on eligible ports.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command only applies to the specified VLAN instance regardless of which Spanning Tree
operating mode (flat or per-VLAN) is active for the switch.
• If the switch is running in the flat mode when this command is used, the Spanning Tree status
configured for the port is not active for the specified VLAN instance until the operating mode for the
switch is changed to the per-VLAN mode.
• When the Spanning Tree status is disabled on a port, the port is set to a forwarding state for the
specified instance.
• If STP is disabled on a VLAN in the per-VLAN mode, the port Spanning Tree status is ignored and all
active ports associated with the VLAN are put in a forwarding state and not included in the Spanning
Tree Algorithm. Note that when this occurs, ports will not bridge BPDU unless the BPDU switching
status for the VLAN is enabled.
• Physical ports that are reserved for link aggregation do not participate in the Spanning Tree Algorithm.
Instead, the algorithm is applied to the aggregate logical link (virtual port) that represents a collection
of physical ports.

Examples
-> spantree vlan 2 port 4/1/1 enable
-> spantree vlan 2 port 4/1/2-5 disable

page 7-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree vlan

-> spantree vlan 3 linkagg 16 disable

-> spantree vlan 3 linkagg 22-25 disable

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
spantree cist Configures the Spanning Tree status on a port or an aggregate of ports
for the CIST instance when the switch is operating in either the per-
VLAN or flat mode.
spantree vlan admin-state Enables or disables Spanning Tree instance for the specified VLAN.
spantree bpdu-switching Enables or disables the switching of Spanning Tree BPDU for all VLAN
instances if the switch is running in the per-VLAN mode.

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortEnable

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-37
spantree cist path-cost Distributed Spanning Tree Commands

spantree cist path-cost

Configures the Spanning Tree path cost value for a port or a link aggregate of ports for the flat mode
Common and Internal Spanning Tree (CIST) instance. This value is the contribution of this port to the path
cost towards the Spanning Tree root bridge that includes this port. Path cost is a measure of the distance of
the listed port from the root bridge in the number of hops.
spantree cist {port chassis/slot/port[-port2] | linkagg linkagg_id[-linkagg_id2]} path-cost path_cost

Syntax Definitions

chassis The chassis identifier.

slot/port[-port2] The slot number and port number of the physical port. Use a hyphen to
specify a range of ports.
linkagg_id[-linkagg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
path_cost Path cost value. The valid range is 0 - 65535 for 16-bit, 0–200000000
for 32-bit.

Defaults
By default, the path cost is set to zero.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command only applies to the port path cost value for the CIST instance regardless of which
operating mode (flat or per-VLAN) or protocol is active for the switch.
• If the switch is running in per-VLAN mode when this command is used, the specified path cost value is
not active for the CIST instance until the operating mode for the switch is changed to the flat mode.
• Note that when the Spanning Tree protocol is changed to/from MSTP, the bridge priority and port path
cost values for the flat mode CIST instance are reset to their default values.
• Use the spantree path-cost-mode command to automatically select the path cost value based on the
active Spanning Tree protocol (16-bit for STP and RSTP, 32-bit for MSTP) or to use a 32-bit path cost
value regardless of which protocol is active.
• If a 32-bit path cost value is in use and the path_cost is set to zero, the following recommended default
path cost values based on link speed are used:

IEEE 802.1D
Link Speed
Recommended Value
10 MB 2,000,000
100 MB 200,000
1 GB 20,000

page 7-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree cist path-cost

IEEE 802.1D
Link Speed
Recommended Value
10 Gbps 2,000

• Is a 16-bit path cost value is in use and the path_cost is set to zero, the following IEEE 802.1D
recommended default path cost values based on link speed are used:

IEEE 802.1D
Link Speed
Recommended Value
4 Mbps 250
10 Mbps 100
16 Mbps 62
100 Mbps 19
1 Gbps 4
10 Gbps 2

• If a 32-bit path cost value is in use and the path_cost for a link aggregate is set to zero, the following
default values based on link speed and link aggregate size are used:

Aggregate Size Default Path

Link Speed
(number of links) Cost Value
10 MB 2 1,200,000
4 800,000
8 600,000
100 MB 2 120,000
4 80,000
8 60,000
1 GB 2 12,000
4 8,000
8 6,000
10 GB 2 1,200
4 800
8 600

• If a 16-bit path cost value is in use and the path_cost for a link aggregate is set to zero, the following
default values based on link speed and link aggregate size are used. Note that for Gigabit ports the
aggregate size is not applicable in this case:

Aggregate Size Default Path

Link Speed
(number of links) Cost Value
10 Mbps 2 60
4 40

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-39
spantree cist path-cost Distributed Spanning Tree Commands

Aggregate Size Default Path

Link Speed
(number of links) Cost Value
8 30
100 Mbps 2 12
4 9
8 7
1 Gbps N/A 3
10 Gbps N/A 1

Examples
-> spantree cist port 4/1/1 path-cost 19
-> spantree cist port 4/1/2-5 path-cost 19
-> spantree cist linkagg 16 path-cost 12000
-> spantree cist linkagg 17-20 path-cost 12000

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
spantree path-cost-mode Selects a 32-bit or automatic path cost mode for the switch.
spantree msti path-cost Configures the Spanning Tree path cost value for a port or a link
aggregate of ports for an MSTI.
spantree vlan path-cost Configures the Spanning Tree path cost value for a port or a link
aggregate of ports for a VLAN instance.

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortPathCost

page 7-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree msti path-cost

spantree msti path-cost

Configures the Spanning Tree path cost value for a port or a link aggregate of ports for the specified flat
mode Multiple Spanning Tree Instance (MSTI). This value is the contribution of this port to the path cost
towards the Spanning Tree root bridge that includes this port. Path cost is a measure of the distance of the
listed port from the root bridge in the number of hops.
spantree msti msti_id {port chassis/slot/port[-port2] | linkagg linkagg_id[-linkagg_id2]} path-cost
path_cost

Syntax Definitions

msti_id An existing MSTI ID number. If MSTI 0 is specified, the priority

applies to the CIST instance.
chassis The chassis identifier.
slot/port[-port2] The slot number and port number of the physical port. Use a hyphen to
specify a range of ports.
linkagg_id[-linkagg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
path_cost Path cost value. The valid range is 0 - 65535 for 16-bit, 0–200000000
for 32-bit.

Defaults
By default, the path cost is set to zero.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command only applies to the specified MSTI regardless of which operating mode (flat or per-
VLAN) is active for the switch. However, if MSTP is not the selected flat mode protocol, the path cost
value for any MSTI is not configurable.
• Note that if zero is entered for the msti_id value, the specified path cost value is applied to the CIST
instance.
• Note that when the Spanning Tree protocol is changed to/from MSTP, the bridge priority and port path
cost values for the flat mode CIST instance are reset to their default values.
• The path cost value configured with this command is only applied to the specified instance. As a result,
a single port can have a different path cost for each instance. For example, in flat mode, port 1/24 can
have a path cost of 20000 for MSTI 2 and a path cost of 35000 for MSTI 3.
• If the switch is running in per-VLAN mode when this command is used, the specified path cost value
is not active for the specified MSTI until the operating mode for the switch is changed to the flat mode.
• When MSTP is the active protocol on the switch, only a 32-bit path cost value is used. Using a 16-bit
path cost value is not an option.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-41
spantree msti path-cost Distributed Spanning Tree Commands

• If zero is entered for the path_cost value, then the following recommended default path cost values
based on link speed are used:

IEEE 802.1D
Link Speed
Recommended Value
10 MB 2,000,000
100 MB 200,000
1 GB 20,000
10 Gbps 2,000

• If the path_cost value for a link aggregate is set to zero, the following default values based on link
speed and link aggregate size are used:

Aggregate Size Default Path

Link Speed
(number of links) Cost Value
10 MB 2 1,200,000
4 800,000
8 600,000
100 MB 2 120,000
4 80,000
8 60,000
1 GB 2 12,000
4 8,000
8 6,000
10 GB 2 1,200
4 800
8 600

Examples
-> spantree msti 0 port 4/1/1 path-cost 35000
-> spantree msti 0 port 1/1/20-24 path-cost 12000
-> spantree msti 2 linkagg 10 path-cost 20000
-> spantree msti 2 linkagg 10-12 path-cost 65000

Release History
Release 8.1.1; command introduced.

page 7-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree msti path-cost

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
spantree cist path-cost Configures the Spanning Tree path cost value for a port or a link
aggregate of ports for the CIST instance.
spantree vlan path-cost Configures the Spanning Tree path cost value for a port or a link
aggregate of ports for a VLAN instance.

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortPathCost

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-43
spantree vlan path-cost Distributed Spanning Tree Commands

spantree vlan path-cost

Configures the Spanning Tree path cost value for a port or a link aggregate of ports for the specified
VLAN instance. This value is the contribution of this port to the path cost towards the Spanning Tree root
bridge that includes this port. Path cost is a measure of the distance of the listed port from the root bridge
in the number of hops.
spantree vlan vlan_id {port chassis/slot/port[-port2] | linkagg linkagg_id [-linkagg_id2]} path-cost
path_cost

Syntax Definitions

vlan_id An existing VLAN ID number.

chassis The chassis identifier.
slot/port[-port2] The slot number and port number of the physical port. Use a hyphen to
specify a range of ports.
linkagg_id[-linkagg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
path_cost Path cost value. The valid range is 0 - 65535 for 16-bit, 0–200000000
for 32-bit.

Defaults
By default, the path cost is set to zero.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command only applies to the specified VLAN instance regardless of which operating mode (flat
or per-VLAN) is active for the switch.
• If the switch is running in the flat mode when this command is used, the specified path cost for the port
is not active for the specified VLAN instance until the operating mode for the switch is changed to the
per-VLAN mode.
• Note that when the Spanning Tree protocol is changed to/from MSTP, the bridge priority and port path
cost values for the flat mode CIST instance are reset to their default values.
• Use the spantree path-cost-mode command to automatically select the path cost value based on the
active Spanning Tree protocol (16-bit for STP and RSTP, 32-bit for MSTP) or to use a 32-bit path cost
value regardless of which protocol is active.
• If a 32-bit path cost value is in use and the path_cost is set to zero, the following IEEE 892.1S
recommended default path cost values based on link speed are used:

page 7-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree vlan path-cost

IEEE 802.1D
Link Speed
Recommended Value
10 MB 2,000,000
100 MB 200,000
1 GB 20,000
10 Gbps 2,000

• Is a 16-bit path cost value is in use and the path_cost is set to zero, the following IEEE 802.1D
recommended default path cost values based on link speed are used:

IEEE 802.1D
Link Speed
Recommended Value
4 Mbps 250
10 Mbps 100
16 Mbps 62
100 Mbps 19
1 Gbps 4
10 Gbps 2

• If a 32-bit path cost value is in use and the path_cost for a link aggregate is set to zero, the following
default values based on link speed and link aggregate size are used:

Aggregate Size Default Path

Link Speed
(number of links) Cost Value
10 MB 2 1,200,000
4 800,000
8 600,000
100 MB 2 120,000
4 80,000
8 60,000
1 GB 2 12,000
4 8,000
8 6,000
10 GB 2 1,200
4 800
8 600

• If a 16-bit path cost value is in use and the path_cost for a link aggregate is set to zero, the following
default values based on link speed and link aggregate size are used. Note that for Gigabit ports the
aggregate size is not applicable in this case:

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-45
spantree vlan path-cost Distributed Spanning Tree Commands

Aggregate Size Default Path

Link Speed
(number of links) Cost Value
10 Mbps 2 60
4 40
8 30
100 Mbps 2 12
4 9
8 7
1 Gbps N/A 3
10 Gbps N/A 1

Examples
-> spantree vlan 200 port 4/1/1 path-cost 4
-> spantree vlan 200 port 4/1/2-5 path-cost 4
-> spantree vlan 300 linkagg 16 path-cost 200000
-> spantree vlan 500 linkagg 24-28 path-cost 20000

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
spantree cist path-cost Configures the Spanning Tree path cost value for a port or a link
aggregate of ports for the CIST instance.
spantree msti path-cost Configures the Spanning Tree path cost value for a port or a link
aggregate of ports for an MSTI.

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortPathCost

page 7-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree cist mode

spantree cist mode

Configures manual mode (forwarding or blocking) or dynamic mode to manage the state of a port or a link
aggregate of ports for the flat mode Common and Internal Spanning Tree (CIST) instance. Dynamic mode
defers the management of the port state to the Spanning Tree algorithm.
spantree cist {port chassis/slot/port[-port2] | linkagg linkagg_id[-linkagg_id2]} mode {forwarding |
dynamic | blocking}

Syntax Definitions

chassis The chassis identifier.

slot/port[-port2] The slot number and port number of the physical port. Use a hyphen to
specify a range of ports.
linkagg_id[-linkagg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
forwarding Sets the port state to forwarding.
dynamic Port state is determined by the Spanning Tree algorithm.
blocking Sets the port state to blocking.

Defaults
By default, the port Spanning Tree mode is set to dynamic.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command only applies to the port Spanning Tree mode for the CIST instance regardless of which
operating mode (flat or per-VLAN) is active for the switch.
• If the switch is running in per-VLAN mode when this command is used, the specified port mode is not
active for the CIST instance until the operating mode for the switch is changed to the flat mode.
• Ports manually configured to operate in a forwarding or blocking state do not participate in the
Spanning Tree algorithm.
• When port state is manually set to forwarding or blocking, the port remains in that state until it is
changed using this command.

Examples
-> spantree cist port 4/1/1 mode forwarding
-> spantree cist port 4/1/2-5 mode forwarding
-> spantree cist linkagg 10 mode blocking
-> spantree cist linkagg 15-20 mode forwarding

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-47
spantree cist mode Distributed Spanning Tree Commands

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
spantree loop-guard Configures the Spanning Tree mode for a port or a link aggregate of
ports for the specified VLAN instance.

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortManualMode

page 7-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree loop-guard

spantree loop-guard
Enables or disables the STP loop-guard on a port or link aggregate.
spantree {port chassis/slot/port[-port2] | linkagg linkagg_id [-linkagg_id2]} loop-guard {enable |
disable}

Syntax Definitions

chassis The chassis identifier.

slot/port[-port2] The slot number and port number of the physical port. Use a hyphen to
specify a range of ports.
linkagg_id[-linkagg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(example 10-20).
enable Enables STP loop-guard.
disable Disables STP loop-guard.

Defaults
STP loop-guard is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When you enable loop-guard on a port, it is automatically applied to all the active instances or VLANs
associated to the port.
• Loop-guard cannot be enabled on a port if root-guard is already enabled on the port or link aggregate
related to the port. Root-guard must be disabled before configuring loop-guard. Similarly, when loop-
guard configuration is enabled on a port or chassis, root-guard cannot be configured on the port/s.
• Loop-guard can be enabled on all types of ports including designated (forwarding), non-designated
(alternate, secondary, or root) ports. However, STP loop-guard configuration does not affect designated
ports. Hence, loop-guard is not effective when applied on designated ports.
• When loop-guard is enabled on root ports, they change to blocking mode when a loop-guard error
occurs. In such an instance, the alternate or secondary ports takeover until the root port recovers from
the error state.
• If a set of ports that are already blocked by loop-guard are grouped together to form a link aggregate,
the new link aggregate gets a new designated role. The link aggregate can also obtain a forwarding
state depending on the STP state.
• If a spanning tree channel is blocked by loop-guard and the channel breaks, spanning tree loses all the
state information. The individual physical ports obtain the designated role, even if one or more of the
links that formed the channel are unidirectional. New link aggregate might obtain a forwarding state
but new port state is defined.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-49
spantree loop-guard Distributed Spanning Tree Commands

• The ports that are configured as fast-forwarding or edge-ports do not receive BPDUs. Loop-guard is
not effective on such ports.
• Loop-guard error state is recovered when the administrative state of the port is enabled or disabled.

• When a VLAN is disabled, all the VLAN port associations recover from the error state.

• The loop-guard feature can be enabled on the ports that have STP (RSTP, MRSTP or MSTP) enabled.

• STP loop-guard on link aggregate protects all ports that are members of the link aggregation group.

Examples
-> spantree port 1/1/2 loop-guard enable
-> spantree linkagg 1 loop-guard enable
-> spantree port 1/1/2 loop-guard disable
-> spantree linkagg 1 loop-guard disable

Release History
Release 8.2.1; command introduced.

Related Commands

show spantree ports Displays Spanning Tree port information for the flat mode Common and
Internal Spanning Tree (CIST) instance or a 1x1 mode VLAN instance.

MIB Objects
vStpPortConfigTable
vStpPortConfigIfIndex
vStpPortConfigLoopGuard

page 7-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree vlan mode

spantree vlan mode

Configures Manual mode (forwarding or blocking) or Dynamic mode to manage the state of a port or a
link aggregate of ports for the specified VLAN instance. Dynamic mode defers the management of the
port state to the Spanning Tree algorithm.
spantree vlan vlan_id {port chassis/slot/port[-port2] | linkagg linkagg_id [-linkagg_id2]} mode
{dynamic | blocking | forwarding}

Syntax Definitions

vlan_id An existing VLAN ID number.

chassis The chassis identifier.
slot/port[-port2] The slot number and port number of the physical port. Use a hyphen to
specify a range of ports.
linkagg_id[-linkagg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
dynamic Port state is determined by Spanning Tree algorithm.
blocking Sets port state to blocking.
forwarding Sets port state to forwarding.

Defaults
By default, the port Spanning Tree mode is set to dynamic.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command only applies to the specified VLAN instance regardless of which operating mode (flat
or per-VLAN) is active for the switch.
• If the switch is running in the flat mode when this command is used, the specified mode for the port is
not active for the specified VLAN instance until the operating mode for the switch is changed to the
per-VLAN mode.
• Ports manually configured to operate in a forwarding or blocking state do not participate in the
Spanning Tree algorithm.
• When port state is manually set to forwarding or blocking, the port remains in that state until it is
changed using this command.

Examples
-> spantree vlan 255 port 4/1/1-4 mode forwarding
-> spantree vlan 355 port 1/1/24 mode dynamic
-> spantree vlan 450 linkagg 1 mode dynamic
-> spantree vlan 450 linkagg 1-5 mode dynamic

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-51
spantree vlan mode Distributed Spanning Tree Commands

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
spantree cist mode Configures the Spanning Tree mode for a port or a link aggregate of
ports for the CIST instance.

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortManualMode

page 7-52 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree cist connection

spantree cist connection

Configures the connection type for a port or a link aggregate of ports for the flat mode Common and
Internal Spanning Tree (CIST).
spantree cist {port chassis/slot/port [-port2] | linkagg linkagg_id [-linkagg_id2]} connection {noptp |
ptp | autoptp}

Syntax Definitions

chassis The chassis identifier.

slot/port[-port2] The slot number and port number of the physical port. Use a hyphen to
specify a range of ports.
linkagg_id[-linkagg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
noptp Defines port connection type as no point to point link.
ptp Defines port connection type as point to point link.
autoptp Specifies that switch software automatically defines connection type as
point-to-point or no point-to-point.

Defaults
By default, the link connection type is set to auto point-to-point.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command only applies to the port connection type for the CIST instance regardless of which
operating mode (flat or per-VLAN) is active for the switch.
• If the switch is running in per-VLAN mode when this command is used, the specified port connection
type is not active for the CIST instance until the operating mode for the switch is changed to the flat
mode.
• A port is considered connected to a point-to-point LAN segment if the port belongs to a link aggregate
of ports or if autonegotiation determines the port must run in full duplex mode or if full duplex mode
was administratively set. Otherwise, the port is considered connected to a no point-to-point LAN
segment.
• Rapid transition of a designated port to forwarding can only occur if the port connection type is defined
as a point-to-point or an edge port. Rapid transition of an alternate port role to a root port role is not
affected by the port connection type definition.

Examples
-> spantree cist port 7/1/24 connection noptp
-> spantree cist port 7/1/25-28 connection ptp

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-53
spantree cist connection Distributed Spanning Tree Commands

-> spantree cist linkagg 5-10 connection autoptp

-> spantree cist linkagg 5-10 connection autoptp

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
spantree cist admin-edge Configures the administrative edge port status for a port or aggregate
of ports for the CIST instance.
spantree cist auto-edge Configures whether or not Spanning Tree automatically determines the
operational edge status of a port or an aggregate of ports for the flat
mode CIST instance.

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortAdminConnectionType
vStpInsPortOperConnectionType

page 7-54 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree vlan connection

spantree vlan connection

Configures the connection type for a port or a link aggregate of ports for a VLAN instance.
spantree vlan vlan_id {port chassis/slot/port [-port2] | linkagg linkagg_id [-linkagg_id2]} connection
{noptp | ptp | autoptp}

Syntax Definitions

vlan_id An existing VLAN ID number.

chassis The chassis identifier.
slot/port[-port2] The slot number and port number of the physical port. Use a hyphen to
specify a range of ports.
linkagg_id[-linkagg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
noptp Defines port connection type as no point-to-point link.
ptp Defines port connection type as point-to-point link.
autoptp Specifies that switch software automatically defines connection type as
point-to-point or no point-to-point and whether or not the port is an edge
port.

Defaults
By default, the link connection type is set to auto point-to-point.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command only applies to the specified VLAN instance regardless of which operating mode (flat
or per-VLAN) is active for the switch.
• If the switch is running in the flat mode when this command is used, the specified connection type for
the port is not active for the specified VLAN instance until the operating mode for the switch is
changed to the per-VLAN mode.
• A port is considered connected to a point-to-point LAN segment if the port belongs to a link aggregate
of ports or if autonegotiation determines the port must run in full duplex mode or if full duplex mode
was administratively set. Otherwise, the port is considered connected to a no point-to-point LAN
segment.
• Rapid transition of a designated port to forwarding can only occur if the port connection type is defined
as a point to point or an edge port. Rapid transition of an alternate port role to a root port role is not
affected by the port connection type definition.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-55
spantree vlan connection Distributed Spanning Tree Commands

Examples
-> spantree vlan 255 port 7/1/24 connection noptp
-> spantree vlan 255 port 7/1/25-27 connection ptp
-> spantree vlan 255 linkagg 3 connection autoptp
-> spantree vlan 255 linkagg 3-7 connection autoptp

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch
spantree cist admin-edge Configures the administrative edge port status for a port or aggregate
of ports for the CIST instance.
spantree cist auto-edge Configures whether or not Spanning Tree automatically determines the
operational edge status of a port or an aggregate of ports for the flat
mode CIST instance.

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortAdminConnectionType
vStpInsPortOperConnectionType

page 7-56 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree cist admin-edge

spantree cist admin-edge

Configures the administrative edge port status for a port or a link aggregate of ports for the flat mode
Common and Internal Spanning Tree (CIST).
spantree cist {port chassis/slot/port[-port2] | linkagg linkagg_id[-linkagg_id2]} admin-edge {enable |
disable}

Syntax Definitions

chassis The chassis identifier.

slot/port[-port2] The slot number and port number of the physical port. Use a hyphen to
specify a range of ports.
linkagg_id[-linkagg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
enable Enables the administrative edge port status for the specified port-CIST
instance.
disable Disables the administrative edge port status for the specified port-CIST
instance.

Defaults
By default, the administrative edge port status is disabled (off).

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command only applies to the port connection type for the CIST instance regardless of which
operating mode (flat or per-VLAN) is active on the switch.
• If the switch is running in the per-VLAN mode when this command is used, the specified edge port
status is not active for the CIST instance until the switch is configured to run in the flat Spanning Tree
mode.
• The administrative edge port status is used to determine if a port is an edge or non-edge port when
automatic edge port configuration (auto-edge) is disabled for the port. However, if auto-edge is
enabled for the port, then the administrative status is overridden.
• Rapid transition of a designated port to forwarding can only occur if the port connection type is defined
as a point to point or an edge port. Rapid transition of an alternate port role to a root port role is not
affected by the port connection type definition.
• Configure ports that connect to a host (PC, workstation, server, and so on) as edge ports to avoid
unnecessary topology changes when these ports go active. This also prevents the flushing of learned
MAC addresses on these ports if a topology change occurs as a result of another non-edge port going
active. If an edge port receives a BPDU, it operationally reverts back to a no point-to-point connection
type.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-57
spantree cist admin-edge Distributed Spanning Tree Commands

Examples
-> spantree cist linkagg 15 admin-edge enable
-> spantree cist linkagg 4-10 admin-edge enable
-> spantree cist port 8/1/25 admin-edge disable
-> spantree cist port 2/1/2-5 admin-edge enable

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch
spantree vlan admin-edge Configures the administrative edge port status for a port or a link
aggregate of ports for a specific VLAN instance.
spantree cist auto-edge Configures whether or not Spanning Tree automatically determines the
operational edge status of a port or a link aggregate of ports for the flat
mode CIST instance.
spantree vlan auto-edge Configures whether or not Spanning Tree determines the operational
edge port status for a port or a link aggregate of ports for the specified
per-VLAN mode VLAN instance.

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortAdminEdge

page 7-58 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree vlan admin-edge

spantree vlan admin-edge

Configures the administrative edge port status for a port or a link aggregate of ports for a VLAN instance.
spantree vlan vlan_id {port chassis/slot/port[-port2] | linkagg linkagg_id[-linkagg_id2]} admin-edge
{enable | disable}

Syntax Definitions

vlan_id An existing VLAN ID number.

chassis The chassis identifier.
slot/port[-port2] The slot number and port number of the physical port. Use a hyphen to
specify a range of ports.
linkagg_id[-linkagg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
enable Enables the administrative edge port status for the specified port-VLAN
instance.
disable Disables the administrative edge port status for the specified port-
VLAN instance.

Defaults
By default, the administrative edge port status is disabled (off).

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command only applies to the specified VLAN instance regardless of which operating mode (flat
or per-VLAN) is active for the switch.
• If the switch is running in the flat mode when this command is used, the specified edge port status for
the port is not active for the VLAN instance until the switch is configured to run in the per-VLAN
Spanning Tree mode.
• The administrative edge port status is used to determine if a port is an edge or non-edge port when
automatic edge port configuration (auto-edge) is disabled for the port. However, if auto-edge is
enabled for the port, then the administrative status is overridden.
• Rapid transition of a designated port to forwarding can only occur if the port connection type is defined
as point to point or an edge port. Rapid transition of an alternate port role to a root port role is not
affected by the port connection type definition.
• Configure ports that connect to a host (PC, workstation, server, and so on.) as edge ports to avoid
unnecessary topology changes when these ports go active. This also prevents the flushing of learned
MAC addresses on these ports if a topology change occurs as a result of another non-edge port going
active. If an edge port receives a BPDU, it operationally reverts back to a no point to point connection
type.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-59
spantree vlan admin-edge Distributed Spanning Tree Commands

Examples
-> spantree vlan 4 linkagg 15 admin-edge enable
-> spantree vlan 5 linkagg 12-14 admin-edge enable
-> spantree vlan 255 port 8/1/23 admin-edge disable
-> spantree vlan 3 port 2/1/2-5 admin-edge enable

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch
spantree cist admin-edge Configures the administrative edge port status for a port or aggregate
of ports for the CIST instance.
spantree cist auto-edge Configures whether or not Spanning Tree automatically determines the
operational edge status of a port or aggregate of ports for the flat mode
CIST instance.
spantree vlan auto-edge Configures whether or not Spanning Tree determines the operational
edge port status for a port or aggregate of ports for the specified per-
VLAN mode VLAN instance.

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortAdminEdge

page 7-60 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree cist auto-edge

spantree cist auto-edge

Configures whether or not Spanning Tree automatically determines the operational edge port status of a
port or a link aggregate of ports for the flat mode Common and Internal Spanning Tree (CIST).
spantree cist {port chassis/slot/port[-port2] | linkagg linkagg_id [-linkagg_id2]} auto-edge {enable |
disable}

Syntax Definitions

chassis The chassis identifier.

slot/port[-port2] The slot number and port number of the physical port. Use a hyphen to
specify a range of ports.
linkagg_id[-linkagg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs.
enable Spanning Tree automatically determines edge port status.
disable Spanning Tree does not automatically determine edge port status.

Defaults
By default, automatic edge port status configuration is enabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command only applies to the CIST instance regardless of which operating mode (flat or per-
VLAN) is active for the switch.
• If the switch is running in the per-VLAN mode when this command is used, the specified edge port
status for the port is not active for the CIST instance until the switch is running in the flat Spanning
Tree mode.
• The administrative edge port status is used to determine if a port is an edge or non-edge port when
automatic edge port configuration (auto-edge) is disabled for the port. However, if auto-edge is
enabled for the port, then the administrative status is overridden.
• Rapid transition of a designated port to forwarding can only occur if the connection type of the port is
defined as point to point or an edge port. Rapid transition of an alternate port role to a root port role is
not affected by the port connection type definition.
• Configure ports that connect to a host (PC, workstation, server, and so on.) as edge ports to avoid
unnecessary topology changes when these ports go active. This also prevents the flushing of learned
MAC addresses on these ports if a topology change occurs as a result of another non-edge port going
active. If an edge port receives a BPDU, it operationally reverts back to a no point to point connection
type.

Examples
-> spantree cist linkagg 15 auto-edge enable
-> spantree cist linkagg 10-12 auto-edge disable

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-61
spantree cist auto-edge Distributed Spanning Tree Commands

-> spantree cist port 8/1/23 auto-edge disable

-> spantree cist port 2/1/2-5 auto-edge enable

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch
spantree vlan auto-edge Configures whether or not Spanning Tree determines the operational
edge port status for a port or aggregate of ports for the specified per-
VLAN mode VLAN instance.
spantree cist admin-edge Configures the administrative edge port status for a port or aggregate
of ports for the CIST instance.
spantree vlan admin-edge Configures the administrative edge port status for a port or aggregate
of ports for a specific VLAN instance.

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortAutoEdge

page 7-62 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree vlan auto-edge

spantree vlan auto-edge

Configures whether or not Spanning Tree determines the operational edge port status for a port or a link
aggregate of ports for the specified per-VLAN mode VLAN instance.
spantree vlan vlan_id {port chassis/slot/port[-port2] | linkagg linkagg_id [-linkagg_id2]} auto-edge
{enable | disable}

Syntax Definitions

vlan_id An existing VLAN ID number.

chassis The chassis identifier.
slot/port[-port2] The slot number and port number of the physical port. Use a hyphen to
specify a range of ports.
linkagg_id[-linkagg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs.
enable Spanning Tree automatically determines edge port status.
disable Spanning Tree does not automatically determine edge port status.

Defaults
By default, automatic edge port status configuration is enabled (on).

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command only applies to the specified VLAN instance regardless of which operating mode (flat
or per-VLAN) is active for the switch.
• If the switch is running in the flat mode when this command is used, the specified edge port status for
the port is not active for the VLAN instance until the switch is running in the per-VLAN Spanning
Tree mode.
• The administrative edge port status is used to determine if a port is an edge or non-edge port when
automatic edge port configuration (auto-edge) is disabled for the port. However, if auto-edge is
enabled for the port, then the administrative status is overridden.
• Rapid transition of a designated port to forwarding can only occur if the connection type of the port is
defined as point to point or an edge port. Rapid transition of an alternate port role to a root port role is
not affected by the port connection type definition.
• Configure ports that connect to a host (PC, workstation, server, and so on.) as edge ports to avoid
unnecessary topology changes when these ports go active. This also prevent the flushing of learned
MAC addresses on these ports if a topology change occurs as a result of another non-edge port going
active. If an edge port receives a BPDU, it operationally reverts back to a no point to point connection
type.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-63
spantree vlan auto-edge Distributed Spanning Tree Commands

Examples
-> spantree vlan 255 port 8/1/23 auto-edge disable
-> spantree vlan 4 port 2/1/2-10 auto-edge enable
-> spantree vlan 100 linkagg 10 auto-edge disable
-> spantree vlan 200 linkagg 1-5 auto-edge enable

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
spantree cist auto-edge Configures whether or not Spanning Tree automatically determines the
operational edge status of a port or aggregate of ports for the flat mode
CIST instance.
spantree cist admin-edge Configures the administrative edge port status for a port or aggregate
of ports for the CIST instance.
spantree vlan admin-edge Configures the administrative edge port status for a port or aggregate
of ports for a specific VLAN instance.

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortAutoEdge

page 7-64 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree cist restricted-role

spantree cist restricted-role

Configures the restricted role status for a port or a link aggregate of ports. Enabling this parameter blocks
the port from becoming the Root Port, even if it is the most likely candidate for root. Once a root port is
selected, the restricted port is selected as an Alternate Port.
spantree cist {port chassis/slot/port[-port2] | linkagg linkagg_id[-linkagg_id2]} restricted-role {enable |
disable}

Syntax Definitions

chassis The chassis identifier.

slot/port[-port2] The slot number and port number of the physical port. Use a hyphen to
specify a range of ports,
linkagg_id[-linkagg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
enable Enables the restricted role status for the specified port.
disable Disables the restricted role status for the specified port.

Defaults
By default, the restricted role status for the port is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When running in flat mode, this is a per-port setting and is applicable to any CIST or MSTI instances
configured on that port.
• Enabling the restricted role status is used by network administrators to prevent bridges external to the
core region of the network from influencing the Spanning Tree topology.
• Note that enabling the restricted role status for a port may impact connectivity within the network.

Examples
-> spantree cist linkagg 15-20 restricted-role enable
-> spantree cist port 8/1/23 restricted-role disable
-> spantree cist port 8/1/24-27 restricted-role disable
-> spantree cist linkagg 10 restricted-role disable

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-65
spantree cist restricted-role Distributed Spanning Tree Commands

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
spantree vlan restricted-role Configures the restricted role status for a port or aggregate of ports for
the per-VLAN mode VLAN instance.

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortRestrictedRole

page 7-66 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree vlan restricted-role

spantree vlan restricted-role

Configures the restricted role status for a port or a link aggregate of ports for the specified VLAN
instance. Enabling this parameter blocks the port from becoming the Root Port, even if it is the most likely
candidate for root. Once a Root Port is selected, the restricted port is selected as an Alternate Port.
spantree vlan vlan_id {port chassis/slot/port[-port2] | linkagg linkagg_id[-linkagg_id2]} restricted-role
{enable | disable}

Syntax Definitions

vlan_id An existing VLAN ID number.

chassischassis The chassis identifier.
slot/port[-port2] The slot number and port number of the physical port. Use a hyphen to
specify a range of ports,
linkagg_id[-linkagg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
enable Enables the restricted role status for the specified port-VLAN instance.
disable Disables the restricted role status for the specified port-VLAN instance.

Defaults
By default, the restricted role status for the port is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enabling the restricted role status is used by network administrators to prevent bridges external to the
core region of the network from influencing the Spanning Tree topology.
• Note that enabling the restricted role status for a port may impact connectivity within the network.

• This command only applies to the VLAN instance specified by the VLAN ID regardless of which
operating mode (flat or per-VLAN) is active for the switch.
• If the switch is running in the flat mode when this command is used, the specified restricted role status
for the port is not active for the VLAN instance until the switch is running in the per-VLAN Spanning
Tree mode.

Examples
-> spantree vlan 3 linkagg 15 restricted-role enable
-> spantree vlan 255 port 8/1/23 restricted-role enable
-> spantree vlan 255 port 8/1/24-27 restricted-role enable
-> spantree vlan 255 linkagg 11-15 restricted-role enable

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-67
spantree vlan restricted-role Distributed Spanning Tree Commands

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
spantree cist restricted-role Configures the restricted role status for a port or aggregate of ports for
the flat mode CIST instance.

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortRestrictedRole

page 7-68 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree cist restricted-tcn

spantree cist restricted-tcn

Configures the restricted TCN status for a port or a link aggregate of ports for the flat mode Common and
Internal Spanning Tree (CIST). When this parameter is enabled, the port does not propagate topology
changes and notifications to/from other ports.
spantree cist {port chassis/slot/port[-port2] | linkagg linkagg_id[-linkagg_id2]} restricted-tcn {enable |
disable}

Syntax Definitions

chassis The chassis identifier.

slot/port[-port2] The slot number and port number of the physical port. Use a hyphen to
specify a range of ports.
linkagg_id[-linkagg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs.
enable Enables the restricted TCN status for the specified port-CIST instance.
disable Disables the restricted TCN status for the specified port-CIST instance.

Defaults
By default, the restricted TCN status for the port is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enabling the restricted TCN status is used by network administrators to prevent bridges external to the
core region of the network from causing unnecessary MAC address flushing in that region.
• Note that enabling the restricted TCN status for a port may impact Spanning Tree connectivity.

• This command only applies to the CIST instance regardless of which operating mode (flat or per-
VLAN) is active for the switch.
• If the switch is running in the per-VLAN mode when this command is used, the specified restricted
TCN status for the port is not active for the CIST instance until the switch is running in the flat
Spanning Tree mode.

Examples
-> spantree cist linkagg 15 restricted-tcn enable
-> spantree cist port 8/1/23 restricted-tcn disable
-> spantree cist port 2/1/2-4 restricted-tcn enable
-> spantree cist linkagg 10-14 restricted-tcn disable

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-69
spantree cist restricted-tcn Distributed Spanning Tree Commands

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
spantree vlan restricted-tcn Configures the restricted TCN status for a port or aggregate of ports for
the specified per-VLAN mode VLAN instance.

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortRestrictedTcn

page 7-70 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree vlan restricted-tcn

spantree vlan restricted-tcn

Configures the restricted TCN status for a port or a link aggregate of ports for the specified VLAN
instance. When this parameter is enabled, the port does not propagate topology changes and notifications
to/from other ports.
spantree vlan vlan_id {port chassis/slot/port [-port2] | linkagg linkagg_id [-linkagg_id2]} restricted-tcn
{enable | disable}

Syntax Definitions

vlan_id An existing VLAN ID number.

chassis The chassis identifier.
slot/port[-port2] The slot number and port number of the physical port. Use a hyphen to
specify a range of ports.
linkagg_id[-linkagg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs.
enable Enables the restricted TCN status for the specified port-VLAN instance.
disable Disables the restricted TCN status for the specified port-VLAN
instance.

Defaults
By default, the restricted TCN is set to disable.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enabling the restricted TCN status is used by network administrators to prevent bridges external to the
core region of the network from causing unnecessary MAC address flushing in that region.
• Note that enabling the restricted TCN status for a port may impact Spanning Tree connectivity.

• This command only applies to the specified VLAN instance regardless of which operating mode (flat
or per-VLAN) is active for the switch.
• If the switch is running in the flat mode when this command is used, the specified restricted TCN
status for the port is not active for the VLAN instance until the switch is running in the per-VLAN
Spanning Tree mode.

Examples
-> spantree vlan 2 linkagg 15 restricted-tcn enable
-> spantree vlan 2 linkagg 16-20 restricted-tcn enable
-> spantree vlan 255 port 8/1/23 restricted-tcn disable
-> spantree vlan 255 port 8/1/24-27 restricted-tcn disable

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-71
spantree vlan restricted-tcn Distributed Spanning Tree Commands

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
spantree cist restricted-tcn Configures the restricted TCN status for a port or aggregate of ports for
the flat mode Common and Internal Spanning Tree (CIST).

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortRestrictedTcn

page 7-72 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands spantree cist txholdcount

spantree cist txholdcount

This command is used to rate limit the transmission of BPDU through a given port for the flat mode
Common and Internal Spanning Tree (CIST) instance.
spantree cist txholdcount value

Syntax Definitions

value A numeric value that controls the transmission of BPDU through the
port. The valid range is 1–10.

Defaults
By default, the txholdcount value is set to 3.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command only applies to the CIST instance regardless of which operating mode (flat or per-
VLAN) is active for the switch.
• If the switch is running in the per-VLAN mode when this command is used, the specified txholdcount
status for the port is not active for the CIST instance until the switch is running in the flat Spanning
Tree mode.

Examples
-> spantree cist txholdcount 5

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
spantree vlan txholdcount Configures the BPDU transmission rate limit for the specified VLAN
instance.

MIB Objects
vStpInsTable
vStpInsBridgeTxHoldCount

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-73
spantree vlan txholdcount Distributed Spanning Tree Commands

spantree vlan txholdcount

This command is used to rate limit the transmission of BPDU through a given port for the VLAN instance.
spantree vlan vlan_id txholdcount {value}

Syntax Definitions

vlan_id An existing VLAN ID number.

value A numeric value that controls the transmission of BPDU through the
port. The valid range is 1–10.

Defaults
By default, the txholdcount value is set to 3.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command only applies to the specified VLAN instance regardless of which operating mode (flat
or per-VLAN) is active for the switch.
• If the switch is running in the flat mode when this command is used, the specified txholdcount status
for the port is not active for the VLAN instance until the switch is running in the per-VLAN Spanning
Tree mode.

Examples
-> spantree vlan 3 txholdcount 6

Release History
Release 8.1.1; command introduced.

Related Commands

spantree mode Selects the Spanning Tree operating mode (flat or per-VLAN) for the
switch.
spantree cist txholdcount Configures the BPDU transmission rate limit for the CIST instance.

MIB Objects
vStpInsTable
vStpInsBridgeTxHoldCount

page 7-74 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree

show spantree
Displays Spanning Tree bridge information for the flat mode Common and Internal Spanning Tree (CIST)
instance or the per-VLAN mode VLAN instances.
show spantree

Syntax Definitions

NA

Defaults
NA

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the switch is operating in the per-VLAN mode, this command displays a list of VLAN instances.

• If the switch is operating in the flat mode and the protocol is STP or RSTP, this command displays the
single flat mode instance.
• If the switch is operating in the flat mode and the protocol is set to MSTP, this command displays a list
of MSTIs, including MSTI 0 (also known as the CIST).

Examples
-> spantree mode flat
-> spantree protocol rstp
-> show spantree

Spanning Tree Path Cost Mode : 32 BIT

Bridge STP Status Protocol Priority(Prio:SysID)
------+----------+--------+--------------------
1 ON RSTP 32768 (0x8000:0x0000)

output definitions
Spanning Tree Path Cost The Spanning Tree path cost mode for the switch (32 BIT or AUTO)
Mode Configured through the spantree path-cost-mode command.
Bridge The CIST instance, referred to as bridge 1 when either STP (802.1D) or
RSTP (802.1W) is the active protocol.
STP Status The Spanning Tree state for the CIST instance (ON or OFF).
Protocol The Spanning Tree protocol applied to the instance (STP or RSTP).
Configured through the spantree protocol command.
Priority The Spanning Tree bridge priority for the instance. The lower the
number, the higher the priority. Configured through the spantree
priority command.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-75
show spantree Distributed Spanning Tree Commands

-> spantree mode flat

-> spantree protocol mstp

-> show spantree

Spanning Tree Path Cost Mode : AUTO
Msti STP Status Protocol Priority (Prio:SysID)
-----+----------+--------+---------------------
0 ON MSTP 32768 (0x8000:0x0000)
2 ON MSTP 32770 (0x8000:0x0002)
3 ON MSTP 32771 (0x8000:0x0003)

output definitions
Spanning Tree Path Cost The Spanning Tree path cost mode for the switch (32 BIT or AUTO)
Mode Configured through the spantree path-cost-mode command.
Msti The Multiple Spanning Tree Instance (MSTI) instance number.
Configured through the spantree msti command. Note that MSTI 0
also represents the CIST instance that is always present on the switch.
STP Status The Spanning Tree state for the MSTI (ON or OFF).
Protocol The Spanning Tree protocol applied to this instance. Configured
through the spantree protocol command.
Priority The Spanning Tree bridge priority for the instance. The lower the
number, the higher the priority. Configured through the spantree
priority command.

-> spantree mode per-vlan

-> show spantree

Spanning Tree Path Cost Mode : AUTO

Spanning Tree PVST+ Mode : Enable
Vlan STP Status Protocol Priority
-----+----------+--------+--------------
1 ON STP 32768 (0x8000)
2 ON STP 32768 (0x8000)
3 ON STP 32768 (0x8000)
4 ON STP 32768 (0x8000)
5 ON STP 32768 (0x8000)
6 ON STP 32768 (0x8000)
7 ON STP 32768 (0x8000)

output definitions
Spanning Tree Path Cost The Spanning Tree path cost mode for the switch (32 BIT or AUTO)
Mode Configured through the spantree path-cost-mode command.
Spanning Tree PVST+ Mode Indicates whether the PVST + status is enabled or disabled. Configured
through the spantree pvst+compatibility command.
Vlan The VLAN ID associated with the VLAN Spanning Tree instance.
Configured through the vlan commands
STP Status The Spanning Tree state for the instance (ON or OFF). Configured
through the spantree vlan admin-state command.

page 7-76 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree

output definitions (continued)

Protocol The Spanning Tree protocol applied to this instance (STP or RSTP).
Configured through the spantree protocol command.
Priority The Spanning Tree bridge priority for the instance. The lower the
number, the higher the priority. Configured through the spantree
priority command.

Release History
Release 8.1.1; command introduced.

Related Commands

show spantree cist Displays the Spanning Tree bridge configuration for the CIST
instance regardless of which mode (per-VLAN or flat) is active on
the switch.
show spantree msti Displays the Spanning Tree bridge configuration for an MSTI
regardless of which mode (per-VLAN or flat) is active on the
switch.
show spantree vlan Displays the Spanning Tree bridge configuration for a VLAN
instance regardless of which mode (per-VLAN or flat) is active on
the switch.

MIB Objects
vStpInsTable
vStpInsNumber
vStpInsProtocolSpecification
vStpInsMode
vStpInsPriority
vStpInsBridgeAddress
vStpInsDesignatedRoot
vStpInsRootCost
vStpInsRootPortNumber
vStpInsNextBestRootCost
vStpInsNextBestRootPortNumber
vStpInsBridgeTxHoldCount
vStpInsTopChanges
vStpInsTimeSinceTopologyChange
vStpInsMaxAge
vStpInsForwardDelay
vStpInsHelloTime

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-77
show spantree cist Distributed Spanning Tree Commands

show spantree cist

Displays the Spanning Tree bridge configuration for the flat mode Common and Internal Spanning Tree
(CIST) instance.
show spantree cist

Syntax Definitions

NA

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guideline
This command displays Spanning Tree bridge information for the flat mode CIST instance regardless of
which mode (per-VLAN or flat) is active on the switch. Note that minimal information is displayed when
this command is used in the per-VLAN mode, as the CIST is not active in this mode. See second example
below.

Examples
-> spantree mode flat
-> show spantree cist
Spanning Tree Parameters for Cist
Spanning Tree Status : ON,
Protocol : IEEE Multiple STP,
mode : FLAT (Single STP),
Auto-Vlan-Containment: Enabled ,
Priority : 32768 (0x8000),
Bridge ID : 8000-00:d0:95:01:39:2c,
CST Designated Root : 8000-00:d0:95:01:39:2c,
Cost to CST Root : 0,
Next CST Best Cost : 0,
Designated Root : 8000-00:d0:95:01:39:2c,
Cost to Root Bridge : 0,
Root Port : None,
Next Best Root Cost : 0,
Next Best Root Port : None,
TxHoldCount : 3,
Topology Changes : 0,
Topology age : 00:00:00,
Current Parameters (seconds)
Max Age = 20,
Forward Delay = 15,
Hello Time = 2
Parameters system uses when attempting to become root
System Max Age = 20,

page 7-78 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree cist

System Forward Delay = 20,

System Hello Time = 10
BPDU Switching Enabled

-> spantree mode per-vlan

-> show spantree cist

Per Vlan Spanning Tree is enforced !! (Per VLAN mode)

INACTIVE Spanning Tree Parameters for Flat Mode
Spanning Tree Status : ON,
Protocol : IEEE Rapid STP,
Priority : 32768 (0x8000),
TxHoldCount : 5,
System Max Age (seconds) = 10,
System Forward Delay (seconds) = 10,
System Hello Time (seconds) = 5

output definitions
Spanning Tree Status The Spanning Tree state for the instance (ON or OFF).
Protocol The Spanning Tree protocol applied to the CIST (STP, RSTP, or
MSTP). Configured through the spantree protocol command.
Mode The Spanning Tree operating mode for the switch (per-vlan or flat).
Configured through the spantree mode command.
Auto-Vlan-Containment The auto VLAN containment status for the instance (Enabled or
Disabled). AVC prevents a port that has no VLANs mapped to a
Multiple Spanning Tree Instance (MSTI) from becoming the root port
for that instance. Configured through the spantree auto-vlan-
containment command.
Priority The Spanning Tree bridge priority for the instance. The lower the
number, the higher the priority. Configured through the spantree
priority command.
Bridge ID The bridge identifier for this Spanning Tree instance. Consists of the
bridge priority value (in hex) concatenated with the dedicated bridge
MAC address.
CST Designated Root The bridge identifier for the root of the flat mode CIST instance. This
field only appears when MSTP is active on the switch.
Cost to CST Root The cost of the path to the root of the flat mode CIST instance. This
field only appears when MSTP is active on the switch.
Next CST Best Cost The cost of the next best root port for the flat mode CIST instance. This
field only appears when MSTP is active on the switch.
Designated Root The bridge identifier for the root of the Spanning Tree for this instance.
Cost to Root Bridge The cost of the path to the root for this Spanning Tree instance.
Root Port The port that offers the lowest cost path from this bridge to the root
bridge for this Spanning Tree instance.
Next Best Root Cost The cost of the next best root port for this Spanning Tree instance.
Next Best Root Port The port that offers the next best (second lowest) cost path to the root
bridge for this Spanning Tree instance.
Tx Hold Count The count to limit the transmission of BPDU through the port.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-79
show spantree cist Distributed Spanning Tree Commands

output definitions (continued)

Topology Changes The number of topology changes detected by this Spanning Tree
instance since the management entity was last reset or initialized.
Topology age The amount of time (in hundredths of seconds) since the last topology
change was detected by this Spanning Tree instance (hh:mm:ss or dd
days and hh:mm:ss).
Max Age The amount of time (in seconds) that Spanning Tree Protocol
information is retained before it is discarded. Configured through the
spantree max-age command.
Forward Delay The amount of time (in seconds) that a port remains in the Listening
state and then the Learning state until it reaches the forwarding state.
This is also the amount of time used to age out all dynamic entries in
the Forwarding Database when a topology change occurs. Configured
through the spantree forward-delay command.
Hello Time The amount of time (in seconds) between the transmission of
Configuration BPDUs on any port that is the Spanning Tree root or is
attempting to become the Spanning Tree root. Configured through the
spantree hello-time command.
System Max Age The Max Age value for the root bridge.
System Forward Delay The Forward Delay value for the root bridge.
System Forward Delay The Forward Delay value for the root bridge.

Release History
Release 8.1.1; command introduced.

Related Commands

show spantree Displays the Spanning Tree bridge configuration for the flat mode
CIST instance or a per-VLAN mode VLAN instance, depending on
which mode is active for the switch.
show spantree msti Displays the Spanning Tree bridge configuration for an MSTI
regardless of which mode (per-VLAN or flat) is active on the
switch.
show spantree vlan Displays the Spanning Tree bridge configuration for a VLAN
instance regardless of which mode (per-VLAN or flat) is active on
the switch.

page 7-80 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree cist

MIB Objects
vStpInsTable
vStpInsNumber
vStpInsMode
vStpInsProtocolSpecification
vStpInsPriority
vStpInsBridgeAddress
vStpInsTimeSinceTopologyChange
vStpInsTopChanges
vStpInsDesignatedRoot
vStpInsRootCost
vStpInsRootPortNumber
vStpInsNextBestRootCost
vStpInsNextBestRootPortNumber
vStpInsMaxAge
vStpInsHelloTime
vStpInsBridgeTxHoldCount
vStpInsForwardDelay
vStpInsBridgeMaxAge
vStpInsBridgeHelloTime
vStpInsBridgeForwardDelay
vStpInsCistRegionalRootId
vStpInsCistPathCost

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-81
show spantree msti Distributed Spanning Tree Commands

show spantree msti

Displays Spanning Tree bridge information for a Multiple Spanning Tree Instance (MSTI).
show spantree msti [msti_id]

Syntax Definitions

msti_id An existing MSTI ID number.

Defaults
By default, displays information for all MSTIs.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If an msti_id number is not specified, this command displays the Spanning Tree status, protocol, and
priority values for all MSTIs.
• This command displays Spanning Tree bridge information for an MSTI regardless of which mode (per-
VLAN or flat) is active for the switch.
• Note that minimal information is displayed when this command is used in the per-VLAN mode, as
MSTIs are not active in this mode. In addition, this command fails if MSTP is not the selected flat
mode protocol.
• Note that MSTI 0 also represents the CIST instance that is always present on the switch. To view the
CIST instance using this command, specify zero (0) for the msti_id number.

Examples
-> spantree mode flat
-> spantree protocol mstp
-> show spantree msti

Spanning Tree Path Cost Mode : AUTO

Msti STP Status Protocol Priority (Prio:SysID)
-----+----------+--------+---------------------
0 ON MSTP 32768 (0x8000:0x0000)
2 ON MSTP 32770 (0x8000:0x0002)
3 ON MSTP 32771 (0x8000:0x0003)

-> show spantree msti 0

Spanning Tree Parameters for Cist

Spanning Tree Status : ON,
Protocol : IEEE Multiple STP,
mode : FLAT (Single STP),
Priority : 32768 (0x8000),
Bridge ID : 8000-00:d0:95:6b:08:40,

page 7-82 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree msti

CST Designated Root : 0001-00:10:b5:58:9d:39,

Cost to CST Root : 39,
Next CST Best Cost : 0,
Designated Root : 8000-00:d0:95:6b:08:40,
Cost to Root Bridge : 0,
Root Port : Slot 9 Interface 2,
Next Best Root Cost : 0,
Next Best Root Port : None,
TxHoldCount : 6,
Topology Changes : 1,
Topology age : 0:30:46
Current Parameters (seconds)
Max Age = 6,
Forward Delay = 4,
Hello Time = 2
Parameters system uses when attempting to become root
System Max Age = 20,
System Forward Delay = 15,
System Hello Time = 2

-> show spantree msti 1

Spanning Tree Parameters for Msti 1

Spanning Tree Status : ON,
Protocol : IEEE Multiple STP,
mode : FLAT (Single STP),
Priority : 32769 (0x8001),
Bridge ID : 8001-00:d0:95:6b:08:40,
Designated Root : 8001-00:d0:95:6b:08:40,
Cost to Root Bridge : 0,
Root Port : None,
Next Best Root Cost : 0,
Next Best Root Port : None,
TxHoldCount : 6,
Topology Changes : 0,
Topology age : 0:0:0
Current Parameters (seconds)
Max Age = 20,
Forward Delay = 15,
Hello Time = 2
Parameters system uses when attempting to become root
System Max Age = 20,
System Forward Delay = 15,
System Hello Time = 2

-> spantree mode per-vlan

-> show spantree msti

Spanning Tree Path Cost Mode : AUTO

** Inactive flat mode instances: **
Msti STP Status Protocol Priority (Prio:SysID)
-----+----------+--------+---------------------
0 ON MSTP 32768 (0x8000:0x0000)
2 ON MSTP 32770 (0x8000:0x0002)
3 ON MSTP 32771 (0x8000:0x0003)

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-83
show spantree msti Distributed Spanning Tree Commands

-> show spantree msti 0

per-vlan Spanning Tree is enforced !! (per-vlan mode)
INACTIVE Spanning Tree Parameters for Cist
Spanning Tree Status : ON,
Protocol : IEEE Multiple STP,
Priority : 32768 (0x8000),
TxHoldCount : 5,
System Max Age (seconds) = 20,
System Forward Delay (seconds) = 15,
System Hello Time (seconds) = 2

-> show spantree msti 2

per-vlan Spanning Tree is enforced !! (per-vlan mode)
INACTIVE Spanning Tree Parameters for Msti 2
Spanning Tree Status : ON,
Protocol : IEEE Multiple STP,
Priority : 32770 (0x8002),
TxHoldCount : 5,
System Max Age (seconds) = 20,
System Forward Delay (seconds) = 15,
System Hello Time (seconds) = 2

output definitions
Spanning Tree Path Cost The Spanning Tree path cost mode for the switch (32 BIT or AUTO)
Mode Configured through the spantree path-cost-mode command.
Msti The Multiple Spanning Tree Instance (MSTI) number. MSTI 0
represents the CIST. Configured through the spantree msti command.
STP Status The Spanning Tree state for the instance (ON or OFF).
Protocol The Spanning Tree protocol applied to the instance (STP, RSTP, or
MSTP). This value is not configurable for an MSTI. Configured
through the spantree protocol command.
Mode The Spanning Tree operating mode for the switch (per-vlan or flat).
Configured through the spantree mode command.
Priority The Spanning Tree bridge priority for the instance. The lower the
number, the higher the priority. Configured through the spantree
priority command.
Bridge ID The bridge identifier for this Spanning Tree instance. Consists of the
bridge priority value (in hex) concatenated with the dedicated bridge
MAC address.
CST Designated Root The bridge identifier for the root of the flat mode CIST instance. This
field only appears when MSTP is active on the switch.
Cost to CST Root The cost of the path to the root for the flat mode CIST instance. This
field only appears when MSTP is active on the switch.
Next CST Best Cost The cost of the next best root port for the flat mode CIST instance. This
field only appears when MSTP is active on the switch.
Designated Root The bridge identifier for the root of the Spanning Tree for this instance.
Cost to Root Bridge The cost of the path to the root for this Spanning Tree instance.
Root Port The port that offers the lowest cost path from this bridge to the root
bridge for this Spanning Tree instance.

page 7-84 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree msti

output definitions (continued)

Next Best Root Cost The cost of the next best root port for this Spanning Tree instance.
Next Best Root Port The port that offers the next best (second lowest) cost path to the root
bridge for this Spanning Tree instance.
TxHoldCount The count to limit the transmission of BPDU through the port.
Topology Changes The number of topology changes detected by this Spanning Tree
instance since the management entity was last reset or initialized.
Topology age The amount of time (in hundredths of seconds) since the last topology
change was detected by this Spanning Tree instance (hh:mm:ss or dd
days and hh:mm:ss).
Max Age The amount of time (in seconds) that Spanning Tree Protocol
information is retained before it is discarded. MSTIs inherit this value
from the CIST instance.
Forward Delay The amount of time (in seconds) that a port remains in the Listening
state and then the Learning state until it reaches the forwarding state.
This is also the amount of time used to age out all dynamic entries in
the Forwarding Database when a topology change occurs. MSTIs
inherit this value from the CIST instance.
Hello Time The amount of time (in seconds) between the transmission of
Configuration BPDUs on any port that is the Spanning Tree root or is
attempting to become the Spanning Tree root. MSTIs inherit this value
from the CIST instance.
System Max Age The Max Age value for the root bridge.
System Forward Delay The Forward Delay value for the root bridge.
System Forward Delay The Forward Delay value for the root bridge.

Release History
Release 8.1.1; command introduced.

Related Commands

show spantree Displays the Spanning Tree bridge configuration for the flat mode
CIST instance or a per-VLAN mode VLAN instance, depending on
which mode is active for the switch.
show spantree cist Displays the Spanning Tree bridge configuration for the CIST
instance regardless of which mode (per-VLAN or flat) is active on
the switch.
show spantree vlan Displays the Spanning Tree bridge configuration for a VLAN
instance regardless of which mode (per-VLAN or flat) is active on
the switch.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-85
show spantree msti Distributed Spanning Tree Commands

MIB Objects
vStpInsTable
vStpInsNumber
vStpInsMode
vStpInsProtocolSpecification
vStpInsPriority
vStpInsBridgeAddress
vStpInsTimeSinceTopologyChange
vStpInsTopChanges
vStpInsDesignatedRoot
vStpInsRootCost
vStpInsRootPortNumber
vStpInsNextBestRootCost
vStpInsNextBestRootPortNumber
vStpInsMaxAge
vStpInsHelloTime
vStpInsBridgeTxHoldCount
vStpInsForwardDelay
vStpInsBridgeMaxAge
vStpInsBridgeHelloTime
vStpInsBridgeForwardDelay
vStpInsCistRegionalRootId
vStpInsCistPathCost
vStpInsMstiNumber

page 7-86 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree vlan

show spantree vlan

Displays Spanning Tree bridge information for a per-VLAN mode VLAN instance.
show spantree vlan [vlan_id]

Syntax Definitions

vlan_id An existing VLAN ID number.

Defaults
By default, displays information for all VLAN instances.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If a vlan_id number is not specified, this command displays the Spanning Tree status, protocol, and
priority values for all VLAN instances.
• Specify a vlan_id number with this command to display Spanning Tree bridge information for a
specific VLAN instance.
• This command displays Spanning Tree bridge information for a VLAN instance regardless of which
mode (per-VLAN or flat) is active on the switch. Note that minimal information is displayed when this
command is used in the flat mode, as VLAN instances are not active in this mode.

Examples
-> spantree mode per-vlan
-> show spantree vlan
Spanning Tree Path Cost Mode : AUTO
Vlan STP Status Protocol Priority
-----+----------+--------+--------------
1 ON STP 32768 (0x8000)
2 ON STP 32768 (0x8000)
3 ON STP 32768 (0x8000)
4 ON STP 32768 (0x8000)
5 ON STP 32768 (0x8000)
6 ON STP 32768 (0x8000)

-> show spantree vlan 6

Spanning Tree Parameters for Vlan 6
Spanning Tree Status : ON,
Protocol : IEEE STP,
mode : Per VLAN (1 STP per-vlan),
Priority : 32768 (0x8000),
Bridge ID : 8000-00:d0:95:6a:f4:58,
Designated Root : 0000-00:00:00:00:00:00,
Cost to Root Bridge : 0,
Root Port : 1/1/1,

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-87
show spantree vlan Distributed Spanning Tree Commands

Next Best Root Cost : 0,

Next Best Root Port : 1/1/3,
Tx Hold Count : 6,
Topology Changes : 0,
Topology age : 00:00:00,
Current Parameters (seconds)
Max Age = 20,
Forward Delay = 15,
Hello Time = 2
Parameters system uses when attempting to become root
System Max Age = 20,
System Forward Delay = 15,
System Hello Time = 2

-> spantree mode flat

-> show spantree vlan 1
Single/Multiple Spanning Tree is enforced !! (flat mode)
INACTIVE Spanning Tree Parameters for Vlan 1
Spanning Tree Status : ON,
Protocol : IEEE Rapid STP,
Priority : 32768 (0x8000),
TxHoldCount : 5,
System Max Age (seconds) = 20,
System Forward Delay (seconds) = 5,
System Hello Time (seconds) = 5

output definitions
Spanning Tree Path Cost The Spanning Tree path cost mode for the switch (32 BIT or AUTO)
Mode Configured through the spantree path-cost-mode command.
Vlan The VLAN ID associated with the VLAN Spanning Tree instance.
Configured through the vlan commands
STP Status The Spanning Tree state for the instance (ON or OFF).
Protocol The Spanning Tree protocol applied to the VLAN instance (STP or
RSTP). Note that MSTP is not supported for a VLAN instance.
Configured through the spantree protocol command.
Mode The Spanning Tree operating mode for the switch (per-vlan or flat).
Configured through the spantree mode command.
Priority The Spanning Tree bridge priority for the instance. The lower the
number, the higher the priority. Configured through the spantree
priority command.
Bridge ID The bridge identifier for this Spanning Tree instance. Consists of the
bridge priority value (in hex) concatenated with the dedicated bridge
MAC address.
Designated Root The bridge identifier for the root of the Spanning Tree for this instance.
Cost to Root Bridge The cost of the path to the root for this Spanning Tree instance.
Root Port The port that offers the lowest cost path from this bridge to the root
bridge for this Spanning Tree instance.
Next Best Root Cost The cost of the next best root port for this Spanning Tree instance.
Next Best Root Port The port that offers the next best (second lowest) cost path to the root
bridge for this Spanning Tree instance.

page 7-88 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree vlan

output definitions (continued)

Tx Hold Count The count to limit the transmission of BPDU through the port.
Topology Changes The number of topology changes detected by this Spanning Tree
instance since the management entity was last reset or initialized.
Topology age The amount of time (in hundredths of seconds) since the last topology
change was detected by this Spanning Tree instance (hh:mm:ss or dd
days and hh:mm:ss).
Max Age The amount of time (in seconds) that Spanning Tree Protocol
information is retained before it is discarded. Configured through the
spantree max-age command.
Forward Delay The amount of time (in seconds) that a port remains in the Listening
state and then the Learning state until it reaches the forwarding state.
This is also the amount of time used to age out all dynamic entries in
the Forwarding Database when a topology change occurs. Configured
through the spantree forward-delay command.
Hello Time The amount of time (in seconds) between the transmission of
Configuration BPDUs on any port that is the Spanning Tree root or is
attempting to become the Spanning Tree root. Configured through the
spantree hello-time command.
System Max Age The Max Age value for the root bridge.
System Forward Delay The Forward Delay value for the root bridge.
System Forward Delay The Forward Delay value for the root bridge.

Release History
Release 8.1.1; command introduced.

Related Commands

show spantree Displays the Spanning Tree bridge configuration for the flat mode
CIST instance or a per-VLAN mode VLAN instance, depending on
which mode is active for the switch.
show spantree cist Displays the Spanning Tree bridge configuration for the CIST
instance regardless of which mode (per-VLAN or flat) is active on
the switch.
show spantree msti Displays the Spanning Tree bridge information for an MSTI when
the switch is operating in the per-VLAN or flat Spanning Tree
mode.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-89
show spantree vlan Distributed Spanning Tree Commands

MIB Objects
vStpInsTable
vStpInsNumber
vStpInsMode
vStpInsProtocolSpecification
vStpInsPriority
vStpInsBridgeAddress
vStpInsTimeSinceTopologyChange
vStpInsTopChanges
vStpInsDesignatedRoot
vStpInsRootCost
vStpInsRootPortNumber
vStpInsNextBestRootCost
vStpInsNextBestRootPortNumber
vStpInsMaxAge
vStpInsHelloTime
vStpInsBridgeTxHoldCount
vStpInsForwardDelay
vStpInsBridgeMaxAge
vStpInsBridgeHelloTime
vStpInsBridgeForwardDelay

page 7-90 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree ports

show spantree ports

Displays Spanning Tree port information.
show spantree ports [forwarding | blocking | active | configured]

Syntax Definitions

forwarding Displays Spanning Tree operational port parameters for ports that are
forwarding for the specified instance.
blocking Displays Spanning Tree operational port parameters for ports that are
blocked for the specified instance.
active Displays a list of active ports associated with the specified instance.
configured Displays Spanning Tree administrative port parameters for all ports
associated with the specified instance.

Defaults

parameter default
forwarding | blocking | active | all ports
configured

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the switch is operating in the per-VLAN mode, this command displays port information for the
VLAN instances.
• If the switch is operating in the flat mode and the protocol is STP or RSTP, this command displays port
information for the single flat mode instance.
• If the switch is operating in the flat mode and the protocol is set to MSTP, this command displays port
information for the MSTIs, including MSTI 0 (also known as the CIST).

Examples
-> spantree mode flat
-> spantree protocol rstp
-> show spantree ports

Brdge Port Oper Status Path Cost Role loop-guard Note

------+------+------------+---------+-------+-----------+-----
1 1/3 DIS 0 DIS DIS
1 1/4 DIS 0 DIS DIS
1 1/6 DIS 0 DIS DIS
1 1/7 DIS 0 DIS DIS
1 1/9 DIS 0 DIS DIS

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-91
show spantree ports Distributed Spanning Tree Commands

1 1/10 DIS 0 DIS DIS

1 0/1 BLK 0 ALT ENA ERR

-> spantree protocol mstp

-> show spantree ports
Msti Port Oper Status Path Cost Role loop-guard Note
------+------+------------+---------+-------+-----------+-----
1 1/3 DIS 0 DIS DIS
1 1/4 DIS 0 DIS DIS
1 1/6 DIS 0 DIS DIS
1 1/7 DIS 0 DIS DIS
1 1/9 DIS 0 DIS DIS
1 1/10 DIS 0 DIS DIS
1 0/1 BLK 0 ALT ENA ERR
10 1/1 FORW 19 DESG ENA

-> spantree mode per-vlan

-> show spantree ports

Vlan Port Oper Status Path Cost Role loop-guard Notes

-----+-----+------------+---------+-------+------------+--------
1 1/1/1 DIS 0 DIS DIS
1 1/1/2 DIS 0 DIS DIS
1 1/1/3 DIS 0 DIS DIS
1 1/1/4 DIS 0 DIS DIS
1 1/1/5 DIS 0 DIS DIS
1 1/1/6 DIS 0 DIS DIS

-> show spantree ports active

Brdge Port Oper Status Path Cost Role loop-guard Note
-----+------+------------+---------+-------+------------+-------
10 2/1 FORW 19 DESG ENA
172 2/8 FORW 19 ROOT DIS
1001 2/1 FORW 19 DESG DIS

-> show spantree ports blocking

Brdge Port Oper Status Path Cost Role loop-guard Note
------+------+------------+---------+-------+-----------+-------
1 0/1 BLK 19 DESG ENA ERR
172 2/8 BLK 29 ALT DIS

output definitions
Bridge, Msti, or Vlan The CIST instance, referred to as bridge 1 when either STP (802.1D) or
RSTP (802.1W) is the active protocol in the flat mode. The MSTI
number when MSTP is the active protocol in the flat mode. The VLAN
ID number when STP or RSTP is the active protocol in the per-VLAN
mode.
Port The slot number for the module and the physical port number or a
logical port. If the slot number is 0, then the port number refers to a link
aggregate logical port number (for example, 0/31).
Oper Status The port operational state as defined by application of the Spanning
Tree Protocol. Possible port operational states include: disabled,
blocking, learning, and forwarding.

page 7-92 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree ports

output definitions (continued)

Path Cost The contribution of this port to the path cost towards the Spanning Tree
root bridge that includes this port. Path cost is a measure of the distance
of the listed port from the root bridge in the number of hops.
Configured through the spantree msti path-cost or spantree vlan
path-costcommand.
Role The role of the port for this Spanning Tree instance. Possible port roles
are: root, designated, alternate, and backup.
loop-guard Displays if the loop-guard is enabled (ENA) or disabled (DIS) on the
port.
Note Displays a note if the port has entered the error violation state (ERR).
Then the port role of the port instance in that row becomes
insignificant.

Release History
Release 8.1.1; command introduced.
Release 8.2.1; loop-guard and Note output fields added.

Related Commands

show spantree cist ports Displays Spanning Tree port information for the flat mode CIST
instance when the switch is operating in the per-VLAN or flat
Spanning Tree mode.
show spantree msti ports Displays Spanning Tree port information for an MSTI when the
switch is operating in the per-VLAN or flat Spanning Tree mode.
show spantree vlan ports Displays Spanning Tree port information for VLAN instances when
the switch is operating in the per-VLAN or flat Spanning Tree
mode.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-93
show spantree ports Distributed Spanning Tree Commands

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortPriority
vStpInsPortEnable
vStpInsPortState
vStpInsPortManualMode
vStpInsPortPathCost
vStpInsPortDesignatedCost
vStpInsPortRole
vStpInsPortAdminConnectionType
vStpInsPortOperConnectionType
vStpInsPortAdminEdge
vStpInsPortAutoEdge
vStpInsPortRestrictedRole
vStpInsPortRestrictedTcn
vStpInsPortPrimaryPortNumber
vStpInsPortDesignatedRoot
vStpInsPortDesignatedBridge
vStpPortConfigPVST
vStpPortConfigStatePVST
vStpBridgeModePVST
vStpPortConfigTable
vStpPortConfigIfIndex
vStpPortConfigLoopGuard
vStpInsTable
vStpIns1x1VlanNumber
vStpPortTable
vStpPortState
vStpPortPathCost
vStpPortRole

page 7-94 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree cist ports

show spantree cist ports

Displays Spanning Tree port information for the flat mode Common and Internal Spanning Tree (CIST)
instance.
show spantree cist ports [forwarding | blocking | active | configured]

Syntax Definitions

forwarding Displays Spanning Tree operational port parameters for ports that are
forwarding for the CIST instance.
blocking Displays Spanning Tree operational port parameters for ports that are
blocked for the CIST instance.
active Displays a list of active ports associated with the specified instance.
configured Displays Spanning Tree administrative port parameters for the CIST
instance.

Defaults

parameter default
forwarding | blocking | active | all ports
configured

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command displays Spanning Tree port information for the flat mode CIST instance regardless of
which mode (per-VLAN or flat) is active for the switch.
• Note that minimal information is displayed when this command is used in the per-VLAN mode, as the
CIST is not active in this mode.

Examples
-> show spantree cist ports

Spanning Tree Port Summary for Cist

Oper Path Desig Prim. Op Op Loop
Port St Cost Cost Role Port Cnx Edg Guard Desig Bridge ID Note
-----+----+-------+-------+----+----+---+----+------+---------------------+--------
1/1/1 FORW 200000 52 ROOT 1/1 PTP EDG DIS 8000-00:30:f1:5b:37:73
1/1/2 DIS 0 0 DIS 1/2 NS No DIS 0000-00:00:00:00:00:00
1/1/3 DIS 0 0 DIS 1/3 NS EDG DIS 0000-00:00:00:00:00:00
1/1/4 DIS 0 0 DIS 1/4 NS No DIS 0000-00:00:00:00:00:00
1/1/5 DIS 0 0 DIS 1/5 NS EDG DIS 0000-00:00:00:00:00:00
1/1/6 DIS 0 0 DIS 1/6 NS EDG DIS 0000-00:00:00:00:00:00
1/1/7 DIS 0 0 DIS 1/7 NS EDG DIS 0000-00:00:00:00:00:00
1/1/8 DIS 0 0 DIS 1/8 NS No DIS 0000-00:00:00:00:00:00

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-95
show spantree cist ports Distributed Spanning Tree Commands

-> show spantree cist ports active

Spanning Tree Port Summary for Cist

Oper Path Desig Prim. Op Op Loop
Port St Cost Cost Role Port Cnx Edg Guard Desig Bridge ID Note
-----+----+-------+-------+----+----+----+----+------+---------------------+-------
1/1/1 FORW 200000 52 ROOT 1/1 PTP EDG DIS 8000-00:30:f1:5b:37:73

-> show spantree cist ports

Per Vlan Spanning Tree is enforced !! (Per VLAN mode)

INACTIVE Spanning Tree Parameters
Oper Path Desig Prim. Op Op Loop
Port St Cost Cost Role Port Cnx Edg Guard Desig Bridge ID Note
-----+----+-------+-------+----+-----+---+---+-------+-------------------+---------
1/1/1 DIS 0 0 DIS 1/1 NS NO DIS 0000-00:00:00:00:00:00
1/1/2 DIS 0 0 DIS 1/2 NS NO DIS 0000-00:00:00:00:00:00
1/1/3 DIS 0 0 DIS 1/3 NS NO DIS 0000-00:00:00:00:00:00
1/1/4 DIS 0 0 DIS 1/4 NS NO DIS 0000-00:00:00:00:00:00
1/1/5 DIS 0 0 DIS 1/5 NS NO DIS 0000-00:00:00:00:00:00

output definitions
Port The slot number for the module and the physical port number or a
logical port. If the slot number is 0, then the port number refers to a link
aggregate logical port number (for example, 0/31).
Oper St The port operational state as defined by application of the Spanning
Tree Protocol. Possible port operational states include: disabled,
blocking, listening, learning, and forwarding.
Path Cost The contribution of this port to the path cost towards the Spanning Tree
root bridge that includes this port. Path cost is a measure of the distance
of the listed port from the root bridge in the number of hops.
Configured through the spantree vlan path-cost command.
Desig Cost The path cost of the Designated Port of the segment connected to this
port. If this is the root bridge or the Spanning Tree status of the port is
administratively disabled, this value is 0.
Role The role of the port for this Spanning Tree instance. Possible port roles
are: root, designated, alternate, and backup.
Prim. Port The slot number for the module and the physical port number on that
module for the primary port associated with this Spanning Tree
instance. This information is only available if the port role is backup.
Op Cnx Operational connection type: PTP, NPT, or NS (nonsignificant).
Shows the current operational state of the port connection type. See the
spantree vlan connection command for more information.
Op Edg Operational connection type: EDG. Shows the current operational state
of the port connection type. See the spantree vlan connection
command for more information.
Loop Guard Displays if the loop-guard is enabled (ENA) or disabled (DIS) on the
port.
Desig Bridge ID The bridge identifier for the designated bridge for this port segment.
Note Displays the error violation state in case of violation.

page 7-96 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree cist ports

-> show spantree cist ports configured

Spanning Tree Port Admin Configuration for Vlan 1

Port Adm Man. Config Adm Adm Aut Rstr Rstr Role/ PVST+
Port Pri St. Mode Cost Cnx Edg Edg Tcn Root Guard Cfg Stat
-----+----+----+----+-------+----+----+----+----+-----------+-----------
1/1/1 7 ENA No 0 AUT No Yes No No AUT Off
1/1/2 7 ENA No 0 NPT No Yes No No AUT Off
1/1/3 7 ENA No 0 NPT No Yes No No AUT Off
1/1/4 7 ENA No 0 NPT No Yes No No AUT Off
1/1/5 7 ENA No 0 NPT No Yes No No AUT O

output definitions
Port The slot number for the module and the physical port number or a
logical port. If the slot number is 0, then the port number refers to a link
aggregate logical port number (for example, 0/31).
Port Pri The Spanning Tree priority for the port. The lower the number, the
higher the priority.
Adm St The Spanning Tree administrative status of the port: enabled or
disabled.
Man. Mode The manual mode setting for the port: yes indicates that the blocking or
forwarding state of the port was manually set and the port does not
participate in the Spanning Tree Algorithm; no indicates that the
Spanning Tree Algorithm is managing the port state. Configured
through the spantree vlan path-cost command.
Config Cost The configured path cost value for this port. Configured through the
spantree vlan path-cost command.
Adm Cnx The administrative connection type: PTP, NPT, or AUT. Configured
through the spantree vlan connection command.
Adm Edg The edge port administrative status: yes indicates that the port is an
admin edge port; no indicates that the port is not an admin edge port.
Configured through the spantree vlan connection command.
Aut Edg The edge port automatic status: yes indicates that the port is an
automatic edge port; no indicates that the port is not an automatic edge
port. Configured through the spantree cist auto-edge or spantree vlan
auto-edge command.
Rstr Tcn The restricted TCN capability: yes indicates that the port supports the
restricted TCN capability; no indicates that the port does not support
the restricted TCN capability. Configured through the spantree cist
restricted-tcn or spantree vlan restricted-tcn command.
Rstr Role The restricted role port status: yes indicates that the port is a restricted
role port; no indicates that the port is not a restricted role port.
Configured through the spantree cist restricted-role or spantree vlan
restricted-role command.

Release History
Release 8.1.1; command introduced.
Release 8.2.1; Loop Guard and Note output field added.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-97
show spantree cist ports Distributed Spanning Tree Commands

Related Commands

show spantree ports Implicit command for displaying Spanning Tree port information
for the flat mode CIST instance or a per-VLAN mode VLAN
instance.
show spantree msti ports Displays Spanning Tree port information for an MSTI when the
switch is operating in the per-VLAN or flat Spanning Tree mode.

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortPriority
vStpInsPortState
vStpInsPortEnable
vStpInsPortPathCost
vStpInsPortDesignatedCost
vStpInsPortDesignatedBridge
vStpInsPortAdminEdge
vStpInsPortAutoEdge
vStpInsPortRestrictedRole
vStpInsPortRestrictedTcn
vStpInsPortManualMode
vStpInsPortRole
vStpInsPrimaryPortNumber
vStpInsPortAdminConnectionType
vStpInsPortOperConnectionType

page 7-98 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree msti ports

show spantree msti ports

Displays Spanning Tree port information for a flat mode Multiple Spanning Tree Instance (MSTI).
show spantree msti [msti_id] ports [forwarding | blocking | active | configured]

Syntax Definitions

msti_id An existing MSTI ID number.

forwarding Displays Spanning Tree operational port parameters for ports that are
forwarding for the CIST instance.
blocking Displays Spanning Tree operational port parameters for ports that are
blocked for the CIST instance.
active Displays a list of active ports associated with the specified instance.
configured Displays Spanning Tree administrative port parameters for the CIST
instance.

Defaults

parameter default
msti_id all MSTIs
forwarding | blocking | active | all ports
configured

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If an msti_id number is not specified, this command displays the Spanning Tree port operational status,
path cost, and role values for all associated MSTIs.
• This command displays Spanning Tree port information for an MSTI regardless of which mode (per-
VLAN or flat) is active on the switch.
• Note that minimal information is displayed when this command is used in the per-VLAN mode, as
MSTIs are not active in this mode. In addition, if MSTP is not the selected flat mode protocol, this
command fails.
• The configured keyword is only available when an instance number is specified with this command. In
addition, this keyword cannot be used in combination with either the forwarding or blocking
keywords.
• Note that MSTI 0 also represents the CIST instance that is always present on the switch. To view the
CIST instance using this command, specify zero (0) for the msti_id number.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-99
show spantree msti ports Distributed Spanning Tree Commands

Examples
-> show spantree msti ports
Msti Port Oper Status Path Cost Role Loop Guard Note
-----+-----+------------+---------+-------+-----------+-------
0 1/1/1 FORW 200000 ROOT DIS
0 1/1/2 DIS 0 DIS DIS
0 1/1/3 DIS 0 DIS DIS
0 5/1/2 DIS 0 DIS DIS
1 1/1/1 FORW 200000 MSTR DIS

-> show spantree msti 0 ports

Per Vlan Spanning Tree is enforced !! (Per VLAN mode)

INACTIVE Spanning Tree Parameters
Oper Path Desig Prim. Op Op Loop
Port St Cost Cost Role Port Cnx Edg Guard Desig Bridge ID Note
-----+----+-------+-------+----+------+---+---+------+-------------------+---------
1/1/1 DIS 0 0 DIS 1/1/1 NS NO DIS 0000-00:00:00:00:00:00
1/1/2 DIS 0 0 DIS 1/1/2 NS NO DIS 0000-00:00:00:00:00:00
1/1/3 DIS 0 0 DIS 1/1/3 NS NO DIS 0000-00:00:00:00:00:00
1/1/4 DIS 0 0 DIS 1/1/4 NS NO DIS 0000-00:00:00:00:00:00
1/1/5 DIS 0 0 DIS 1/1/5 NS NO DIS 0000-00:00:00:00:00:00
1/1/6 DIS 0 0 DIS 1/1/6 NS NO DIS 0000-00:00:00:00:00:00
1/1/7 DIS 0 0 DIS 1/1/7 NS NO DIS 0000-00:00:00:00:00:00

-> show spantree msti 0 ports configured

Spanning Tree Port Admin Configuration for Vlan 1

Port Adm Man. Config Adm Adm Aut Rstr Rstr Role/ PVST+
Port Pri St. Mode Cost Cnx Edg Edg Tcn Root Guard Cfg Stat
-----+----+----+----+-------+----+----+----+----+-----------+-----------
1/1/1 7 ENA No 0 AUT No Yes No No AUT Off
1/1/2 7 ENA No 0 NPT No Yes No No AUT Off
1/1/3 7 ENA No 0 NPT No Yes No No AUT Off
1/1/4 7 ENA No 0 NPT No Yes No No AUT Off
1/1/5 7 ENA No 0 NPT No Yes No No AUT

output definitions
Msti The Multiple Spanning Tree Instance (MSTI) number. MSTI 0
represents the CIST. Configured through the spantree msti command.
Port The slot number for the module and the physical port number or a
logical port. If the slot number is 0, then the port number refers to a link
aggregate logical port number (for example, 0/31).
Oper St The port operational state as defined by application of the Spanning
Tree Protocol. Possible port operational states include: disabled,
blocking, listening, learning, and forwarding.
Path Cost The contribution of this port to the path cost towards the Spanning Tree
root bridge that includes this port. Path cost is a measure of the distance
of the listed port from the root bridge in the number of hops.
Configured through the spantree msti path-cost command.
Desig Cost The path cost of the Designated Port of the segment connected to this
port. If this is the root bridge or the Spanning Tree status of the port is
administratively disabled, this value is 0.

page 7-100 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree msti ports

output definitions (continued)

RSTR Role/ Root Guard The role of the port for this Spanning Tree instance. Possible port roles
are: root, designated, alternate, master, and backup.
Prim. Port The slot number for the module and the physical port number on that
module for the primary port associated with this Spanning Tree
instance. This information is only available if the port role is backup.
Op Cnx Operational connection type: PTP, NPT, or NS (nonsignificant).
Shows the current operational state of the port connection type. See the
spantree vlan connection command for more information.
Op Edg Operational connection type: EDG. Shows the current operational state
of the port connection type. See the spantree vlan connection
command for more information.
Loop Guard Displays if the loop-guard is enabled (ENA) or disabled (DIS) on the
port.
Desig Bridge ID The bridge identifier for the designated bridge for this port segment.
Note Displays the error violation state in case of violation.
PVST+ Cfg Indicates the current PVST+ port configuration (auto, enable or
disable).
PVST+ Stat Indicates the current status of the PVST+ mode (On or Off).

-> show spantree msti 2 ports configured

Spanning Tree Port Admin Configuration for Msti 2
Port Adm Man. Config Adm Adm Aut Rstr Rstr Role/
Port Pri St. Mode Cost Cnx Edg Edg Tcn Root Guard Opt.
-----+----+----+----+-------+----+----+----+----+----------+--------
1/1/1 7 ENA No 0 AUT No Yes No No DIS
1/1/2 7 ENA No 0 AUT No Yes No No DIS
1/1/3 7 ENA No 0 AUT No Yes No No DIS
1/1/4 7 ENA No 0 AUT No Yes No No DIS
1/1/5 7 ENA No 0 AUT No Yes No No DIS
1/1/6 7 ENA No 0 AUT No Yes No No DIS
1/1/7 7 ENA No 0 AUT No Yes No No DIS
1/1/8 7 ENA No 0 AUT No Yes No No DIS
1/1/9 7 ENA No 0 AUT No Yes No No DIS
1/1/10 7 ENA No 0 AUT No Yes No No DIS
1/1/11 7 ENA No 0 AUT No Yes No No DIS
1/1/12 7 ENA No 0 AUT No Yes No No DIS

output definitions
Port The slot number for the module and the physical port number or a
logical port. If the slot number is 0, then the port number refers to a link
aggregate logical port number (for example, 0/31).
Port Pri The Spanning Tree priority for the port. It is a numeric value and the
lower the number, the higher the priority. Configured through the
spantree priority command.
Adm St The Spanning Tree administrative status of the port: enabled - ENA or
disabled - DIS.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-101
show spantree msti ports Distributed Spanning Tree Commands

output definitions (continued)

Man. Mode The manual mode setting for the port: yes indicates that the blocking or
forwarding state of the port was manually set and the port does not
participate in the Spanning Tree Algorithm; no indicates that the
Spanning Tree Algorithm is managing the port state. Configured
through the spantree vlan path-cost command.
Config Cost The configured path cost value for this port. Configured through the
spantree msti path-cost command.
Adm Cnx The administrative connection type: PTP, NPT, or AUT. Configured
through the spantree vlan connection command.
Adm Edg The edge port administrative status: yes indicates that the port is an
admin edge port; no indicates that the port is not an admin edge port.
Configured through the spantree vlan connection command.
Aut Edg The edge port automatic status: yes indicates that the port is an
automatic edge port; no indicates that the port is not an automatic edge
port. Configured through the spantree cist auto-edge or spantree vlan
auto-edge command.
Rstr Tcn The restricted TCN capability: yes indicates that the port supports the
restricted TCN capability; no indicates that the port does not support
the restricted TCN capability. Configured through the spantree cist
restricted-tcn or spantree vlan restricted-tcn command.
Rstr Role The restricted role port status: yes indicates that the port is a restricted
role port; no indicates that the port is not a restricted role port.
Configured through the spantree cist restricted-role or spantree vlan
restricted-role command.

Release History
Release 8.1.1; command introduced.
Release 8.2.1; Loop Guard and Note output filed added.

Related Commands

show spantree ports Displays Spanning Tree port information for the flat mode CIST
instance or a per-VLAN mode VLAN instance.
show spantree cist ports Displays Spanning Tree port information for a CIST instance when
the switch is operating in the per-VLAN or flat Spanning Tree
mode.
show spantree vlan ports Displays Spanning Tree port information for a VLAN when the
switch is operating in the per-VLAN or flat Spanning Tree mode.

page 7-102 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree msti ports

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortPriority
vStpInsPortState
vStpInsPortEnable
vStpInsPortPathCost
vStpInsPortDesignatedCost
vStpInsPortDesignatedBridge
vStpInsPortAdminEdge
vStpInsPortAutoEdge
vStpInsPortRestrictedRole
vStpInsPortRestrictedTcn
vStpInsPortManualMode
vStpInsPortRole
vStpPortConfigPVST
vStpPortConfigStatePVST
vStpBridgeModePVST
vStpInsPrimaryPortNumber
vStpInsPortAdminConnectionType
vStpInsPortOperConnectionType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-103
show spantree vlan ports Distributed Spanning Tree Commands

show spantree vlan ports

Displays Spanning Tree port information for a VLAN instance.
show spantree vlan [vlan_id[-vlan_id2]] ports [forwarding | blocking | active | configured]

Syntax Definitions

vlan_id[-vlan_id2] An existing VLAN ID number. Use a hyphen to specify a range of

VLAN IDs (10-15)
forwarding Displays Spanning Tree operational port parameters for ports that are
forwarding for the CIST instance.
blocking Displays Spanning Tree operational port parameters for ports that are
blocked for the CIST instance.
active Displays a list of active ports associated with the specified instance.
configured Displays Spanning Tree administrative port parameters for the CIST
instance.

Defaults

parameter default
vlan_id all VLAN instances
forwarding | blocking | active | all ports
configured

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If a vlan_id number is not specified, this command displays the Spanning Tree port operational status,
path cost, and role values for all VLAN instances.
• Specifying a range of VLAN IDs is also allowed. Use a hyphen to indicate a contiguous range (e.g.,
show spantree vlan 10-15 ports). Note that only one VLAN entry—a single VLAN ID or a range of
VLAN IDs— is allowed with this command. Multiple entries are not accepted.
• This command displays Spanning Tree port information for a VLAN instance regardless of which
mode (per-VLAN or flat) is active for the switch.
• Note that minimal information is displayed when this command is used in the flat mode, as VLAN
instances are not active in this mode.
• The configured keyword is only available when a VLAN ID is specified with this command. In
addition, this keyword cannot be used in combination with either the forwarding or blocking
keywords.

page 7-104 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree vlan ports

Examples
-> show spantree vlan ports
Vlan Port Oper Status Path Cost Role Loop Guard Note
-----+-----+------------+---------+-------+-----------+----------
1 1/1/1 DIS 0 DIS DIS
1 1/1/2 DIS 0 DIS DIS
1 1/1/3 DIS 0 DIS DIS
1 1/1/4 DIS 0 DIS DIS
1 1/1/5 DIS 0 DIS DIS
1 1/1/6 DIS 0 DIS DIS
1 1/1/7 DIS 0 DIS DIS
1 1/1/8 DIS 0 DIS DIS
1 1/1/9 DIS 0 DIS DIS
1 1/1/10 DIS 0 DIS DIS
1 1/1/11 DIS 0 DIS DIS
1 1/1/12 FORW 19 DIS DIS

-> show spantree vlan 1 ports

Spanning Tree Port Summary for Vlan 1
Oper Path Desig Prim. Op Op Loop
Port St Cost Cost Role Port Cnx Edg Guard Desig Bridge ID Note
-----+----+-------+-------+----+------+---+---+-----+-----------------+---------
1/1/1 DIS 0 0 DIS 1/1/1 NS EDG DIS 0000-00:00:00:00:00:00
1/1/2 DIS 0 0 DIS 1/1/2 NS NO DIS 0000-00:00:00:00:00:00
1/1/3 DIS 0 0 DIS 1/1/3 NS NO DIS 0000-00:00:00:00:00:00
1/1/4 DIS 0 0 DIS 1/1/4 NS NO DIS 0000-00:00:00:00:00:00
1/1/5 DIS 0 0 DIS 1/1/5 NS NO DIS 0000-00:00:00:00:00:00
1/1/6 DIS 0 0 DIS 1/1/6 NS NO DIS 0000-00:00:00:00:00:00
1/1/7 DIS 0 0 DIS 1/1/7 NS NO DIS 0000-00:00:00:00:00:00
1/1/8 DIS 0 0 DIS 1/1/8 NS NO DIS 0000-00:00:00:00:00:00
1/1/9 DIS 0 0 DIS 1/1/9 NS NO DIS 0000-00:00:00:00:00:00
1/1/10 DIS 0 0 DIS 1/1/10 NS NO DIS 0000-00:00:00:00:00:00
1/1/11 DIS 0 0 DIS 1/1/11 NS NO DIS 0000-00:00:00:00:00:00
1/1/12 FORW 19 0 DIS 1/1/12PTP NO DIS 0001-00:d0:95:6a:79:50

-> show spantree vlan 1 ports active

Spanning Tree Port Summary for Vlan 1
Oper Path Desig Prim. Op Op Loop
Port St Cost Cost Role Port Cnx Edg Guard Desig Bridge ID Note
------+----+-------+------+----+------+---+---+-------+---------------+---------
1/1/12 FORW 19 0 DIS 1/1/12 PTP EDG DIS 0001-00:d0:95:6a:79:50

-> show spantree vlan 10-13 ports

Spanning Tree Port Summary for Vlan 10
Oper Path Desig Prim. Op Op Loop
Port St Cost Cost Role Port Cnx Edg Guard Desig Bridge ID Note
-----+----+-------+-------+----+-----+---+---+------+----------------+---------
1/1/46 DIS 0 0 DIS 1/1/46 NS EDG DIS 0000-00:00:00:00:00:00
Spanning Tree Port Summary for Vlan 11
Oper Path Desig Prim. Op Op Loop
Port St Cost Cost Role Port Cnx Edg Guard Desig Bridge ID Note
-----+----+-------+-------+----+-----+---+---+------+----------------+---------
1/1/36 DIS 0 0 DIS 1/1/36 NS EDG DIS 0000-00:00:00:00:00:00
1/1/37 DIS 0 0 DIS 1/1/37 NS NO DIS 0000-00:00:00:00:00:00
Spanning Tree Port Summary for Vlan 12
Oper Path Desig Prim. Op Op Loop
Port St Cost Cost Role Port Cnx Edg Guard Desig Bridge ID Note

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-105
show spantree vlan ports Distributed Spanning Tree Commands

-----+----+-------+-------+----+-----+---+---+------+----------------+---------
1/1/42 DIS 0 0 DIS 1/1/42 NS EDG DIS 0000-00:00:00:00:00:00
1/1/43 DIS 0 0 DIS 1/1/43 NS NO DIS 0000-00:00:00:00:00:00
Spanning Tree Port Summary for Vlan 13
Oper Path Desig Prim. Op Op Loop
Port St Cost Cost Role Port Cnx Edg Guard Desig Bridge ID Note
------+----+-------+-------+----+-----+---+---+-----+-----------------+---------
1/1/38 DIS 0 0 DIS 1/1/38 NS EDG DIS 0000-00:00:00:00:00:00

output definitions
Vlan The VLAN ID associated with the VLAN Spanning Tree instance.
Configured through the vlan commands
Port The slot number for the module and the physical port number or a
logical port. If the slot number is 0, then the port number refers to a link
aggregate logical port number (e.g., 0/31).
Oper St The port operational state as defined by application of the Spanning
Tree Protocol. Possible port operational states include: disabled,
blocking, listening, learning, and forwarding.
Path Cost The contribution of this port to the path cost towards the Spanning Tree
root bridge that includes this port. Path cost is a measure of the distance
of the listed port from the root bridge in the number of hops.
Configured through the spantree vlan path-cost command.
Desig Cost The path cost of the Designated Port of the segment connected to this
port. If this is the root bridge or the Spanning Tree status of the port is
administratively disabled, this value is 0.
Role The role of the port for this Spanning Tree instance. Possible port roles
are: root, designated, alternate, master, and backup.
Prim. Port The slot number for the module and the physical port number on that
module for the primary port associated with this Spanning Tree
instance. This information is only available if the port role is backup.
Op Cnx Operational connection type: PTP, NPT, or NS (nonsignificant).
Shows the current operational state of the port’s connection type. See
the spantree vlan connection command for more information.
Op Edg Operational connection type: EDG. Shows the current operational state
of the port’s connection type. See the spantree vlan connection
command for more information.
Loop Guard Displays if the loop-guard is enabled (ENA) or disabled (DIS) on the
port.
Desig Bridge ID The bridge identifier for the designated bridge for this port’s segment.
Note Displays the error violation state in case of violation.

page 7-106 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree vlan ports

-> show spantree vlan 1 ports configured

Spanning Tree Port Admin Configuration for Vlan 1
Port Adm Man. Config Adm Adm Aut Rstr Rstr Role/ PVST+
Port Pri St. Mode Cost Cnx Edg Edg Tcn Root Guard Cfg Stat
-----+----+----+----+-------+----+----+-----+----+---------+----------
1/1/1 7 ENA No 0 AUT No Yes No No AUT OFF
1/1/2 7 ENA No 0 AUT No Yes No No AUT OFF
1/1/3 7 ENA No 0 AUT No Yes No No AUT OFF
1/1/4 7 ENA No 0 AUT No Yes No No AUT OFF
1/1/5 7 ENA No 0 AUT No Yes No No AUT OFF
1/1/6 7 ENA No 0 AUT No Yes No No AUT OFF
1/1/7 7 ENA No 0 AUT No Yes No No AUT OFF
1/1/8 7 ENA No 0 AUT No Yes No No AUT OFF
1/1/9 7 ENA No 0 AUT No Yes No No AUT OFF
1/1/10 7 ENA No 0 AUT No Yes No No AUT OFF
1/1/11 7 ENA No 0 AUT No Yes No No AUT OFF
1/1/12 7 ENA No 0 AUT No Yes No No AUT OFF

-> show spantree vlan 10-13 ports configured

Spanning Tree Port Admin Configuration for Vlan 10
Port Adm Man. Config Adm Adm Aut Rstr Rstr Role/ PVST+
Port Pri St. Mode Cost Cnx Edg Edg Tcn Root Guard Cfg Stat
-----+----+----+----+-------+----+----+-----+----+---------+----------
1/1/46 7 ENA No 0 AUT No Yes No No AUT OFF
Spanning Tree Port Admin Configuration for Vlan 11
Port Adm Man. Config Adm Adm Aut Rstr Rstr Role/ PVST+
Port Pri St. Mode Cost Cnx Edg Edg Tcn Root Guard Cfg Stat
-----+----+----+----+-------+----+----+-----+----+---------+----------
1/1/36 7 ENA No 0 AUT No Yes No No AUT OFF
1/1/37 7 ENA No 0 AUT No Yes No No AUT OFF
Spanning Tree Port Admin Configuration for Vlan 12
Port Adm Man. Config Adm Adm Aut Rstr Rstr Role/ PVST+
Port Pri St. Mode Cost Cnx Edg Edg Tcn Root Guard Cfg Stat
-----+----+----+----+-------+----+----+-----+----+---------+----------
1/1/42 7 ENA No 0 AUT No Yes No No AUT OFF
1/1/43 7 ENA No 0 AUT No Yes No No AUT OFF
Spanning Tree Port Admin Configuration for Vlan 13
Port Adm Man. Config Adm Adm Aut Rstr Rstr Role/ PVST+
Port Pri St. Mode Cost Cnx Edg Edg Tcn Root Guard Cfg Stat
-----+----+----+----+-------+----+----+-----+----+---------+----------
1/1/38 7 ENA No 0 AUT No Yes No No AUT OFF

output definitions
Port The slot number for the module and the physical port number or a
logical port. If the slot number is 0, then the port number refers to a link
aggregate logical port number (e.g., 0/31).
Port Pri The Spanning Tree priority for the port (0–15). The lower the number,
the higher the priority. Configured through the spantree priority
command.
Adm St The Spanning Tree administrative status of the port: enabled or
disabled. Configured through the spantree vlan command to enable or
disable Spanning Tree on a port.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-107
show spantree vlan ports Distributed Spanning Tree Commands

output definitions (continued)

Man. Mode The manual mode setting for the port: yes indicates that the blocking or
forwarding state of the port was manually set and the port does not
participate in the Spanning Tree Algorithm; no indicates that the
Spanning Tree Algorithm is managing the port state. Configured
through the spantree loop-guard command.
Config Cost The configured path cost value for this port. Configured through the
spantree vlan path-cost command.
Adm Cnx The administrative connection type: PTP, NPT, or AUT. Configured
through the spantree vlan path-cost command.
Adm Edg The edge port administrative status: yes indicates that the port is an
admin edge port; no indicates that the port is not an admin edge port.
Configured through the spantree vlan connection command.
Aut Edg The edge port automatic status: yes indicates that the port is an
automatic edge port; no indicates that the port is not an automatic edge
port. Configured through the spantree cist auto-edge or spantree vlan
auto-edge command.
Rstr Tcn The restricted TCN capability: yes indicates that the port supports the
restricted TCN capability; no indicates that the port does not support
the restricted TCN capability. Configured through the spantree cist
restricted-tcn or spantree vlan restricted-tcn command.
Rstr Role/Root Guard The restricted status of the port: Yes indicates that the port is restricted
from becoming the root; No indicates that the port is not restricted from
becoming the root. Configured through the spantree cist restricted-
role or spantree vlan restricted-role command.
PVST+ Cfg The type of BPDU used on the port: AUTO indicates that IEEE
BPDUs are used until a PVST+ BPDU is detected; ENA indicates
that PVST+ BPDUs are used; DIS indicates that IEEE BPDUs are
used. Configured through the spantree pvst+compatibility command.
PVST+ Stat Indicates whether or not the PVST+ interoperability status is enabled
(ENA) or disabled (DIS) for the port. Configured through the spantree
pvst+compatibility command.

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; Loop Guard and Note output fields added.

page 7-108 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree vlan ports

Related Commands

show spantree ports Displays Spanning Tree port information for the flat mode CIST
instance or a per-VLAN mode VLAN instance.
show spantree cist ports Displays Spanning Tree port information for a CIST instance when
the switch is operating in the per-VLAN or flat Spanning Tree
mode.
show spantree msti ports Displays Spanning Tree port information for an MSTI when the
switch is operating in the per-VLAN or flat Spanning Tree mode.

MIB Objects
vStpInsPortTable
vStpInsPortNumber
vStpInsPortPriority
vStpInsPortState
vStpInsPortEnable
vStpInsPortPathCost
vStpInsPortDesignatedCost
vStpInsPortDesignatedBridge
vStpInsPortAdminConnectionType
vStpInsPortOperConnectionType
vStpInsPortAdminEdge
vStpInsPortAutoEdge
vStpInsPortRestrictedRole
vStpInsPortRestrictedTcn
vStpInsPortManualMode
vStpInsPortRole
vStpInsPrimaryPortNumber
vStpInsPortAdminConnectionType
vStpInsPortOperConnectionType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-109
show spantree mode Distributed Spanning Tree Commands

show spantree mode

Displays the current global Spanning Tree mode parameter values for the switch.
show spantree mode

Syntax Definition

NA

Defaults
NA

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The global parameters for spanning tree can be activated or configured using the related commands.

Examples
-> show spantree mode

Spanning Tree Global Parameters

Current Running Mode : Per VLAN,
Current Protocol : N/A (Per VLAN),
Path Cost Mode : 32 BIT,
Auto Vlan Containment : N/A
Cisco PVST+ mode : Disabled
Vlan Consistency check : Disabled

output definitions
Current Running Mode The spantree mode active on the switch. (Flat or Per VLAN)
Current Protocol The spantree protocol active on the switch.
Path Cost Mode The path cost mode value configured on the switch. (AUTO or 32 BIT)
Auto Vlan Containment The Auto VLAN containment mode configured on the switch
(Enabled or Disabled).
Cisco PVST+ mode The PVST+ mode configured on the switch (Enabled or Disabled).
Vlan Consistency check Specifies if VLAN consistency check is Enabled or Disabled on the
switch.

page 7-110 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree mode

Related Commands

spantree mode Assigns a flat Spanning Tree or per-VLAN Spanning Tree operating
mode for the switch.
spantree protocol Configures the Spanning Tree protocol for the flat mode Common and
Internal Spanning Tree (CIST) instance or for an individual VLAN
instance if the switch is running in the per-VLAN mode.
spantree path-cost-mode Configures the automatic selection of a 16-bit path cost for STP/RSTP
ports and a 32-bit path cost for MSTP ports or sets all path costs to use
a 32-bit value.
spantree pvst+compatibility Enables or disables PVST+ mode on the switch, port or link aggregate
enabling them to operate with Cisco switches.
spantree auto-vlan-containment Enables or disables Auto VLAN Containment (AVC).

Release History
Release 8.1.1; command introduced.

MIB Objects
vStpTable
vStpMode
vStpInsTable
vStpInsProtocolSpecification
vStpBridge
vStpPathCostMode
vStpMstRegionTable
vStpBridgeModePVST
vStpBridge
vStpBridgeAutoVlanContainment

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-111
show spantree mst Distributed Spanning Tree Commands

show spantree mst

Displays the Multiple Spanning Tree (MST) information for a MST region or the specified port or link
aggregate on the switch.
show spantree mst {region | port chassis/slot/port | linkagg linkagg_id}

Syntax Definitions

chassis The chassis identifier.

slot/port Specifies the slot number for the module and the physical port number
on that module.
linkagg_id Link aggregate ID number.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Three MST region attributes (configuration name, revision level, and configuration digest) define an
MST region as required by the IEEE 802.1Q 2005 standard. Switches that share the same values for
these attributes are all considered part of the same region. Currently each switch can belong to one
MST region at a time.
• This command is available when the switch is operating in either the per-VLAN or flat Spanning Tree
mode.
• Specify the port number or link aggregate ID along with the port or linkagg keyword to get
information related to the specified port or link aggregate.

Examples
-> show spantree mst region

Configuration Name = Region 1

Revision Level = 0
Configuration Digest = 0xac36177f 50283cd4 b83821d8 ab26de62
Revision Max hops = 20
Cist Instance Number = 0

output definitions
Configuration Name An alphanumeric string that identifies the name of the MST region. Use
the spantree mst region name command to define this value.
Revision Level A numeric value that identifies the MST region revision level for the
switch.

page 7-112 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree mst

output definitions (continued)

Configuration Digest An MST region identifier consisting of a 16 octet hex value (as per the
IEEE 802.1Q 2005 standard) that represents all defined MSTIs and
their associated VLAN ranges. Use the spantree msti and spantree
msti vlan commands to define VLAN to MSTI associations.
Revision Max hops The number of maximum hops authorized for region information.
Configured through the spantree mst region max-hops command.
Cist Instance Number The number of the CIST instance, which is currently zero as there is
only one region per switch. Therefore, only one CIST exists per switch
Note that this instance is also known as the flat mode instance and is
known as bridge 1 when using STP or RSTP.

-> show spantree mst port 1/1/2

MST Role State Pth Cst Edge Boundary Op Cnx Vlans loop-guard Note
---+------+-----+--------+----+--------+------+-------+-----------+------
0 DIS DIS 0 NO YES NS 1 ENA ERR
12 DIS DIS 0 NO YES NS DIS

-> show spantree mst linkagg 4

MST Role State Pth Cst Edge Boundary Op Cnx Vlans loop-guard Note
---+------+-----+--------+----+--------+------+-------+-----------+-------
0 DESG FORW 6000 NO NO NS 1 ENA
1 DESG FORW 0 NO NO NS ENA
2 DESG FORW 0 NO NO NS DIS

Release History
Release 8.1.1; command introduced.
Release 8.2.1; loop-guard and Note output fields added.

Related Commands

show spantree msti vlan-map Displays the range of VLANs associated to the specified MSTI.
show spantree cist vlan-map Displays the range of VLANs associated to the CIST instance.
show spantree map-msti Displays the MSTI that is associated to the specified VLAN

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-113
show spantree mst Distributed Spanning Tree Commands

MIB Objects
vStpMstRegionTable
vStpMstRegionNumber
vStpMstRegionConfigDigest
vStpMstRegionConfigName
vStpMstRegionConfigRevisionLevel
vStpMstRegionCistInstanceNumber
vStpMstRegionMaxHops
vStpPortConfigTable
vStpPortConfigIfIndex
vStpPortConfigLoopGuard
vStpInsTable
vStpIns1x1VlanNumber
vStpPortTable
vStpPortState
vStpPortPathCost
vStpPortRole

page 7-114 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree msti vlan-map

show spantree msti vlan-map

Displays the range of VLANs associated with the specified Multiple Spanning Tree Instance (MSTI).
show spantree msti [msti_id] vlan-map

Syntax Definitions

msti_id An existing MSTI ID number.

Defaults
By default, the VLAN to MSTI mapping is displayed for all MSTIs.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If an msti_id is not specified, then the VLAN to MSTI mapping for all defined MSTIs is displayed.

• This command is available when the switch is operating in either the per-VLAN or flat Spanning Tree
mode.
• Initially all VLANs are associated with the flat mode CIST instance.

Examples
-> show spantree msti vlan-map

Cist
Name :
VLAN list : 1-9,14-4094

Msti 1
Name :
VLAN list : 10-11

Msti 2
Name :
VLAN list : 12-13

-> show spantree msti 2 vlan-map

Msti 2
Name : MS1,
VLAN list : 12-13

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-115
show spantree msti vlan-map Distributed Spanning Tree Commands

output definitions
Cist Instance Identifies MSTI VLAN mapping information for the CIST instance.
Msti The MSTI ID number that identifies an association between a Spanning
Tree instance and a range of VLANs.
Name An alphanumeric value that identifies an MSTI name. Use the spantree
msti command to define an MSTI name.
VLAN list The range of VLAN IDs that are associated with this MSTI.

Release History
Release 8.1.1; command introduced.

Related Commands

show spantree mst Displays the MST region information for the switch.
show spantree cist vlan-map Displays the range of VLANs associated to the CIST instance.
show spantree map-msti Displays the MSTI that is associated to the specified VLAN

MIB Objects
vStpMstInstanceTable
vStpMstInstanceNumber
vStpMstInstanceName
vStpMstInstanceVlanBitmapState

page 7-116 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree cist vlan-map

show spantree cist vlan-map

Displays the range of VLANs associated with the flat mode Common and Internal Spanning Tree (CIST)
instance.
show spantree cist vlan-map

Syntax Definitions

NA

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command is available when the switch is operating in either the per-VLAN or flat Spanning Tree
mode.

Examples
-> show spantree cist vlan-map

Cist
Name : CIST1,
VLAN list : 1-9,14-4094

output definitions
Name An alphanumeric value that identifies the name of the CIST. Use the
spantree msti command to define a name for this instance.
VLAN list The range of VLAN IDs that are associated with the CIST instance.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-117
show spantree cist vlan-map Distributed Spanning Tree Commands

Related Commands

show spantree mst Displays the MST region information for the switch.
show spantree msti vlan-map Displays the range of VLANs associated to the specified MSTI.
show spantree map-msti Displays the MSTI that is associated to the specified VLAN

MIB Objects
vStpMstInstanceTable
vStpMstInstanceNumber
vStpMstInstanceName
vStpMstInstanceVlanBitmapState

page 7-118 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Distributed Spanning Tree Commands show spantree map-msti

show spantree map-msti

Displays the Multiple Spanning Tree Instance (MSTI) that is associated to the specified VLAN.
show spantree [vlan vlan_id] map-msti

Syntax Definitions

vlan_id An existing VLAN ID number.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is available when the switch is operating in either the per-VLAN or flat Spanning Tree
mode.
• Initially all VLANs are associated with the flat mode CIST instance.

Examples
-> show spantree map-msti

Vlan Msti/Cist(0)
------+--------------------------
200 1

Release History
Release 8.1.1; command introduced.

Related Commands

show spantree mst Displays the MST region information for the switch.
show spantree msti vlan-map Displays the range of VLANs associated to the specified MSTI.
show spantree cist vlan-map Displays the range of VLANs associated to the CIST instance.

MIB Objects
vStpMstVlanAssignmentTable
vStpMstVlanAssignmentVlanNumber
vStpMstVlanAssignmentMstiNumber

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 7-119
show spantree map-msti Distributed Spanning Tree Commands

page 7-120 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 8 Shortest Path Bridging
Commands

The Alcatel-Lucent OmniSwitch supports Shortest Path Bridging MAC (SPBM), as defined in the IEEE
802.1aq standard. SPB-M uses the Provider Backbone Bridge (PBB) network model to encapsulate (using
IEEE 802.1ah headers) and tunnel customer traffic through the network backbone. The shortest path trees
(SPTs) upon which the PBB network infrastructure operates are determined using a version of the
Intermediate System-to-Intermediate System (IS-IS) link state protocol that supports TLV extensions for
SPB (ISIS-SPB).
The SPBM network topology consists of two layers: the backbone infrastructure (control plane) layer and
the services (data plane) layer. ISIS-SPB builds the backbone layer by defining loop-free, SPTs through
the backbone network. The service layer is based on the PBB framework as defined in the IEEE 802.1ah
standard. SPBM supports the 802.1ah MAC-in-MAC method for data encapsulation. SPBM services
transport the encapsulated traffic over the ISIS-SPB infrastructure.
This chapter documents the Command Line Interface (CLI) commands used to configure and verify the
ISIS-SPB backbone. For commands used to configure and verify the SPBM services layer, see Chapter 47,
“Service Manager Commands.”
MIB information for the SPB commands is as follows:
Filename: ALCATEL-IND1-ISIS-SPB-MIB
Module: alcatelIND1IsisSpbMib
Filename: ALCATEL-IND1-VLAN-MGR-MIB
Module: alcatelIND1VLANMgrMIB
A summary of the available commands is listed here:

Global SPB Commands spb isis admin-state

spb isis area-address
spb isis bridge-priority
spb isis source-id
spb isis control-address
spb isis spf-wait
spb isis lsp-wait
SPB Backbone VLAN spb bvlan
(BVLAN) Commands spb isis bvlan ect-id
spb isis control-bvlan
spb isis bvlan tandem-multicast-mode
SPB Interface Commands spb isis interface

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-1
 Shortest Path Bridging Commands

SPB IP VPN Commands spb ipvpn bind

spb ipvpn redist
show spb ipvpn bind
show spb ipvpn redist
show spb ipvpn route-table
SPB Graceful Restart spb isis graceful-restart
Commands spb isis graceful-restart helper
SPB Show Commands show spb isis info
show spb isis bvlans
show spb isis interface
show spb isis adjacency
show spb isis database
show spb isis nodes
show spb isis unicast-table
show spb isis services
show spb isis spf
show spb isis multicast-table
show spb isis multicast-sources
show spb isis multicast-sources-spf
show spb isis ingress-mac-filter

page 8-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands spb bvlan

spb bvlan
Configures an SPB backbone VLAN (BVLAN).
spb bvlan {bvlan_id[-bvlan_id2]} [admin-state {enable | disable}] [name description]
no spb bvlan bvlan_id

Syntax Definitions

bvlan_id[-bvlan_id2] A numeric value that uniquely identifies an individual BVLAN. The

valid ID range is 1–4094. Use a hyphen to specify a range of BVLAN
IDs (10-20).
enable Enables the VLAN administrative status.
disable Disable the VLAN administrative status.
description An alphanumeric string. Optional name description for the VLAN ID.

Defaults

parameter default
enable | disable enable
description VLAN ID

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a BVLAN from the switch configuration. All BVLAN
ports are detached before the BVLAN is removed.

• The description can be any alphanumeric string. Enclose the description in double quotes if it contains
more than one word with a space in between.
• The BVLAN configuration must be the same on each SPB bridge to ensure proper ISIS-SPB neighbor
discovery and shortest path calculations throughout the provider backbone bridge (PBB) network.
• BVLANs differ from standard VLANs as follows:
– No Spanning Tree control—the Spanning Tree protocol is automatically disabled on each BVLAN,
and all ports associated with each BVLAN will remain in a forwarding state. However, Spanning
Tree can remain operational on other types of VLANs.
– No source MAC address learning—normal hardware learning is disabled on BVLANs. Instead, the
forwarding database (FDB) is populated by the ISIS-SPB protocol.
– There is no flooding of unknown destination or multicast frames.
– Ingress filtering based on the source MAC address—frames received on ports that do not have an
incoming source MAC address pre-programmed by ISIS-SPB are discarded.
• All BVLANs are automatically associated with all ISIS-SPB interfaces. Adding or removing BVLANs
from a specific SPB interface is not allowed.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-3
spb bvlan Shortest Path Bridging Commands

• The maximum number of BVLANs supported is four.

• BVLANs and standard VLANs can co-exist on the same bridge ports.

Examples
-> spb bvlan 200 name BVLAN-200
-> spb bvlan 720 admin-state disable
-> spb bvlan 500 name BVLAN-500 admin-state enable
-> no spb bvlan 1020

Release History
Release 8.1.1; command introduced.

Related Commands

spb isis control-bvlan Configures a control BVLAN

spb isis bvlan ect-id Assigns an equal cost tree (ECT) algorithm ID to the specified BVLAN.
spb isis bvlan tandem- Configures the tandem multicast mode for the specified SPB backbone
multicast-mode VLAN (BVLAN).
spb isis interface Configures ISIS-SPB network interfaces.
show spb isis bvlans Displays the BVLAN configuration for the switch.

MIB Objects
vlanTable
vlanNumber
vlanDescription
vlanAdmStatus
vlanOperStatus
vlanType

page 8-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands spb isis bvlan ect-id

spb isis bvlan ect-id

Configures the equal cost tree (ECT) identifier for the specified SPB backbone VLAN (BVLAN). The
ECT ID assigns a tie-breaking algorithm to the BVLAN that is used for shortest path tree (SPT)
calculations.
spb isis bvlan bvlan_id ect-id ect_id

Syntax Definitions

bvlan_id An existing BVLAN ID.

ect_id An ECT algorithm ID. The valid range is 1–16.

Defaults
By default, the next available ECT ID number is automatically assigned to a BVLAN when the BVLAN is
created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use this command to change the existing ECT ID number for the specified BVLAN on each SPB
brdige, as necessary, to make sure the specified BVLAN uses the same ECT ID throughout the
network.
• The BVLAN ID specified with this command must already exist in the switch configuration.

Examples
-> spb isis bvlan 200 ect-id 5
-> spb isis bvlan 720 ect-id 10

Release History
Release 8.1.1; command introduced.

Related Commands

spb bvlan Creates a SPB backbone VLAN (BVLAN).

show spb isis bvlans Displays the SPB BVLAN configuration for the switch.

MIB Objects
alcatelIND1IsisSpbEctStaticTable
alcatelIND1IsisSpbEctStaticEntryBaseVid

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-5
spb isis control-bvlan Shortest Path Bridging Commands

spb isis control-bvlan

Designates an existing BVLAN that will serve as the control BVLAN for the bridge. Only one BVLAN
per bridge is designated as the control BVLAN, which is used to exchange ISIS-SPB control packets with
neighboring SPB bridges on behalf of all the BVLANs configured for that bridge.
spb isis control-bvlan bvlan_id

Syntax Definitions

bvlan_id An existing BVLAN ID.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The BVLAN ID specified with this command must already exist in the switch configuration.

• The control BVLAN ID is the VLAN tag that is applied to ISIS-SPB control frames.

• Configuring an existing BVLAN as the control BVLAN does not exclude that VLAN from carrying
data traffic for the SPB domain. In other words, a single VLAN can serve as both a regular BVLAN
and the control BVLAN at the same time.

Examples
-> spb isis control-bvlan 200
-> spb isis control-bvlan 720

Release History
Release 8.1.1; command introduced.

Related Commands

spb bvlan Configures an SPB BVLAN.

show spb isis bvlans Displays the BVLAN configuration for the bridge.

MIB Objects
alcatelIND1IsisSpbSys
alcatelIND1IsisSpbSysControlBvlan

page 8-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands spb isis bvlan tandem-multicast-mode

spb isis bvlan tandem-multicast-mode

Configures the tandem multicast mode for the specified SPB backbone VLAN (BVLAN). This mode is
only applicable to associated SPB service instances that are configured to use the tandem replication mode
for multicast traffic.
spb isis bvlan bvlan_id tandem-multicast-mode {sgmode | gmode}

Syntax Definitions

bvlan_id An existing BVLAN ID.

sgmode Specifies the source and group (S,G) mode for the BVLAN.
gmode Specifies the any source and group (*,G)

Defaults
By default, BVLANs are configured to use the (S,G) mode.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The BVLAN ID specified with this command must already exist in the switch configuration.

• The (S,G) mode identifies a source-specific multicast distribution tree.

• The (*,G) mode identifies a shared multicast distribution tree.

Examples
-> spb isis bvlan 200 tandem-multicast-mode gmode
-> spb isis bvlan 720 tandem-multicast-mode sgmode

Release History
Release 8.1.1; command introduced.

Related Commands

spb bvlan Creates a SPB backbone VLAN (BVLAN).

show spb isis bvlans Displays the SPB BVLAN configuration for the switch.

MIB Objects
alcatelIND1IsisSpbEctStaticTable
alcatelIND1IsisSpbEctStaticEntryBaseVid
alcatelIND1IsisSpbEctStaticEntryMulticastMode

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-7
spb isis bridge-priority Shortest Path Bridging Commands

spb isis bridge-priority

Configures the bridge priority value for the SPB bridge. This value is used to rank an SPB bridge in
relation to other bridges.
spb isis bridge-priority priority

Syntax Definitions

priority A bridge priority value. The valid range is 0–65535.

Defaults
By default, the bridge priority value for the switch is set to 32768.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The lower the bridge priority number assigned, the higher the priority that is associated with the bridge.

• The bridge priority value makes up the upper two bytes of the eight-byte SPB bridge ID. The lower six
bytes of the Bridge ID contain the system ID, which is the dedicated bridge MAC address of the SPB
bridge.
• Setting a different bridge priority value on different SPB bridges will override the system identifier
significance during the shortest path tree (SPT) calculation.

Examples
-> spb isis bridge-priority 15
-> spb isis bridge-priority 32768

Release History
Release 8.1.1; command introduced.

Related Commands

show spb isis info Displays the status and configuration information for the SPB bridge.

MIB Objects
alcatelIND1IsisSpbSys
alcatelIND1IsisSpbSysBridgePriority

page 8-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands spb isis interface

spb isis interface

Configures the specified port or link aggregate as an ISIS-SPB interface on which protocol data units
(PDUs) are sent and received to detect neighbors and form adjacencies with other SPB bridges in the
network.
spb isis interface {port chassis_id/slot/port[-port2] | linkagg agg_id[-agg_id2]} [admin-state {enable |
disable} [hello-interval seconds] [hello-multiplier count] [metric metric]
no spb isis interface [port chassis_id/slot/port[-port2] | linkagg agg_id[-agg_id2]]

Syntax Definitions

chassis The chassis identifier.

slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
enable Administratively enables the SPB interface.
disable Administratively disables the SPB interface.
seconds The amount of time, in seconds, to wait between each transmission of a
hello packet from this interface. The valid range is 1–20000.
count An integer value that is multiplied by the hello interval time to
determine the amount of time, in seconds, a receiving bridge holds onto
the hello packets transmitted from this interface. The valid range is 2–
100.
metric An integer value that specifies the link cost to reach the destination
BMAC. The valid range is 1–16777215.

Defaults

parameter default
enable | disable enable
seconds 9
count 3
metric 10

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the ISIS-SPB interface.

• When configuring a link aggregate as an SPB interface, make sure the link aggregate ID number
already exists in the switch configuration.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-9
spb isis interface Shortest Path Bridging Commands

• All SPB interfaces are automatically assigned to all existing BVLANs. There is one ISIS-SPB instance
per switch, and each BVLAN and SPB interface are associated with that instance.
• If the SPB interface metric value is set to a different value for each side of a link, the highest metric
value is applied to the entire link.
• Administratively enabling ISIS-SPB on the switch triggers ISIS hello packet transmissions on all SPB
interfaces.
• SPB interfaces are typically the Network Network Interface (NNI) ports that carry encapsulated
customer data traffic through the Provider Backbone Bridging (PBB) network.
• Note that configuring a port or link aggregate as an SPB interface does not prevent configuration of
other VLAN tagging on that port. In other words, the SPB interface can forward regular traffic for
other VLAN types in addition to encapsulated SPBM traffic.

Examples
-> spb isis interface port 4/1/7
-> spb isis interface port 4/1/7 hello-interval 60
-> spb isis interface linkagg 3
-> spb isis interface linkagg 3 hello-multiplier 10
-> spb isis interface port 1/1/10 hello-interval 20 hello-multiplier 5 metric 2
-> no spb isis interface port 4/1/7
-> no spb isis interface linkagg 3

Release History
Release 8.1.1; command introduced.

Related Commands

show spb isis interface Displays the ISIS-SPB interface configuration for the bridge.

MIB Objects
alcatelIND1IsisSpbAdjStaticTable
alcatelIND1IsisSpbAdjStaticEntryIfIndex
alcatelIND1IsisSpbAdjStaticEntryMetric
alcatelIND1IsisSpbAdjStaticEntryHelloInterval
alcatelIND1IsisSpbAdjStaticEntryHelloMultiplier
alcatelIND1IsisSpbAdjStaticEntryIfAdminState

page 8-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands spb ipvpn bind

spb ipvpn bind

Binds a virtual routing and forwarding (VRF) instance, a Shortest Path Bridging (SPB) service instance
identifier (ISID), and an IP gateway together to enable the bidirectional exchange of routes between the
VRF and SPB ISID via the Global Route Manager (GRM).
spb ipvpn bind vrf {vrf_name | default} isid instance_id gateway ip_address {all-routes | import-route-
map route_map_name}
no spb ipvpn bind vrf {vrf_name | default} isid instance_id gateway ip_address

Syntax Definitions

vrf_name | default The name of an existing VRF instance for which routes are imported
from the Global Routing Table (GRT) to ISIS-SPB. Enter default to
specify the default VRF instance.
instance_id An existing ISID that identifies a Shortest Path Bridging (SPB) service
in a provider backbone bridge (PBB) network.
ip_address The IPv4 address of an IP interface that is associated with the specified
VRF instance.
all-routes Imports or exports all routes for this bind entry.
route_map_name The name of an existing route map to use for filtering VRF routes that
are imported from the GRT to ISIS-SPB for this bind entry. There is no
filtering from ISIS-SPB to the GRT.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the VRF-ISID bind entry. When the bind is deleted, all
routes imported and exported for this binding are retracted.
• The specified VRF name, ISID, gateway IP address, and optional route map name must already exist in
the local switch configuration.
• Only one ISID can be bound to a single VRF/IP gateway.

• The VRF-ISID binding is only active when the VRF exists, the ISID is configured on the local switch,
and the gateway IP address is associated with an active IP interface that is associated with the VRF
instance.
• An active "bind" entry causes ISIS-SPB to export learned routes from the SPB network to the GRM
and triggers the GRM to send IP routes from the corresponding VRF to ISIS-SPB using the ISID and
gateway IP address as the next hop.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-11
spb ipvpn bind Shortest Path Bridging Commands

• Routing over SPB requires a physical loopback port configuration in which a pair of loopback ports
provide connectivity between VRFs and SPB service access points (SAPs). A VRF-ISID binding
identifies the loopback port configuration that will do Layer 3 forwarding on the VRF side of the
loopback and SPB bridging on the SAP side of the loopback.

Examples
-> spb ipvpn bind vrf1 isid 1000 gateway 10.1.1.1 all-routes
-> spb ipvpn bind vrf2 isid 2000 gateway 20.2.2.1 import-route-map rm_vrf2
-> no spb ipvpn bind vrf1 isid 1000 gateway 10.1.1.1

Release History
Release 7.3.2; command introduced.

Related Commands

spb ipvpn redist Configures the redistribution of routes from a VRF to an ISID or
from one ISID to another ISID.
show spb ipvpn bind Displays VRF-to-ISID bindings that enable the import and export of
routes between VRFs and ISIDs.

MIB Objects
alcatelIND1SpbIPVPNBindTable
alcatelIND1SpbIPVPNBindTableEntryTopIx,
alcatelIND1SpbIPVPNBindVrfName,
alcatelIND1SpbIPVPNBindIsid,
alcatelIND1SpbIPVPNBindGateway
alcatelIND1SpbIPVPNBindImportRouteMap
alcatelIND1SpbIPVPNBindRowStatus

page 8-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands spb ipvpn redist

spb ipvpn redist

Configures the redistribution of routes from a VRF to an ISID or from one ISID to another ISID.
spb ipvpn redist {source-vrf {vrf_name | default} | source-isid instance_id} destination-isid instance_id
{all-routes | route-map route_map_name}
no spb ipvpn redist {source-vrf vrf_name | source-isid instance_id} destination-isid instance_id

Syntax Definitions

vrf_name | default The source VRF instance from which routes are redistributed. Enter
default to specify the default VRF instance.
source-isid instance_id The source ISID from which routes are redistributed.
destination-isid instance_id The destination ISID to which routes from either the source VRF or
source ISD are redistributed.
all-routes Imports or exports all routes for this bind entry.
route_map_name The name of an existing route map to use for filtering routes that are
redistributed.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the redistribution entry.

• The specified VRF name, ISID, and optional route map name must already exist in the local switch
configuration.
• A redistribution entry is only active when the ISID belongs to an active bind entry. This applies to both
ISIDs when redistributing between a source and destination ISID.
• An ISID cannot be bound and redistributed to the same VRF instance.

Examples
-> spb ipvpn redist source-isid 1000 destination-isid 2000 all-routes
-> spb ipvpn redist source-isid 2000 destination-isid 1000 all-routes
-> spb ipvpn redist source-vrf vrf1 destination-isid 3000 route-map rm_isid2000
-> no spb ipvpn redist source-vrf vrf1 destination-isid 3000
-> no spb ipvpn redist source-isid 2000 destination isid 1000

Release History
Release 7.3.2; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-13
spb ipvpn redist Shortest Path Bridging Commands

Related Commands

spb ipvpn bind Binds a VRF instance, an ISID, and an IP gateway together to
enable the bidirectional exchange of routes between the VRF and
ISID via the GRM.
show spb ipvpn redist Displays the SPB IPVPN redistribution configuration for the
switch.

MIB Objects
alcatelIND1SpbIPVPNRedistIsidTable
alcatelIND1SpbIPVPNRedistIsidTableEntryTopIx
alcatelIND1SpbIPVPNRedistIsidSourceIsid
alcatelIND1SpbIPVPNRedistIsidDestIsid
alcatelIND1SpbIPVPNRedistIsidRouteMap
alcatelIND1SpbIPVPNRedistIsidRowStatus
alcatelIND1SpbIPVPNRedistVrfTable
alcatelIND1SpbIPVPNRedistVrfTableEntryTopIx
alcatelIND1SpbIPVPNRedistVrfSourceVrf
alcatelIND1SpbIPVPNRedistVrfDestIsid
alcatelIND1SpbIPVPNRedistVrfRouteMap
alcatelIND1SpbIPVPNRedistVrfRowStatus

page 8-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands show spb ipvpn bind

show spb ipvpn bind

Displays VRF-to-ISID bindings that enable the import and export of routes between VRFs and ISIDs.
show spb ipvpn bind [vrf {vrf_name | default}] [isid instance_id]

Syntax Definitions

vrf_name | default The name of a VRF instance that is associated with an SPB IPVPN
binding. Enter default to specify the default VRF instance.
instance_id An ISID number that is associated with an SPB IPVPN binding.

Defaults
By default, all SPB IPVPN bindings are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the vrf and isid parameters to display the configuration for specific bindings.

Examples
-> show spb ipvpn bind
Legend: * indicates bind entry is active
SPB IPVPN Bind Table:
VRF ISID Gateway Route-Map
--------------------+------------+----------------------+----------------------
* ospf 4001 1.1.1.2
* ospf1 4003 2.2.2.2

Total Bind Entries: 2

output definitions
VRF The name of the VRF instance associated with this binding.
ISID The ISID number associated with this binding.
Gateway The gateway IP address associated with this binding. This is the IP
address specified for an IP interface that is associated with the VRF in
this binding.
Route-Map The name of an IP route map or All Routes.

Release History
Release 7.3.2; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-15
show spb ipvpn bind Shortest Path Bridging Commands

Related Commands

spb ipvpn bind Binds a VRF instance, an ISID, and an IP gateway together to
enable the bidirectional exchange of routes between the VRF and
ISID via the GRM.
show spb ipvpn redist Displays the SPB IP VPN redistribution configuration for the
switch.
show spb ipvpn route-table Displays the contents of the SPB IPVPN route table.

MIB Objects
alcatelIND1SpbIPVPNBindTable
alcatelIND1SpbIPVPNBindTableEntryTopIx,
alcatelIND1SpbIPVPNBindVrfName,
alcatelIND1SpbIPVPNBindIsid,
alcatelIND1SpbIPVPNBindGateway
alcatelIND1SpbIPVPNBindImportRouteMap
alcatelIND1SpbIPVPNBindRowStatus

page 8-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands show spb ipvpn redist

show spb ipvpn redist

Displays the SPB IPVPN redistribution configuration for the switch. This configuration controls the
redistribution of IP VPN routes from ISID to ISID or from VRF to ISID.
show spb ipvpn redist [vrf | [isid]

Syntax Definitions

vrf Displays the VRF redistribution table.

isid Displays the ISID redistribution table.

Defaults
By default, both the VRF and ISID redistribution tables are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the isid parameter to display the contents of the ISID redistribution table (ISID to ISID).

• Use the vrf parameter to display the contents of the VRF redistribution table (VRF to ISID).

Examples
-> show spb ipvpn redist
Legend: * indicates redist entry is active
SPB IPVPN Redist ISID Table:
Source-ISID Destination-ISID Route-Map
----------------------+--------------------+--------------------
* 4001 4003
* 4003 4001

Total Redist ISID Entries: 2

Legend: * indicates redist entry is active

SPB IPVPN Redist VRF Table:
Source-VRF Destination-ISID Route-Map
----------------------+--------------------+--------------------

Total Redist Vrf Entries: 0

-> show spb ip redist isid

Legend: * indicates redist entry is active
SPB IPVPN Redist ISID Table:
Source-ISID Destination-ISID Route-Map
----------------------+--------------------+--------------------
* 4001 4003
* 4003 4001

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-17
show spb ipvpn redist Shortest Path Bridging Commands

-> show spb ip redist vrf

Legend: * indicates redist entry is active
SPB IPVPN Redist VRF Table:
Source-VRF Destination-ISID Route-Map
----------------------+--------------------+--------------------

Total Redist Vrf Entries: 0

output definitions
Source-ISID The ISID number from which routes are redistributed to the destination
ISID.
Source-VRF The name of the VRF instance from which routes are redistributed to
the destination ISID.
Destination-ISID The ISID number to which routes are redistributed from another ISID
or from a VRF instance.
Route-Map The name of an IP route map that is used to filter the redistributed
routes.

Release History
Release 7.3.2; command introduced.

Related Commands

spb ipvpn redist Configures the redistribution of routes from a VRF to an ISID or
from one ISID to another ISID.
show spb ipvpn bind Displays the VRF-ISID binding configuration.
show spb ipvpn route-table Displays the contents of the SPB IPVPN route table.

MIB Objects
alcatelIND1SpbIPVPNRedistIsidTable
alcatelIND1SpbIPVPNRedistIsidTableEntryTopIx
alcatelIND1SpbIPVPNRedistIsidSourceIsid
alcatelIND1SpbIPVPNRedistIsidDestIsid
alcatelIND1SpbIPVPNRedistIsidRouteMap
alcatelIND1SpbIPVPNRedistIsidRowStatus
alcatelIND1SpbIPVPNRedistVrfTable
alcatelIND1SpbIPVPNRedistVrfTableEntryTopIx
alcatelIND1SpbIPVPNRedistVrfSourceVrf
alcatelIND1SpbIPVPNRedistVrfDestIsid
alcatelIND1SpbIPVPNRedistVrfRouteMap
alcatelIND1SpbIPVPNRedistVrfRowStatus

page 8-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands show spb ipvpn route-table

show spb ipvpn route-table

Displays the contents of the SPB IPVPN route table.
show spb ipvpn route-table [isid instance_id]

Syntax Definitions

instance_id An ISID number.

Defaults
By default, all routes for all ISIDs are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the isid parameter to display information for specific ISID routes.

Examples
-> show spb ipvpn route-table
Legend: * indicates IPVPN route has matching locally configured ISID
SPB IPVPN Route Table:
Source Bridge
ISID Destination Gateway (Name : BMAC) Metric
---------+--------------------+-----------------+---------------------------+------
* 4001 1.1.1.0/24 1.1.1.1 L2-DUT1 : 00:e0:b1:db:c3:65 1
* 4001 1.1.1.0/24 1.1.1.2 L2-DEV1 : e8:e7:32:00:23:f9 1
* 4001 2.2.2.0/24 1.1.1.2 L2-DEV1 : e8:e7:32:00:23:f9 1
* 4001 10.10.10.0/24 1.1.1.1 L2-DUT1 : 00:e0:b1:db:c3:65 1
* 4001 15.1.1.0/24 1.1.1.1 L2-DUT1 : 00:e0:b1:db:c3:65 1
* 4001 15.1.2.0/24 1.1.1.1 L2-DUT1 : 00:e0:b1:db:c3:65 1
* 4001 15.1.3.0/24 1.1.1.1 L2-DUT1 : 00:e0:b1:db:c3:65 1
* 4001 15.1.4.0/24 1.1.1.1 L2-DUT1 : 00:e0:b1:db:c3:65 1
* 4001 15.1.5.0/24 1.1.1.1 L2-DUT1 : 00:e0:b1:db:c3:65 1
* 4001 20.20.20.0/24 1.1.1.2 L2-DEV1 : e8:e7:32:00:23:f9 1
* 4001 25.1.1.0/24 1.1.1.2 L2-DEV1 : e8:e7:32:00:23:f9 1
* 4001 25.1.2.0/24 1.1.1.2 L2-DEV1 : e8:e7:32:00:23:f9 1
* 4001 25.1.3.0/24 1.1.1.2 L2-DEV1 : e8:e7:32:00:23:f9 1
* 4001 25.1.4.0/24 1.1.1.2 L2-DEV1 : e8:e7:32:00:23:f9 1
* 4001 25.1.5.0/24 1.1.1.2 L2-DEV1 : e8:e7:32:00:23:f9 1
* 4003 1.1.1.0/24 2.2.2.2 L2-DEV1 : e8:e7:32:00:23:f9 1
* 4003 2.2.2.0/24 2.2.2.1 L2-DUT2 : 00:e0:b1:dd:99:db 1
* 4003 2.2.2.0/24 2.2.2.2 L2-DEV1 : e8:e7:32:00:23:f9 1
* 4003 10.10.10.0/24 2.2.2.2 L2-DEV1 : e8:e7:32:00:23:f9 1
* 4003 15.1.1.0/24 2.2.2.2 L2-DEV1 : e8:e7:32:00:23:f9 1
* 4003 15.1.2.0/24 2.2.2.2 L2-DEV1 : e8:e7:32:00:23:f9 1
* 4003 15.1.3.0/24 2.2.2.2 L2-DEV1 : e8:e7:32:00:23:f9 1
* 4003 15.1.4.0/24 2.2.2.2 L2-DEV1 : e8:e7:32:00:23:f9 1
* 4003 15.1.5.0/24 2.2.2.2 L2-DEV1 : e8:e7:32:00:23:f9 1
* 4003 20.20.20.0/24 2.2.2.1 L2-DUT2 : 00:e0:b1:dd:99:db 1

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-19
show spb ipvpn route-table Shortest Path Bridging Commands

* 4003 25.1.1.0/24 2.2.2.1 L2-DUT2 : 00:e0:b1:dd:99:db 1

* 4003 25.1.2.0/24 2.2.2.1 L2-DUT2 : 00:e0:b1:dd:99:db 1
* 4003 25.1.3.0/24 2.2.2.1 L2-DUT2 : 00:e0:b1:dd:99:db 1
* 4003 25.1.4.0/24 2.2.2.1 L2-DUT2 : 00:e0:b1:dd:99:db 1
* 4003 25.1.5.0/24 2.2.2.1 L2-DUT2 : 00:e0:b1:dd:99:db 1

Routes: 30

output definitions
ISID The ISID number associated with this route.
Destination Destination IP address. Also includes the mask prefix length notation
after the address to indicate the subnet mask value. For example, /24
indicates the destination IP address has a 24-bit mask (255.255.255.0).
Gateway IP address of the gateway from which this route was learned.
Source Bridge The name and BMAC address of the SPB BEB switch that advertised
(Name : BMAC) the route.
Metric The metric or cost (hop count) for the route. Indicates a priority for the
route. The lower the metric value, the higher the priority.

Release History
Release 7.3.2; command introduced.

Related Commands

show spb ipvpn redist Displays the SPB IPVPN redistribution configuration for the
switch.
show spb ipvpn bind Displays the VRF-ISID binding configuration.

MIB Objects
alcatelIND1SpbIPVPNRouteTable
alcatelIND1SpbIPVPNRouteTableEntryTopIx
alcatelIND1SpbIPVPNRouteIsid
alcatelIND1SpbIPVPNRoutePrefix
alcatelIND1SpbIPVPNRoutePrefixLen
alcatelIND1SpbIPVPNRouteGateway
alcatelIND1SpbIPVPNRouteNodeName
alcatelIND1SpbIPVPNRouteMetric

page 8-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands spb isis admin-state

spb isis admin-state

Enables or disables the administrative status of ISIS-SPB instance for the switch.
spb isis admin-state {enable | disable}

Syntax Definitions

enable Administratively enables ISIS-SPB for the switch.

disable Administratively disables ISIS-SPB for the switch.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
When the ISIS-SPB status is disabled, the configuration settings and related statistics of the protocol
remain unaffected.

Examples
-> spb isis admin-state enable
-> spb isis admin-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

show spb isis info Displays status and configuration information for the SPB instance.

MIB Objects
alcatelIND1IsisSpbSys
alcatelIND1IsisSpbSysAdminState

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-21
spb isis area-address Shortest Path Bridging Commands

spb isis area-address

Configures the area address for the ISIS-SPB instance.
spb isis area-address area_address

Syntax Definitions

area_address A 3-byte integer that specifies the ISIS-SPB area address to join.

Defaults
By default, the area address is set to 0.0.0. for ISIS-SPB.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The default setting of 0.0.0 is the area address typically used for ISIS-SPB.

• Changing the area address with this command is allowed, but make sure to configure each bridge that
will participate in the ISIS-SPB instance with the same area address value.
• ISIS-SPB and ISIS-IP instances may co-exist on the same bridge.

Examples
-> spb isis area-address 1.1.1
-> spb isis area-address 0.0.0

Release History
Release 8.1.1; command was introduced.

Related Commands

show spb isis info Displays status and configuration information for the SPB instance.

MIB Objects
alcatelIND1IsisSpbSys
alcatelIND1IsisSpbSysAreaAddress

page 8-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands spb isis source-id

spb isis source-id

Configures the shortest path (SP) source identifier value for the SPB bridge. This value identifies the
source of multicast frames and is relevant only in multicast tandem replication mode.
spb isis source- id {source_id | auto}

Syntax Definitions

source_id A source identifier entered as xx-xx-xx, where xx is a hexidecimal value.

auto Changes the source ID back to the default value.

Defaults
By default, the last three least significant bytes of the system ID is used for the source ID.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The source ID is the high order 3 bytes for the Group Address DA for the SPB bridge. Note that only 20
bits are used; the top 4 bits are not used.

Examples
-> spb isis source-id 00-2a-1d
-> spb isis source-id 07-0b-d3
-> spb isis source-id auto

Release History
Release 8.1.1; command introduced.

Related Commands

show spb isis info Displays status and configuration information for the SPB instance.

MIB Objects
alcatelIND1IsisSpbSys
alcatelIND1IsisSpbmSysSPSourceId

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-23
spb isis control-address Shortest Path Bridging Commands

spb isis control-address

Changes the ISIS-SPB control MAC address, which is used as the destination address for ISIS-SPB
control packets.
spb isis control-address {alll1 | alll2 | allis}

Syntax Definitions

alll1 All Level 1 Intermediate Systems (01:80:C2:00:00:14).

alll2 All Level 2 Intermediate Systems (01:80:C2:00:00:15).
allis All Intermediate Systems (09:00:2B:00:00:05).

Defaults
By default, the control MAC address is set to AllL1.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Changing the ISIS-SPB control MAC address on the OmniSwitch can enhance interoperability with third-
party ISIS-SPB devices.

Examples
-> spb isis control-address alll1
-> spb isis control-address alll2
-> spb isis control-address allis

Release History
Release 8.1.1; command introduced.

Related Commands

show spb isis info Displays the status and configuration information for the SPB instance.

MIB Objects
alcatelIND1IsisSpbSys
alcatelIND1IsisSpbSysControlAddr

page 8-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands spb isis spf-wait

spb isis spf-wait

Configures the time intervals between the first, second, and subsequent ISIS-SPB shortest path first (SPF)
calculations.
spb isis spf-wait [initial-wait milliseconds | second-wait milliseconds| max-wait milliseconds]

Syntax Definitions

max-wait milliseconds Specifies the maximum number of milliseconds to wait between two
consecutive SPF calculations. Enter a value that is the same or greater
than the second wait time value. The valid range is 1000–120000
milliseconds.
initial-wait milliseconds Specifies the number of milliseconds to wait before triggering an initial
SPF calculation after a topology change. The valid range is 10–100000
milliseconds. Specify a value that is the same or less than the maximum
wait time value.
second-wait milliseconds Specifies the minimum number of milliseconds to wait between the first
and second SPF calculation. The valid range is 1–100000 milliseconds.
Specify a value that is the same or less than the maximum wait time
value.

Defaults

parameter default
max-wait milliseconds 1000
initial-wait milliseconds 100
second-wait milliseconds 300

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• To reset all three of the SPF wait time intervals back to their default values, use the spb isis spf-wait
command without specifying any parameters.
• Subsequent SPF calculations, if required, are generated at exponentially increasing intervals of the SPF
second-wait parameter value until the maximum-wait parameter value is reached. For example, if the
second-wait interval value is set to 1000 milliseconds, then the next SPF calculation is triggered after
2000 milliseconds and the next SPF calculation after that is triggered at 4000 milliseconds, and so on,
until the maximum-wait interval value is reached.
• When the maximum interval value is reached, the SPF wait interval will stay at the maximum value
until there are no more SPF calculations scheduled during that interval. After a full interval without
any SPF calculations, the SPF wait interval will reset back to the initial-wait parameter interval value.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-25
spb isis spf-wait Shortest Path Bridging Commands

Examples
-> spb isis spf-wait max-wait 2500 initial-wait 1000 second-wait 1500
-> spb isis spf-wait max-wait 5000
-> spb isis spf-wait initial-wait 1000
-> spb isis spf-wait second-wait 2000
-> spb isis spf-wait

Release History
Release 8.1.1; command was introduced.

Related Commands

spb isis lsp-wait Configures the time intervals between the first, second, and
subsequent generation of link state PDUs (LSPs).
show spb isis info Displays status and configuration information for the SPB instance.

MIB Objects
alcatelIND1IsisSpbProtocolConfig
alcatelIND1IsisSpbProtocolSpfMaxWait
alcatelIND1IsisSpbProtocolSpfInitialWait
alcatelIND1IsisSpbProtocolSpfSecondWait

page 8-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands spb isis lsp-wait

spb isis lsp-wait

Configures the time intervals between the first, second and subsequently generated link state PDU (LSP).
spb isis lsp-wait {max-wait milliseconds | initial-wait milliseconds| second-wait milliseconds}

Syntax Definitions

max-wait milliseconds Specifies the maximum number of seconds to wait between two
consecutively generated LSPs. Enter a value that is the same or greater
than the second wait time value. The valid range is 1000–120000
milliseconds.
initial-wait milliseconds Specifies the number of seconds to wait before triggering an initial LSP
generation after a topology change. The valid range is 0–100000
milliseconds. Specify a value that is the same or less than the maximum
wait time value.
second-wait milliseconds Specifies the minimum number of seconds to wait between the first and
second generated LSPs. The valid range is 1000–100000 milliseconds.
Specify a value that is the same or less than the maximum wait time
value.

Defaults

parameter default
max-wait milliseconds 1000
initial-wait milliseconds 0
second-wait milliseconds 300

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• To reset all three of the LSP wait time intervals back to their default values, use the spb isis lsp-wait
command without specifying any parameters.
• Subsequent LSP, if required, are generated at exponentially increasing intervals of the LSP second-
wait parameter value until the maximum-wait parameter value is reached. For example, if the second-
wait interval value is set to 10 seconds, then the next LSP is generation is triggered after 20 seconds
and the next LSP generated after that is triggered at 40 seconds, and so on, until the maximum-wait
interval value is reached.
• When the maximum interval value is reached, the LSP wait interval will stay at the maximum value
until there are no more LSP generations during that interval. After a full interval without any LSP
generations, the LSP wait interval will reset back to the initial-wait parameter interval value.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-27
spb isis lsp-wait Shortest Path Bridging Commands

Examples
-> spb isis lsp-wait max-wait 2000 initial-wait 1000 second-wait 1500
-> spb isis lsp-wait max-wait 5000
-> spb isis lsp-wait initial-wait 2500
-> spb isis lsp-wait second-wait 3000
-> spb isis lsp-wait

Release History
Release 8.1.1; command was introduced.

Related Commands

spb isis spf-wait Configures the time intervals between the first, second, and
subsequent shortest path first (SPF) calculations.
show spb isis info Displays status and configuration information for the SPB instance.

MIB Objects
alcatelIND1IsisSpbProtocolConfig
alcatelIND1IsisSpbProtocolLspMaxWait
alcatelIND1IsisSpbProtocolLspInitialWait
alcatelIND1IsisSpbProtocolLspSecondWait

page 8-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands spb isis overload

spb isis overload

Configures the LSP database overload state for the local ISIS-SPB switch and optionally specifies the
amount of time the switch remains in this state. When the overload state is enabled, the switch signals to
other ISIS-SPB switches that it is not able to accept transit traffic.
spb isis overload [timeout seconds]
no spb isis overload

Syntax Definitions

seconds Specifies the timeout interval, in seconds. The valid range is 60–1800.

Defaults
By default, the IS-IS overload state is disabled.

parameter default
seconds 0

Platforms Supported
OmniSwitch 10K, 6900

Usage Guidelines
• Use the no form of this command to make the router exit the overload state.

• If the time period is not specified, the router remains in the overload state for an infinite period.

• During normal operation, the router may be forced to enter an overload state due to a lack of resources.
When in the overload state, the router is used only if the destination route is directly reachable by the
router (for example, it will not be used for other transit traffic).
• This command can be used when the router is overloaded or before executing a shutdown command to
divert traffic around the router.

Examples
-> spb isis overload timeout 70
-> no spb isis overload

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-29
spb isis overload Shortest Path Bridging Commands

Related Commands

spb isis overload-on-boot Configures the ISIS-SPB instance to operate in an overload state
during bootup for a specified time period.
show spb isis info Displays status and configuration information for the ISIS-SPB
instance.

MIB Objects
alcatelIND1IsisSpbSysSetOverload
alcatelIND1IsisSpbSysOverloadTimeout
alcatelIND1IsisSpbSysOverloadStatus

page 8-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands spb isis overload-on-boot

spb isis overload-on-boot

Configures the ISIS-SPB switch to operate in the overload state after a system bootup for the specified
amount of time.
spb isis overload-on-boot [timeout seconds]
no spb isis overload-on-boot

Syntax Definitions

seconds Specifies the timeout interval, in seconds. The valid range is 60–1800.

Defaults
By default, the ISIS-SPB switch will not operate in the overload state after a bootup.

parameter default
seconds 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to prevent the switch from entering the overload state after bootup.

• An ISIS-SPB switch operating in the overload state is used only if there is no alternate path to reach
the destination.
• This command configures the switch to operate in the overload state after a bootup and until the
timeout value expires or the no form of this command is used.
• The no spb isis overload command does not influence the overload-on-boot function.

Examples
-> spb isis overload-on-boot timeout 80
-> no spb isis overload-on-boot

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-31
spb isis overload-on-boot Shortest Path Bridging Commands

Related Commands

spb isis overload Sets the ISIS-SPB switch to operate in the overload state.
show spb isis info Displays status and configuration information for the ISIS- SPB
instance.

MIB Objects
vRtrIsisTable
alcatelIND1IsisSpbSysOverloadOnBoot
alcatelIND1IsisSpbSysOverloadOnBootTimeout
alcatelIND1IsisSpbSysOverloadStatus

page 8-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands spb isis graceful-restart

spb isis graceful-restart

Configures graceful restart of the bridge. It allows ISIS-SPB to re-converge faster, minimizing service
interruption.
spb isis graceful-restart
no spb isis graceful-restart

Syntax Definitions

N/A

Defaults
By default, the graceful restart functionality is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable graceful restart and remove the graceful restart
configuration from the SPB bridge.
• When graceful restart is enabled, the bridge can either be a helper (which helps a neighbor router to
restart) ora restarting router, or both.

Examples
-> spb isis graceful-restart
-> no spb isis graceful-restart

Release History
Release 8.1.1; command was introduced.

Related Commands

spb isis graceful-restart helper Configures the helper mode of routers for graceful restart.
show spb isis info Displays status and configuration information for the SPB instance.

MIB Objects
alcatelIND1IsisSpbProtocolConfig
alcatelIND1IsisSpbProtocolGracefulRestart

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-33
spb isis graceful-restart helper Shortest Path Bridging Commands

spb isis graceful-restart helper

Administratively enables and disables the ISIS-SPB bridge to operate in the helper mode in response to a
bridge performing a graceful restart.
spb isis graceful-restart helper {enable | disable}

Syntax Definitions

enable Enables the helper mode on the bridge.

disable Disables the helper mode on the bridge.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
When graceful restart is enabled, the helper mode is enabled by default.

Examples
-> spb isis graceful-restart helper disable

Release History
Release 8.1.1; command was introduced.

Related Commands

spb isis graceful-restart Configures graceful restart on the bridge.

show spb isis info Displays status and configuration information for the SPB instance.

MIB Objects
alcatelIND1IsisSpbProtocolConfig
alcatelIND1IsisSpbProtocolGRHelperMode

page 8-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands show spb isis info

show spb isis info

Displays the global ISIS-SPB status and configuration information for the SPB bridge.
show spb isis info

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show spb isis info
SPB ISIS Bridge Info:
System Id = e8e7.3233.1831,
System Hostname = BEB-1,
SPSourceID = 03-18-31,
SPBM System Mode = auto,
BridgePriority = 32768 (0x8000),
MT ID = 0,
Control BVLAN = 4001,
Area Address = 0.0.0,
Level Capability = L1,
Admin State = UP,
LSDB Overload = Disabled,
Last Enabled = Thu Aug 2 22:43:19 2012,
Last SPF = Fri Aug 3 18:15:51 2012,
SPF Wait = Max: 1000 ms, Initial: 100 ms, Second: 300 ms,
LSP Lifetime = 1200,
LSP Wait = Max: 1000 ms, Initial: 0 ms, Second: 300 ms,
Graceful Restart = Disabled,
GR helper-mode = Disabled,
# of L1 LSPs = 8
Control Address = 01:80:c2:00:00:14 (AllL1)

output definitions
System Id The system ID of the SPB bridge. The system ID is the base chassis
MAC address of the SPB bridge.
System Hostname The system name assigned to the SPB bridge. Configured through the
system name command.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-35
show spb isis info Shortest Path Bridging Commands

output definitions (continued)

SPSourceID The shortest path (SP) source ID value for the SPB bridge. This value
identifies the source of multicast frames and is relevant only in the
multicast tandem replication mode. Configured through the spb isis
source-id command.
SPBM System Mode Indicates if the SP source ID was manually set (manual) using the spb
isis source-id command or automatically allocated (auto) using the last
three least significant bytes of the System ID.
BridgePriority The bridge priority value assigned to the SPB bridge. Configured
through the spb isis bridge-priority command.
MT ID The IS-IS Multi Topology ID.
Control BVLAN The SPB base VLAN assigned to exchange ISIS-SPB control traffic
with other SPB bridges. Configured through the spb isis control-bvlan
command.
Area Address The IS-IS area address for this ISIS-SPB instance. Configured through
the spb isis area-address command.
Level Capability The level capability of the bridge. Only Level 1 (L1) is supported.
Admin State The state of the SPB instance for the bridge (Up or Down). Configured
through the spb isis admin-state command.
LSDB Overload The LSP database overload state of the switch. Configured through the
spb isis overload command.
Last Enabled The date and time when the ISIS-SPB instance was last enabled for the
bridge.
Last SPF The date and duration of the last shortest path first (SPF) calculation.
SPF Wait The SPF wait time intervals used to trigger SPF calculations after a
topology change. Configured through the spb isis spf-wait command.
LSP Lifetime The Lifetime of the LSP, in seconds.
LSP Wait The LSP wait time intervals used to trigger LSP generations.
Configured through the spb isis lsp-wait command.
Graceful Restart Indicates if graceful restart is Enabled or Disabled. Configured
through the spb isis graceful-restart command.
GR helper-mode Indicates if the graceful restart helper mode is Enabled or Disabled.
Configured through the spb isis graceful-restart helper command.
# of L1 LSPs The number of LSPs for Level-1 adjacency.
Control Address The destination MAC address used for ISIS-SPB control frames.
Configured through the spb isis control-address command.

Release History
Release 8.1.1; command was introduced.

page 8-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands show spb isis info

Related Commands

show spb isis spf Displays the shortest path first (SPF) information to all known SPB
bridges for a specific BVLAN.
show spb isis bvlans Displays the ISIS-SPB backbone VLAN (BVLAN) configuration for
the bridge.
show spb isis interface Displays the ISIS-SPB network interface configuration for the bridge.

MIB Objects
alcatelIND1IsisSpbSys
alcatelIND1IsisSpbSysId
alcatelIND1IsisSpbSysName
alcatelIND1IsisSpbmSysSPSourceId
alcatelIND1IsisSpbmSysMode
alcatelIND1IsisSpbSysBridgePriority
alcatelIND1IsisSpbSysControlBvlan
alcatelIND1IsisSpbSysAreaAddress
alcatelIND1IsisSpbSysAdminState
alcatelIND1IsisSpbProtocolSpfMaxWait
alcatelIND1IsisSpbProtocolSpfInitialWait
alcatelIND1IsisSpbProtocolSpfSecondWait
alcatelIND1IsisSpbProtocolLspMaxWait
alcatelIND1IsisSpbProtocolLspInitialWait
alcatelIND1IsisSpbProtocolLspSecondWait
alcatelIND1IsisSpbProtocolGracefulRestart
alcatelIND1IsisSpbProtocolGRHelperMode
alcatelIND1IsisSpbSysControlAddr

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-37
show spb isis bvlans Shortest Path Bridging Commands

show spb isis bvlans

Displays the ISIS-SPB backbone VLAN (BVLAN) configuration for the bridge.
show spb isis nodes

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command also displays the equal cost tree (ECT) algorithm that is assigned to each BVLAN.

Examples
-> show spb isis bvlans
SPB ISIS BVLANS:
Services Num Tandem Root Bridge
BVLAN ECT-algorithm In Use mapped ISIDS Multicast (Name : MAC Address)
-------+-------------+-------+--------+-----+----------+---------------------
501 00-80-c2-01 NO NO 0 GMODE BRIDGE-3:00:d1:95:00:30:02
502 00-80-c2-02 NO NO 0 SGMODE
503 00-80-c2-03 YES NO 4 SGMODE
504 00-80-c2-04 YES NO 4 SGMODE

BVLANs: 4

output definitions
BVLAN The VLAN ID number for the SPB BVLAN. Configured through the
spb bvlan command.
ECT-algorithm The equal cost tree (ECT) algorithm index (1–16) assigned to the
BVLAN. Configured through the spb isis bvlan ect-id command.
In Use Indicates whether or not the BVLAN is in use.
Services Mapped Indicates whether or not any local services are mapped to the BVLAN.
Num ISIDS The number of services known to the BVLAN.
Tandem Multicast The tandem multicast mode (SGMODE or GMODE) for the BVLAN.
Configured through the spb isis bvlan tandem-multicast-mode
command.
Root Bridge The system name and bridge MAC address of the root bridge. This
(Name : MAC Address) value is displayed only for GMODE configurations.

page 8-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands show spb isis bvlans

Release History
Release 8.1.1; command was introduced.

Related Commands

show spb isis info Displays status and configuration information for the SPB instance
show spb isis interface Displays the ISIS-SPB network interface configuration for the bridge.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-39
show spb isis interface Shortest Path Bridging Commands

show spb isis interface

Displays the ISIS-SPB network interface configuration for the switch.
show spb isis interface

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command also shows the operational and administrative status of the interface.

• When an SPB interface is created, the interface is automatically assigned to each SPB BVLAN in the
switch configuration.

Examples
-> show spb isis interface
SPB ISIS Interfaces:
Oper Admin Link Hello Hello
Interface Level CircID state state Metric Intvl Mult
---------------+-------+----------+------+-------+---------+-------+-------
1/1/1 L1 1 DOWN UP 10 9 3
1/1/2 L1 2 UP UP 10 9 3
1/1/3 L1 3 DOWN UP 10 9 3
1/1/4 L1 4 DOWN UP 10 9 3
1/1/5 L1 5 DOWN UP 10 9 3
1/1/6 L1 6 DOWN UP 10 9 3
1/1/7 L1 7 DOWN UP 10 9 3
1/1/10 L1 9 DOWN UP 10 9 3

Interfaces : 8

output definitions
Interface The slot/port or link aggregate ID of the SPB interface.
Level The IS-IS Area Level (L1) for the interface.
CircID The circuit ID of the interface.
Oper-state The operational state of the interface (UP or DOWN).
Admin-state The administrative state of the interface (UP or DOWN).
Link Metric The metric value of the router for the corresponding area level.

page 8-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands show spb isis interface

output definitions
Hello Interval The number of seconds the interface waits between Hello PDU
transmissions.
Hello Multiplier The number that is multiplied by the Hello Interval to determine the
hold time.

Release History
Release 8.1.1; command was introduced.

Related Commands

spb isis interface Creates an ISIS-SPB network interface.

MIB Objects
alcatelIND1IsisSpbAdjStaticTable
alcatelIND1IsisSpbAdjStaticEntryIfIndex
alcatelIND1IsisSpbAdjStaticEntryMetric
alcatelIND1IsisSpbAdjStaticEntryHelloInterval
alcatelIND1IsisSpbAdjStaticEntryHelloMultiplier
alcatelIND1IsisSpbAdjStaticEntryIfAdminState

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-41
show spb isis adjacency Shortest Path Bridging Commands

show spb isis adjacency

Displays information about the ISIS-SPB adjacencies created for the SPB bridge.
show ip isis adjacency [detail]

Syntax Definitions

detail Displays additional information about the ISIS-SPB adjacencies.

Defaults
By default, a summary list of adjacency information is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip isis adjacency
SPB ISIS Adjacency:
System
(Name : SystemId) Type State Hold Interface
------------------------------------+----+------+-----+---------
bridge2 : 00d0.9506.4c62 L1 UP 27 1/1
bridge3 : 00d0.9507.9732 L1 UP 20 1/2

Adjacencies : 2

output definitions
Name The system name assigned to the adjacent SPB bridge.
SystemId The system ID of the adjacent SPB bridge. The system ID is the base
chassis MAC address of the SPB bridge.
Type The level (LI) of the adjacent bridge.
State The state of the adjacency (UP or DOWN).
Hold The adjacency hold time, in seconds.
Interface The slot/port or link aggregate ID of the SPB interface on which the
adjacency was formed.
Adjacencies The total number of adjacent SPB bridges.

page 8-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands show spb isis adjacency

-> show ip isis adjacency detail

SPB ISIS Adjacency detail:
SystemID: 00d0.9506.4c62 :
B-MAC : 00:d0:95:06:4c:62 , Hostname : bridge2 ,
Interface : 1/1/1 , Up Time : Mon Sep 26 17:54:29 2011,
State : UP , Priority : 0 ,
Hold Time : 18 , Max Hold : 27 ,
Adj Level : L1 , NLPIDs : SPB ,
ExtLocalCktId(YES): 2,
Restart Support : Disabled ,
Restart Status : Not currently being helped,
Restart Supressed : Disabled

SystemID: 00d0.9507.9732 :
B-MAC : 00:d0:95:07:97:32 , Hostname : bridge3 ,
Interface : 1/1/2 , Up Time : Mon Sep 26 17:54:29 2011,
State : UP , Priority : 0 ,
Hold Time : 21 , Max Hold : 27 ,
Adj Level : L1 , NLPIDs : SPB ,
ExtLocalCktId(YES): 2,
Restart Support : Disabled ,
Restart Status : Not currently being helped,
Restart Supressed : Disabled

Adjacencies : 1

output definitions
SystemID The system ID of the adjacent SPB bridge. The system ID is the base
chassis MAC address of the SPB bridge.
B-MAC The backbone MAC address (system ID) of the adjacent bridge. This is
the address that is used as the source address for encapsulated customer
traffic that is tunneled through SPB services.
Interface The slot/port or link aggregate ID of the SPB interface on which the
adjacency was formed.
State The state of the adjacency (UP or DOWN).
Hold Time The adjacency hold time, in seconds.
Adj Level The adjacency level (L1) of the SPB bridge.
ExtLocalCktId(YES) The circuit ID that the peer bridge has assigned to this adjacency.
Restart Support Indicates if graceful restart is Enabled or Disabled.
Restart Status Indicates whether the adjacent SPB bridge is helping the local bridge to
restart (Not currently being helped or Currently being helped).
Restart Suppressed Indicates whether or not the advertisement of LSPs is suppressed per
the request of adjacent SPB bridge (Enabled or Disabled).
Hostname The system name assigned to the adjacent SPB bridge.
Up Time Indicates the time period in seconds, during which the SPB bridge was
in the adjacency.
Priority The bridge priority value of the adjacent SPB bridge.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-43
show spb isis adjacency Shortest Path Bridging Commands

output definitions
Max Hold Indicates the maximum hold time of the adjacent SPB bridge.
NLPIDs The Network Layer Protocol ID (NLPID) of the adjacent bridge (SPB
NLPID = 0xC1).

Release History
Release 8.1.1; command was introduced.

Related Commands

show spb isis database Displays ISIS-SPB topology information maintained in the link
state database (LSDB).
show spb isis nodes Displays the discovered node-level parameter values for all of the
ISIS-SPB bridges participating in the topology.

MIB Objects
N/A

page 8-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands show spb isis database

show spb isis database

Displays ISIS-SPB topology information maintained in the link state database (LSDB).
show ip isis database [lsp-id lsp_id}]

Syntax Definitions

lsp_id The LSP ID.

Defaults
By default, the entire LSDB is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the lsp-id parameter with this command to view database information for a specific link state packet
(LSP).

Examples
-> show spb isis database
Legends : P = The Partition repair bit is set
OV = The overload bit is set
ATT = The Attach bit is set
L1 = Specifies a Level 1 IS type
L2 = Specifies a Level 2 IS type
SPB ISIS LSP Database:
LSP ID Sequence Checksum Lifetime Attributes
----------------------+-----------+----------+----------+------------
00d1.9500.3002.00-00 0x000000a8 0x9bdc 862 L1
00e0.b188.99be.00-00 0x0000009c 0xa719 762 L1
Level-1 LSP count : 2

output definitions
LSP ID The LSP ID. Indicates the system ID and the pseudo-node ID of the
originating router.
Sequence The sequence number of the LSP. The sequence number is a value used
to identify old and duplicate LSPs.
Checksum The checksum value of the LSP.
Lifetime The number of seconds the LSP remains valid. The LSP lifetime value
of zero indicates that this LSP is being removed from the LSDB of all
the SPB bridges.
Attributes The level capability of the bridge. This implementation of ISIS-SPB
only supports Level 1 (L1).
LSP Count The number of LSPs in the LSDB.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-45
show spb isis database Shortest Path Bridging Commands

-> show spb isis database lsp-id 0000.bcb4.0001.00-00

Legends : P = The Partition repair bit is set
OV = The overload bit is set
ATT = The Attach bit is set
L1 = Specifies a Level 1 IS type
L2 = Specifies a Level 2 IS type
SPB ISIS LSP Database:
-------------------------------------------------------------------------------
LSP ID : 0000.bcb4.0001.00-00 Level : L1
Sequence : 0x00000068 Checksum : 0xf4f5 Lifetime : 1118
Version : 1 Pkt Type : 18 Pkt Ver : 1
Attributes : L1 Max Area : 3
SysID Len : 6 Used Len : 209 Alloc Len : 209

TLVs :
Area Addresses :
Area Address : (01) 00
Area Address : (03) 00.00.00
Supp Protocols :
Protocols : SPB
IS-Hostname :
Hostname : Ix-SPB-4
TE IS Neighbors :
Neighbor : 0000.beb4.0006 SPB Metric 10 Num of Ports 1 Port-Id 0x1
Neighbor : e8e7.3233.199d SPB Metric 10 Num of Ports 1 Port-Id 0x1
MT Capability :
MT-ID : 0x0
SPB INSTANCE :
CIST Root-ID: 0x0 0x0
CIST Ext Root Path Cost: 0x00000000 Bridge Priority: 0x8003
SPSourceID: 0x001055f2 (Auto) Number of Trees: 4
[#1 ]ECT-algo:0x0080c201 baseVid:4001 spVid:0 usedByISID:1(I-SID) mode:1(SPBM)
[#2 ]ECT-algo:0x0080c202 baseVid:4002 spVid:0 usedByISID:1(I-SID) mode:1(SPBM)
[#3 ]ECT-algo:0x0080c203 baseVid:4003 spVid:0 usedByISID:1(I-SID) mode:1(SPBM)
[#4 ]ECT-algo:0x0080c204 baseVid:4004 spVid:0 usedByISID:1(I-SID) mode:1(SPBM)
SPB SVCID-UCAST-ADDR :
B-MAC 00.00.bc.b4.00.01 Base-VID 4001
[ISID# 1] 1000 (T=0/R=0)
SPB SVCID-UCAST-ADDR :
B-MAC 00.00.bc.b4.00.01 Base-VID 4002
[ISID# 1] 1500 (T=0/R=0)
SPB SVCID-UCAST-ADDR :
B-MAC 00.00.bc.b4.00.01 Base-VID 4003
[ISID# 1] 2000 (T=0/R=0)
SPB SVCID-UCAST-ADDR :
B-MAC 00.00.bc.b4.00.01 Base-VID 4004
[ISID# 1] 2500 (T=0/R=0)

Release History
Release 8.1.1; command was introduced.

page 8-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands show spb isis database

Related Commands

show spb isis adjacency Displays information about the ISIS-SPB adjacencies created for the
SPB bridge.
show spb isis nodes Displays the discovered node-level parameter values for all of the ISIS-
SPB bridges participating in the topology.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-47
show spb isis nodes Shortest Path Bridging Commands

show spb isis nodes

Displays the discovered node-level parameter values for all of the ISIS-SPB switches participating in the
topology.
show spb isis nodes

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays the system name, system ID, SPsource ID, and bridge priority parameter values
for the bridges discovered within the ISIS-SPB topology.

Examples
-> show spb isis nodes
SPB ISIS Nodes:
System Name System Id SourceID BridgePriority
--------------------+---------------+--------+---------------
Bridge-1 00e0.b1e7.0188 0x70188 32768 (0x8000)
Bridge-2 00e0.b1e7.0bd3 0x70bd3 32768 (0x8000)
Bridge-4 e8e7.3200.2a1d 0x02a1d 32768 (0x8000)
Bridge-5 e8e7.3233.1891 0x31891 32768 (0x8000)
Bridge-6 e8e7.3233.199d 0x3199d 32768 (0x8000)
Bridge-7 e8e7.3233.1a29 0x31a29 32768 (0x8000)
Bridge-8 e8e7.3233.1c81 0x31c81 32768 (0x8000)

output definitions
System Name The system name assigned to the SPB bridge.
System Id The system ID of the SPB bridge. The system ID is the base chassis
MAC address of the SPB bridge.
SourceID The shortest path (SP) source ID value for the SPB bridge. This value
identifies the source of multicast frames and is relevant only in the
multicast tandem replication mode.
BridgePriority The bridge priority value assigned to the SPB bridge.

Release History
Release 8.1.1; command was introduced.

page 8-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands show spb isis nodes

Related Commands

show spb isis adjacency Displays information about the ISIS-SPB adjacencies created for the
SPB bridge.
show spb isis info Displays status and configuration information for the SPB instance

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-49
show spb isis unicast-table Shortest Path Bridging Commands

show spb isis unicast-table

Displays the unicast forwarding information for the specified BVLANs. Use this command to verify
unicast addresses were learned correctly on each SPB switch in the ISIS-SPB backbone topology.
show spb isis unicast-table [bvlan bvlan_id]

Syntax Definitions

bvlan_id The VLAND ID of an existing BVLAN.

Defaults
By default, the forwarding information for all BVLANs in the SPB topology is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the bvlan bvlan_id parameter to display information for a specific BVLAN.

Examples
-> show spb isis unicast-table
SPB ISIS Unicast MAC Table:
Destination Outbound
BVLAN (Name : MAC Address) Interface
------+----------------------------------------+-----------
4001 BRIDGE-2 : 00:e0:b1:e7:0b:d3 1/1/1
4001 BRIDGE-4 : e8:e7:32:00:2a:1d 1/1/1
4001 BRIDGE-5 : e8:e7:32:33:18:91 1/1/3
4001 BRIDGE-6 : e8:e7:32:33:19:9d 1/1/1
4001 BRIDGE-7 : e8:e7:32:33:1a:29 1/1/2
4001 BRIDGE-8 : e8:e7:32:33:1c:81 1/1/1
4002 BRIDGE-2 : 00:e0:b1:e7:0b:d3 1/1/1
4002 BRIDGE-4 : e8:e7:32:00:2a:1d 1/1/3
4002 BRIDGE-5 : e8:e7:32:33:18:91 1/1/3
4002 BRIDGE-6 : e8:e7:32:33:19:9d 1/1/2
4002 BRIDGE-7 : e8:e7:32:33:1a:29 1/1/2
4002 BRIDGE-8 : e8:e7:32:33:1c:81 1/1/3
4003 BRIDGE-2 : 00:e0:b1:e7:0b:d3 1/1/1
4003 BRIDGE-4 : e8:e7:32:00:2a:1d 1/1/3
4003 BRIDGE-5 : e8:e7:32:33:18:91 1/1/3
4003 BRIDGE-6 : e8:e7:32:33:19:9d 1/1/3
4003 BRIDGE-7 : e8:e7:32:33:1a:29 1/1/2
4003 BRIDGE-8 : e8:e7:32:33:1c:81 1/1/3
4004 BRIDGE-2 : 00:e0:b1:e7:0b:d3 1/1/1
4004 BRIDGE-4 : e8:e7:32:00:2a:1d 1/1/1
4004 BRIDGE-5 : e8:e7:32:33:18:91 1/1/3
4004 BRIDGE-6 : e8:e7:32:33:19:9d 1/1/1
4004 BRIDGE-7 : e8:e7:32:33:1a:29 1/1/2

MAC Addresses: 23

page 8-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands show spb isis unicast-table

-> show spb isis unicast-table bvlan 4001

SPB ISIS Unicast MAC Table:
Destination Outbound
BVLAN (Name : MAC Address) Interface
------+----------------------------------------+-----------
4001 BRIDGE-2 : 00:e0:b1:e7:0b:d3 1/1/1
4001 BRIDGE-4 : e8:e7:32:00:2a:1d 1/1/1
4001 BRIDGE-5 : e8:e7:32:33:18:91 1/1/3
4001 BRIDGE-6 : e8:e7:32:33:19:9d 1/1/1
4001 BRIDGE-7 : e8:e7:32:33:1a:29 1/1/2
4001 BRIDGE-8 : e8:e7:32:33:1c:81 1/1/1

MAC Addresses: 6

output definitions
BVLAN The VLAN ID number for the SPB BVLAN.
System The system name of the destination SPB bridge, and the destination
(Name : BMAC) unicast BMAC address for that bridge.
Outbound Interface The interface (port or link aggregate) on which the destination system
is reached.

Release History
Release 8.1.1; command was introduced.

Related Commands

show spb isis bvlans Displays status and configuration information for the SPB instance.
show spb isis multicast-table Displays the multicast forwarding information for the specified service
instance identifier (I-SID).

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-51
show spb isis services Shortest Path Bridging Commands

show spb isis services

Displays the service instance identifier (I-SID) mapping for bridges participating in the SPB topology.
This command provides a network-wide view of existing services to help verify that SPB services are
correctly advertised and learned by ISIS-SPB.
show spb isis services [isid service_id | bvlan bvlan_id]

Syntax Definitions

service_id An existing I-SID number.

bvlan_id The VLAND ID of an existing BVLAN.

Defaults
By default, the mapping for all I-SIDs in the SPB topology is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the isid service_id number to display information for a specific service instance.

• Use the bvlan bvlan_id parameter to display information for a specific BVLAN.

Examples
-> show spb isis services
Legend: * indicates locally configured ISID
SPB ISIS Services Info:
System
ISID BVLAN (Name : BMAC) MCAST(T/R)
------------+-------+----------------------------------------+-----------
* 1000 4001 BRIDGE-1 : 00:e0:b1:e7:01:88
* 1000 4001 BRIDGE-4 : e8:e7:32:00:2a:1d
* 1001 4001 BRIDGE-1 : 00:e0:b1:e7:01:88
* 1001 4001 BRIDGE-4 : e8:e7:32:00:2a:1d
* 1002 4001 BRIDGE-1 : 00:e0:b1:e7:01:88
* 1002 4001 BRIDGE-4 : e8:e7:32:00:2a:1d
* 1003 4001 BRIDGE-1 : 00:e0:b1:e7:01:88
* 1003 4001 BRIDGE-4 : e8:e7:32:00:2a:1d
* 1004 4001 BRIDGE-1 : 00:e0:b1:e7:01:88
* 1004 4001 BRIDGE-4 : e8:e7:32:00:2a:1d
* 1005 4001 BRIDGE-1 : 00:e0:b1:e7:01:88
* 1005 4001 BRIDGE-4 : e8:e7:32:00:2a:1d
* 1006 4001 BRIDGE-1 : 00:e0:b1:e7:01:88
* 1006 4001 BRIDGE-4 : e8:e7:32:00:2a:1d
* 1007 4001 BRIDGE-1 : 00:e0:b1:e7:01:88
* 1007 4001 BRIDGE-4 : e8:e7:32:00:2a:1d

ISIDs: 16

page 8-52 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands show spb isis services

output definitions
ISID The service instance identifier.
BVLAN The VLAN ID number for the SPB BVLAN.
System The system name of the SPB bridge from where the I-SID was
(Name : BMAC) discovered or configured, and the destination unicast BMAC address to
which frames associated with the service instance are sent.
Multicast (T/R) Indicates the multicast service requirement for the instance (Transmit,
Receive, or both).

Release History
Release 8.1.1; command was introduced.

Related Commands

show spb isis info Displays status and configuration information for the SPB instance

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-53
show spb isis spf Shortest Path Bridging Commands

show spb isis spf

Displays the shortest path first (SPF) information to all known SPB bridges for a specific BVLAN.
show spb isis spf bvlan bvlan_id [bmac mac_address]

Syntax Definitions

bvlan_id The VLAND ID of an existing BVLAN.

mac_address An SPB bridge BMAC address.

Defaults
By default, the SPF information for all known BMAC addresses for the specified BVLAN.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the bmac mac_address parameter to display information for a specific SPB bridge.

Examples
-> show spb isis spf bvlan 4001
SPB ISIS Path Table:
Destination Outbound Next Hop SPB Num
(Name : BMAC) Interface (Name : BMAC) Metric Hops
-----------------------------+---------+-----------------------------+------+------
BRIDGE-1 : 00:e0:b1:e7:01:88 1/1/3 BRIDGE-2 : 00:e0:b1:e7:0b:d3 20 2
BRIDGE-2 : 00:e0:b1:e7:0b:d3 1/1/3 BRIDGE-2 : 00:e0:b1:e7:0b:d3 10 1
BRIDGE-4 : e8:e7:32:00:2a:1d 1/1/2 BRIDGE-4 : e8:e7:32:00:2a:1d 10 1
BRIDGE-5 : e8:e7:32:33:18:91 1/1/1 BRIDGE-5 : e8:e7:32:33:18:91 10 1
BRIDGE-6 : e8:e7:32:33:19:9d 1/1/3 BRIDGE-2 : 00:e0:b1:e7:0b:d3 20 2
BRIDGE-7 : e8:e7:32:33:1a:29 1/1/3 BRIDGE-2 : 00:e0:b1:e7:0b:d3 30 3

SPF Path count: 6

-> show spb isis spf bvlan 4001 bmac e8:e7:32:33:1a:29

SPB ISIS Path Details:
Path Hop Name Path Hop BMAC
--------------------+-------------------
BRIDGE-7 e8:e7:32:33:1a:29
BRIDGE-1 00:e0:b1:e7:01:88
BRIDGE-2 00:e0:b1:e7:0b:d3

output definitions
Destination The system name of the destination SPB bridge, and the destination
(Name : BMAC) BMAC address for that bridge.
Outbound Interface The interface (port or link aggregate) on which the destination system
is reached.

page 8-54 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands show spb isis spf

output definitions (continued)

Next Hop The system name of the next-hop SPB bridge, and the BMAC address
(Name : BMAC) for that bridge.
SPB Metric The metric (cost) to reach the destination BMAC address.
Num Hops The number of hops along the path to the destination.

Release History
Release 8.1.1; command was introduced.

Related Commands

show spb isis multicast- Displays the SPF reachability for a known multicast source bridge for a
sources-spf specific BVLAN.
show spb isis info Displays status and configuration information for the SPB instance

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-55
show spb isis multicast-table Shortest Path Bridging Commands

show spb isis multicast-table

Displays the multicast forwarding information for the specified service instance identifier (I-SID).
show spb isis multicast-table [isid service_id]

Syntax Definitions

service_id An existing I-SID number.

Defaults
By default, the forwarding information for all services in the SPB topology is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the isid service_id parameter to display information for a specific service instance.

Examples
-> show spb isis multicast-table
SPB ISIS Multicast MAC Table:
MCAST Source Inbound Outbound
ISID BVLAN MCAST Group Address (Name:BMAC) Interface Interface
------+-----+-------------------+------------------------------+---------+---------
2000 41 0a:fd:c2:00:01:22 BRIDGE-8 : 00:d0:95:0a:fd:c2 1/1/2 1/1/3

MAC Addresses: 1

output definitions
ISID The service instance identifier.
BVLAN The VLAN ID number for the SPB BVLAN associated with the service
instance.
MCAST Group Address The multicast destination group address.
MCAST Source The system name and BMAC address of the multicast source.
(Name : BMAC)
Inbound Interface The interface (port or link aggregate) on which multicast traffic is
received for the service instance.
Outbound Interface The interface (port or link aggregate) on which multicast traffic is sent
for the service instance.

Release History
Release 8.1.1; command was introduced.

page 8-56 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands show spb isis multicast-table

Related Commands

show spb isis multicast-sources Displays all the known multicast sources across the SPB domain and
BVLANs.
show spb isis multicast- Displays the shortest path first (SPF) reachability for a known multicast
sources-spf source bridge for a specific BVLAN.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-57
show spb isis multicast-sources Shortest Path Bridging Commands

show spb isis multicast-sources

Displays all the known multicast sources across the SPB domain and BVLANs.
show spb isis multicast-sources

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command also displays whether or not the source is reachable.

Examples
-> show spb isis multicast-sources
SPB ISIS Multicast Source Nodes:
Multicast Source
(Name : BMAC) Reachable (# ) BVIDS
-------------------------------+---------+-----------------
BRIDGE-8 : 00:d0:95:0a:fd:c2 YES (#2) 4001 4002

Total SPB Multicast Source Nodes: 1

output definitions
Multicast Source The system name and BMAC address of the multicast source bridge.
(Name : BMAC)
Reachable Indicates whether or not the multicast source node is reachable (YES or
NO).
(# ) BVIDS Indicates the number of BVLANs and the BVLAN IDs on which the
bridge acts as a multicast source.

Release History
Release 8.1.1; command was introduced.

page 8-58 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands show spb isis multicast-sources

Related Commands

show spb isis multicast- Displays the shortest path first (SPF) reachability for a known multicast
sources-spf source bridge for a specific BVLAN.
show spb isis multicast-table Displays the multicast forwarding information for the specified service
instance identifier (I-SID).
show spb isis info Displays status and configuration information for the SPB instance

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-59
show spb isis multicast-sources-spf Shortest Path Bridging Commands

show spb isis multicast-sources-spf

Displays the shortest path first (SPF) reachability for a known multicast source bridge for a specific
BVLAN.
show spb isis multicast-sources-spf bvlan bvlan_id bmac mac_address [dest mac_address]

Syntax Definitions

bvlan_id The VLAN ID of an existing BVLAN.

mac_address An SPB bridge BMAC address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the dest mac_address parameter to display information for a specific SPB bridge.

Examples
-> show spb isis multicast-sources-spf bvlan 4001 bmac 00:d0:95:0a:fd:c2
SPB ISIS Path Table:
Destination Outbound Next Hop SPB Num
(Name : BMAC) Interface (Name : BMAC) Metric Hops
-----------------------------+---------+-----------------------------+------+------
BRIDGE-1 : 00:d0:95:03:19:12 1/1/1 BRIDGE-7 : 00:d0:95:09:79:02 30 3
BRIDGE-2 : 00:d0:95:06:4c:62 1/1/1 BRIDGE-7 : 00:d0:95:09:79:02 20 2
BRIDGE-3 : 00:d0:95:07:97:32 1/1/1 BRIDGE-7 : 00:d0:95:09:79:02 20 2
BRIDGE-6 : 00:d0:95:08:f2:12 1/1/2 BRIDGE-6 : 00:d0:95:08:f2:12 10 1
BRIDGE-7 : 00:d0:95:09:79:02 1/1/1 BRIDGE-7 : 00:d0:95:09:79:02 10 1

SPF Path count: 5

-> show spb isis spf bvlan 4001 bmac 00:d0:95:0a:fd:c2 dest 00:d0:95:03:19:12
SPB ISIS Multicast Source Path Details:
Path Hop Name Path Hop BMAC
--------------------+-------------------
BRIDGE-1 00:d0:95:03:19:12
BRIDGE-3 00:d0:95:07:97:32
BRIDGE-7 00:d0:95:09:79:02

output definitions
Destination The system name and BMAC address of the destination SPB bridge.
(Name : BMAC)
Outbound Interface The interface (port or link aggregate) on which the destination system
is reached.

page 8-60 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands show spb isis multicast-sources-spf

output definitions (continued)

Next Hop The system name and BMAC address of the next-hop SPB bridge.
(Name : BMAC)
SPB Metric The metric (cost) to reach the destination BMAC address.
Num Hops The number of hops along the path to the destination.

Release History
Release 8.1.1; command was introduced.

Related Commands

show spb isis multicast-sources Displays all the known multicast sources across the SPB domain and
BVLANs.
show spb isis multicast-table Displays the multicast forwarding information for the specified service
instance identifier (I-SID).
show spb isis spf Displays the SPF information to all known SPB bridges for a specific
BVLAN.
show spb isis info Displays status and configuration information for the SPB instance

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-61
show spb isis ingress-mac-filter Shortest Path Bridging Commands

show spb isis ingress-mac-filter

Displays the ingress MAC filter for multicast traffic for a given BVLAN operating in the (*,G) mode.
show spb isis ingress-mac-filter [port chassis_id/slot/port[-port2] | linkagg agg_id[-agg_id2] | bvlan
bvlan_id | bmac mac_address]

Syntax Definitions

chassis The chassis identifier.

slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
bvlan_id The VLAND ID of an existing BVLAN.
mac_address The source MAC address of the multicast traffic allowed on the
specified BVLAN and physical port.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the optional command parameters to display specific information with this command.

• Each of the optional command parameters can be combined with any of the other optional parameters
within the same command line.

Examples
-> show spb isis ingress-mac-filter
SPB ISIS Ingress MAC Table (for GMODE bvlans only):
Inbound Multicast source MAC
BVLAN Interface (Name : MAC Address)
------+-----------+----------------------------------------
40 1/1/1 BRIDGE-1 : 00:d0:95:04:8d:92

MAC Addresses: 1

output definitions
BVLAN The VLAN ID number for the SPB BVLAN.
Inbound Interface The interface (port or link aggregate) on which the multicast source
MAC was received.
System The system name and MAC address of the multicast traffic source.
(Name : BMAC)

page 8-62 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Shortest Path Bridging Commands show spb isis ingress-mac-filter

Release History
Release 8.1.1; command was introduced.

Related Commands

show spb isis info Displays status and configuration information for the SPB instance

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 8-63
show spb isis ingress-mac-filter Shortest Path Bridging Commands

page 8-64 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 9 Loopback Detection
Commands

Loopback Detection (LBD) automatically detects the loop and shutdown the port involved in the loop.
This prevents forwarding loops on ports that have forwarded network traffic which has looped back to the
originating switch. LBD detects and prevents Layer 2 forwarding loops on a port either in the absence of
other loop detection mechanisms such as STP/RSTP/MSTP, or when these mechanisms cannot detect it
(for example, a client's equipment may drop BPDUs, or the STP protocol may be restricted to the network
edge). On a linkagg port, if one port of linkagg is getting shutdown due to LBD, then all the ports of
linkagg will go to shutdown state.
Loopback Detection is enabled system wide and on a per-port basis. Once a loop is discovered, the port
from which the loop originated is placed into an “Inactive” state and when the two ports of a switch is
connected to each other through a hub, either the ports will be shutdown or it will be in normal state.
A provider network with a set of multiple switches interconnected together can be logically viewed as a
large single switch. The large single switch provides service access points to customers' networks.
Configuration faults in customer networks can result in loops spanning both provider and customer
networks. This can result in broadcast storms. In order to protect provider's network from broadcast
storms, loops that involve SAP ports need to be detected and broken.
The LBD can detect and break loops created on the service-access interface.
For a service-access interface, LBD can be enabled for a specific port or linkagg. LBD for service-access
points allows shutting down only the specific interface of the link involved in the loop.
When loopback occurs, a trap is sent and the event is logged. The port which is shutdown due to LBD is
automatically recovered if autorecovery-timer is set or the port can manually be enabled again when the
problem is resolved.
MIB information for the Loopback Detection commands is as follows:
Filename: alcatelIND1LBD.mib
Module: ALCATEL-IND1-LBD-MIB
A summary of available commands is listed here:

loopback-detection
loopback-detection port
loopback-detection service-access
loopback-detection transmission-timer
loopback-detection autorecovery-timer
show loopback-detection
show loopback-detection port
show loopback-detection statistics port

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 9-1
loopback-detection Loopback Detection Commands

loopback-detection
Enables or disables Loopback Detection (LBD) or remote-origin LBD globally on the switch.
loopback-detection [remote-origin] {enable | disable}

Syntax Definitions

enable Enables LBD on the switch.

disable Disables LBD on the switch.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• LBD can be enabled globally and per port without any dependency. But, loopback-detection will be
operational only if LBD is enabled globally and also on the specific port.
• LBD can be configured for a port and the configuration can be applied and retained, whether or not
LBD is enabled globally. However, LBD functionality on a port is available only when LBD is enabled
globally on the switch.
• Enabling the remote-origin LBD allows to process the LBD frames originated from a remote system.
The port from which the LBD frames originated will be shut down.

Examples
-> loopback-detection enable
-> loopback-detection disable
-> loopback-detection remote-origin enable
-> loopback-detection remote-origin disable

Release History
Release 8.2.1; command was introduced.

page 9-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Loopback Detection Commands loopback-detection

Related Commands

loopback-detection port Enables or disables LBD on a specific port.

show loopback-detection Displays LBD configuration information.

MIB Objects
alaLbdGlobalConfigStatus
alaLbdGlobalRemoteConfigStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 9-3
loopback-detection port Loopback Detection Commands

loopback-detection port
Enables or disables LBD or remote-origin LBD on a specific port.
loopback-detection port chassis_id/slot/port[-port2] [remote-origin] {enable | disable}

Syntax Definitions

chassis_id The chassis ID number.

slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-8).
enable Enables LBD on the specified port.
disable Disables LBD on the specified port.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Loopback Detection must be enabled globally to enable LBD functionality on a specific port.

• LBD can be configured for a port and the configuration can be applied and retained, whether or not
LBD is enabled globally. However, LBD functionality on a port is available only when LBD is enabled
globally on the switch.
• When a LBD port joins a LBD linkagg, then LBD configuration on joined port is removed.

• For per port remote-origin LBD to work, both LBD and remote-origin LBD must be enabled globally.

Examples
-> loopback-detection port 1/1/1 enable
-> loopback-detection port 1/1/1-8 enable
-> loopback-detection port 1/1/2 remote-origin enable
-> loopback-detection port 1/1/3-5 remote-origin enable
-> loopback-detection port 1/1/2 remote-origin disable
-> loopback-detection port 1/1/3-5 remote-origin disable

Release History
Release 8.2.1; command was introduced.

page 9-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Loopback Detection Commands loopback-detection port

Related Commands

loopback-detection Enables or disables LBD globally on the switch.

show loopback-detection Displays LBD configuration information.
show loopback-detection port Displays LBD port configuration information.

MIB Objects
alaLbdPortConfigTable
alaLbdPortConfigEntry
alaLbdPortConfigIndex
alaLbdPortConfigLbdAdminStatus
alaLbdPortConfigLbdOperStatus
alaLbdPortRemoteConfigAdminStatus
alaLbdPortRemoteSrcMacAddr
alaLbdPortRemoteBridgeID

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 9-5
loopback-detection service-access Loopback Detection Commands

loopback-detection service-access
Allows to detect and break loops created on service access interface. Enables or disables LBD on a
specific port or range of ports or linkagg or range of linkagg for service access interface.
loopback-detection service-access {port chassis/slot/port[-port2] | linkagg agg_id[-agg_id2]} {enable |
disable}

Syntax Definitions

chassis_id The chassis ID number.

slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
enable Enables LBD on the specified port or linkagg.
disable Disables LBD on the specified port or linkagg.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Before configuring the LBD using the “service-access” option, the port or linkagg must be configured
for service access. Use the service access command, to configure the port or linkagg for service access.
• The service-access option allows shutting down only the specific interface of the link involved in the
loop.
• The linkagg must be formed by ports with same path cost.

• LBD is applicable on linkagg only if they are part of the service-access interface.

• LBD cannot be configured on linkagg, which has member ports running LBD configuration and vice
versa.
• When a linkagg is in violation or shutdown state, the member ports cannot be deleted from the linkagg.

Examples
-> loopback-detection service-access port 1/1/1 enable
-> loopback-detection service-access port 1/1/1-8 enable
-> loopback-detection service-access linkagg 1 enable

page 9-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Loopback Detection Commands loopback-detection service-access

Release History
Release 8.2.1; command was introduced.

Related Commands

loopback-detection Enables or disables LBD globally on the switch.

show loopback-detection Displays LBD configuration information.

MIB Objects
alaLbdPortConfigTable
alaLbdPortConfigLbdAdminStatus
alaLbdUserPortConfigLbdInterfaceType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 9-7
loopback-detection transmission-timer Loopback Detection Commands

loopback-detection transmission-timer
Configures the LBD transmission timer on the switch.The transmission time is the time period between the
consecutive LBD packet transmissions.
loopback-detection transmission-timer seconds

Syntax Definitions

seconds The time period in seconds between LBD packet transmissions. The
valid range is 5–600 seconds.

Defaults

parameter default
seconds 30

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the timer value is not configured, the default value of 30 seconds is assigned to the transmission
period.
• The timer can be modified at any time. However, the new timer value will come into effect only after
the timer is restarted.

Examples
-> loopback-detection transmission-timer 200

Release History
Release 8.2.1; command was introduced.

Related Commands

loopback-detection Enables or disables LBD globally on the switch.

show loopback-detection Displays LBD configuration information.

MIB Objects
alaLbdGlobalConfigStatus
alaLbdGlobalRemoteConfigStatus
alaLbdGLobalConfigTransmissionTimer

page 9-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Loopback Detection Commands loopback-detection autorecovery-timer

loopback-detection autorecovery-timer
Configures the LBD autorecovery timer on the switch.The autorecovery time is the time period in which
the switch is recovered from the shutdown state.
loopback-detection autorecovery-timer seconds

Syntax Definitions

seconds The time period, in seconds, in which the switch is recovered from the
shutdown state. The valid range is 30–86400 seconds.

Defaults

parameter default
seconds 300

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the timer value is not configured, the default value of 300 seconds is assigned to the autorecovery
period.
• The timer can be modified at any time. However, the new timer value will come into effect only after
the timer is restarted.

Examples
-> loopback-detection autorecovery-timer 200

Release History
Release 8.2.1; command was introduced.

Related Commands

loopback-detection Enables or disables LBD globally on the switch.

show loopback-detection Displays LBD configuration information.

MIB Objects
alaLbdGlobalConfigStatus
alaLbdGlobalRemoteConfigStatus
alaLbdGlobalConfigAutorecoveryTimer

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 9-9
show loopback-detection Loopback Detection Commands

show loopback-detection
Displays the global LBD configuration information for the switch.
show loopback-detection

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use this command to display the global configuration of LBD.

• To view information for a specific port, use the show loopback-detection port command.

Examples
-> show loopback-detection

Global LBD Status : enabled,

Global Remote-origin LBD Status : disabled,
Global LBD Transmission Timer : 30 sec,
Global LBD Auto-recovery Timer : 999 sec,

output definitions
Global LBD Status The current status of LBD of the switch (Enabled or Disabled).
Global Remote-origin LBD The current status of remote-origin LBD of the switch (Enabled or
Status Disabled).
Global LBD Transmission Displays the time interval in seconds between LBD packet
Timer transmissions.
Global LBD Auto-recovery Displays the time in which the switch recovered from the shutdown
Timer state.

Release History
Release 8.2.1; command was introduced.

page 9-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Loopback Detection Commands show loopback-detection

Related Commands

loopback-detection Enables or disables LBD globally on the switch.

show loopback-detection port Displays LBD configuration information for all ports on the switch.
violation recovery-maximum Displays the administrative status, link status, violations, recovery time,
maximum recovery attempts and the value of the wait-to-restore timer
for the specified port or ports.

MIB Objects
alaLbdGlobalConfigStatus
alaLbdGlobalRemoteConfigStatus
alaLbdGlobalConfigTransmissionTimer
alaLbdGlobalConfigAutorecoveryTimer

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 9-11
show loopback-detection port Loopback Detection Commands

show loopback-detection port

Displays global LBD configuration information on the switch. When slot and port number or linkagg ID is
specified, the LBD configuration information of the specific port or linkagg ID is displayed.
show loopback-detection {port chassis/slot/port] | linkagg agg_id}

Syntax Definitions

port Displays the LBD configuration for all ports.

chassis_id The chassis ID number.
slot/port The slot and port number (3/1).
agg_id The link aggregate ID number.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The command can be used only on LBD enabled port or linkagg.

Examples
-> show loopback-detection
Global LBD Status : enabled,
Global Remote-origin LBD Status : disabled,
Global LBD Transmission Timer : 30 sec,
Global LBD Auto-recovery Timer : 999 sec,

-> show loopback-detection port 1/1/1

Global LBD Status : enabled,
Global Remote-origin LBD Status : disabled,
Global LBD Transmission Timer : 30 sec,
Global LBD Auto-recovery Timer : 300 sec,
Port LBD Status : disabled,
Port Remote-origin LBD Status : disabled,
Port LBD State : Inactive,
Port LBD Type : service-edge

-> show loopback-detection port 1/1/1

Global LBD Status : enabled,
Global Remote-origin LBD Status : enabled,
Global LBD Transmission Timer : 30 sec,
Global LBD Auto-recovery Timer : 300 sec,
Port LBD Status : enabled,
Port Remote-origin LBD Status : enabled,
Port LBD State : Remote ShutDown,
Remote Src Mac : E8:E7:32:9A:5A:4E,

page 9-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Loopback Detection Commands show loopback-detection port

Remote BridgeId : E8:E7:32:9A:5A:3F,

Port LBD Type : normal-edge,

-> show loopback-detection linkagg 1

Global LBD Status : enabled,
Global Remote-origin LBD Status : disabled,
Global LBD Transmission Timer : 30 sec,
Global LBD Auto-recovery Timer : 300 sec,
Linkagg LBD Status : disabled,
Linkagg Remote-origin LBD Status : disabled,
Linkagg LBD State : Inactive,
Linkagg LBD Type : service-access

-> show loopback-detection port

Slot/Port Admin State Remote-origin Status OperState
-------------+---------------+-----------------------+-------------

1/2 enabled disabled Normal

1/1/1 enabled enabled Remote ShutDown

output definitions
Global LBD Status The current status of LBD of the switch (Enabled or Disabled).
Global Remote-origin LBD The current status of remote-origin LBD of the switch (Enabled or
Status Disabled).
Global LBD Transmission Displays the time interval in seconds between LBD packet
Timer transmissions.
Global LBD Auto-recovery Displays the time interval in seconds in which the switch is recovered
Timer from the shut down state.
Slot/Port The slot/port number LBD port.
Admin State The administrative state of the port (Enabled or Disabled).
Oper State The operational state of the port (Normal or Inactive).
Port LBD Status Displays the administrative status of the port.
Port Remote-origin LBD Displays the remote-origin LBD status of the port.
Status
Port LBD State Displays the current operational state of the port.
Remote Src Mac Displays the MAC address of the remote system. The Remote Src Mac
is displayed, only if remote-origin LBD is enabled on the system.
Remote BridgeId Displays the bridge ID of the remote system. The Remote BridgeId is
displayed, only if remote-origin LBD is enabled on the system.
Port LBD Type Displays the type of the interface – whether a normal edge interface or
a service access interface.
Linkagg LBD Status Displays the administrative status of the linkagg.
Linkagg Remote-origin LBD Displays the remote-origin LBD status of the linkagg.
Status
Linkagg LBD State Displays the current operational state of the linkagg.
Linkagg LBD Type Displays the type of the interface – whether a normal edge interface or
a service access interface.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 9-13
show loopback-detection port Loopback Detection Commands

Release History
Release 8.2.1; command was introduced.

Related Commands

loopback-detection Enables or disables LBD globally on the switch.

show loopback-detection port Displays LBD configuration information for the switch or for a specific
port.

MIB Objects
alaLbdGlobalConfigStatus
alaLbdGlobalRemoteConfigStatus
alaLbdPortConfigLbdAdminStatus
alaLbdPortConfigLbdOperStatus
alaLbdPortRemoteConfigAdminStatus
alaLbdPortConfigLbdInterfaceType

page 9-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Loopback Detection Commands show loopback-detection statistics port

show loopback-detection statistics port

Displays LBD statistics information for a specific port on the switch.
show loopback-detection statistics port chassis/slot/port

Syntax Definitions

chassis_id The chassis ID number.

slot/port The slot and port number (3/1).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The linkagg ID is not displayed if the linkagg is operationally down.

Examples
-> show loopback-detection statistics port 1/1/1

LBD Port Statistics

LBD Packet Send : 1,
Invalid LBD Packet Received : 0,
Member of Link Aggregation : -

-> show loopback-detection statistics port 1/1/3

LBD Port Statistics
LBD Packet Send : 1,
Invalid LBD Packet Received : 0,
Member of Aggregation : 2

output definitions
LBD Packet Send The number of LBD packet sent from the port.
Invalid LBD Packet Received The number of invalid LBD packets received on the port.
Member of Aggregation The linkagg ID in which the port is a member.

Release History
Release 8.2.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 9-15
show loopback-detection statistics port Loopback Detection Commands

Related Commands

loopback-detection Enables or disables LBD globally on the switch.

show loopback-detection port Displays LBD configuration information for the switch or for a specific
port.

MIB Objects
alaLbdGlobalConfigStatus
alaLbdPortStatsAggId

page 9-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 10 Link Aggregation
Commands

Link aggregation combines multiple physical links between two switches into one logical link. The
aggregate group operates within Spanning Tree as one virtual port and can provide more bandwidth than a
single link. It also provides redundancy. If one physical link in the aggregate group goes down, link
integrity is maintained.
There are two types of aggregate groups: static and dynamic. Static aggregate groups are manually
configured on the switch with static links. Dynamic groups are set up on the switch but they aggregate
links as necessary according to the Link Aggregation Control Protocol (LACP).
The dynamic aggregation software is compatible only with the following IEEE standard:
802.3ad — Aggregation of Multiple Link Segments
MIB information for the link aggregation commands is as follows:
Filename: AlcatelIND1LAG.MIB
Module: ALCATEL-IND1-LAG-MIB

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-1
 Link Aggregation Commands

A summary of available commands is listed here:

Static link aggregates linkagg static agg size

linkagg static agg name
linkagg static agg admin-state
linkagg static port agg
Dynamic link aggregates linkagg lacp agg size
linkagg lacp agg name
linkagg lacp agg admin-state
linkagg lacp agg actor admin-key
linkagg lacp agg actor system-priority
linkagg lacp agg actor system-id
linkagg lacp agg partner system-id
linkagg lacp agg partner system-priority
linkagg lacp agg partner admin-key
linkagg lacp port actor admin-key
linkagg lacp port actor admin-state
linkagg lacp port actor system-id
linkagg lacp port actor system-priority
linkagg lacp agg partner admin-state
linkagg lacp port partner admin system-id
linkagg lacp port partner admin-key
linkagg lacp port partner admin system-priority
linkagg lacp port actor port priority
linkagg lacp port partner admin-port
linkagg lacp port partner admin port-priority
Dual Home Link (DHL) dhl name
Active-Active dhl num linka linkb
dhl num admin-state
dhl num vlan-map linkb
dhl num pre-emption-time
dhl num mac-flushing
show dhl
show dhl num
show dhl num link
Static and dynamic linkagg range
show linkagg range
show linkagg
show linkagg port

page 10-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg static agg size

linkagg static agg size

Creates a static aggregate group between two switches. A static aggregate group contains static links.
linkagg static agg agg_id[-agg_id2] size size [name name] [admin-state {enable | disable}] [multi-
chassis active] [hash {source-mac | destination-mac | source-and-destination-mac | source-ip |
destination-ip | source-and-destination-ip | tunnel-protocol}]
no linkagg static agg agg_id[-agg_id2]

Syntax Definitions

agg_id The ID number corresponding to the static aggregate group.

-agg_id2 The last link aggregate ID in a range of link aggregate IDs.
size The maximum number of links allowed in the aggregate group.
name The name of the static aggregate group. Can be any alphanumeric string.
Spaces must be contained within quotes (for example, “Static Group
1”).
enable Specifies that the static aggregate group is active and is able to
disable Specifies that the static aggregate group is inactive and not able to
aggregate links.
multi-chassis active Note: This parameter is not supported in this release.
source-mac Selects the source MAC address hashing option.
destination-mac Selects the destination MAC address hashing option.
source-and-destination-mac Selects the source MAC address and destination MAC address hashing
option.
source-ip Selects the source IP hashing option.
destination-ip Selects the destination IP hashing option.
source-and-destination-ip Selects the source IP and destination IP hashing option.
tunnel-protocol Selects the tunnel protocol hashing option.

Defaults

parameter default
enable | disable enable
hash_option source-and-destination-ip (Layer 3 traffic)
source-and-destination-mac (Layer 2 traffic)

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a static aggregate group or a range of static aggregate
groups from the configuration.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-3
linkagg static agg size Link Aggregation Commands

• If the static aggregate has any attached ports you must delete the attached ports with the no form of the
linkagg static port agg command before you remove the static link aggregate ID. Delete the attached
ports using the no linkagg static port command.
• Specify the hash parameter option when the link aggregate is first created. The hashing algorithm
options apply to unicast traffic and are not modifiable once the aggregate is created. If different options
are required:
– Disassociate all ports currently associated with the aggregate.
– Delete the aggregate from the switch configuration.
– Create the aggregate again with the new hashing options.
• It is not necessary to administratively down the linkagg ports before changing the hashing algorithm,
but doing so is recommended.
• The hashing algorithm does not take into consideration the speed of the ports to distribute the traffic. In
other words, the same number of flows is distributed evenly on each port without consideration of the
line speed.
• Aggregate load balancing is performed at the ingress side.

• Per-aggregate hashing is local to the switch, so each side of the aggregation can use different
configurations for the hashing algorithms.
• Link aggregation follows the global hash control settings configured through the hash-control brief or
hash-control extended commands.
• For example, if the source-mac option is specified for L2 hashing:
– If the global hash-control is in brief mode, hashing is based on source MAC address only.
– If the global hash-control is in extended mode, hashing is based on source MAC address, VLAN,
Ethertype, and source module ID/port.
• For example, if the source-ip option is specified for L3 hashing:
– If the global hash-control is in brief mode, hashing is based on source IP address only.
– If the global hash-control is in extended mode, hashing is based on source IP address and source
UDP-TCP Port.
• To load balance Unknown Destination/Broadcast/Multicast traffic on all the ports of the aggregate, use
the hash-control command to enable load balancing of DFL traffic.
• Use the linkagg lacp agg size command to create a dynamic aggregation (LACP) group.

Examples
-> linkagg static agg 3-10 size 8
-> linkagg static agg 4 size 2 admin-state disable
-> linkagg static agg 4 size 2 multichassis-active
-> linkagg static agg 4 size 2 hash source-and-destination-ip
-> no linkagg static agg 3-10

Release History
Release 8.1.1; command introduced.

page 10-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg static agg size

Related Commands

show linkagg Displays information about static and dynamic (LACP) link aggregate
groups.

MIB Objects
alclnkaggAggTable
alclnkaggAggNumber
alclnkaggAggSize
alclnkaggAggLacpType
alclnkaggAggName
alclnkaggAggAdminState
alclnkAggPeerRangeOperMax

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-5
linkagg static agg name Link Aggregation Commands

linkagg static agg name

Configures a name for an existing static aggregate group.
linkagg static agg agg_id[-agg_id2] name name
no linkagg static agg agg_id[-agg_id2] name

Syntax Definitions

agg_id The ID number corresponding to the static aggregate group.

-agg_id2 The last link aggregate ID in a range of link aggregate IDs.
name The name of the static aggregation group, can be an alphanumeric
string. Spaces must be contained within quotes (for example, “Static
Group 1”).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a name from a static aggregate or from a range of static
aggregates.
• You must assign names to static link aggregate IDs individually.

• To specify a range of link aggregates, use hyphen between the first and last link aggregate IDs of the
range. A range of link aggregate IDs can be used only with the no form of this command.

Examples
-> linkagg static agg 2 name accounting
-> no linkagg static agg 2-10 name

Release History
Release 8.1.1; command introduced.

page 10-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg static agg name

Related Commands

linkagg static agg size Creates a static aggregate group.

show linkagg Displays information about static and dynamic (LACP) aggregate
groups.

MIB Objects
alclnkaggAggTable
alclnkaggAggNumber
alclnkaggAggName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-7
linkagg static agg admin-state Link Aggregation Commands

linkagg static agg admin-state

Enables or disables the administrative state of a static link aggregation group.
linkagg static agg agg_id[-agg_id2] admin-state {enable | disable}

Syntax Definitions

agg_id The number corresponding to the static aggregate group.

-agg_id The last link aggregate ID in a range of link aggregate IDs.
enable Specifies that the static aggregate group is active and is able to
disable Specifies that the static aggregate group is inactive and not able to
aggregate links.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
When the administrative state is set to disable, the static aggregate group is disabled.

Examples
-> linkagg static agg 2 admin-state disable

Release History
Release 8.1.1; command introduced.

Related Commands

linkagg static agg size Creates a static aggregate group.

show linkagg Displays information about static and dynamic (LACP) aggregate
groups.

MIB Objects
alclnkaggAggTable
alclnkaggAggNumber
alclnkaggAggAdminState

page 10-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg static port agg

linkagg static port agg

Configures a slot and port for a static aggregate group.
linkagg static port chassis_id/slot/port[-port2] agg agg_id
no linkagg static port chassis_id/slot/port[-port2]

Syntax Definitions

chassis_id The chassis ID number.

slot The slot number for this aggregate.
port The port that the switch initially uses as the Spanning Tree virtual port
for this aggregate.
-port2 The last port number in a range of port IDs.
agg_id The ID number corresponding to the static aggregate group.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove one or more ports from a static aggregate group.

• A port can belong to only one aggregate group.

• Ports that belong to the same static aggregate group need not be configured sequentially and can be on
any Network Interface (NI).
• To specify a range of link aggregates, use hyphen between the first and last link aggregate IDs of the
range. A range of link aggregate IDs can be used only with the no form of this command.

Examples
-> linkagg static port 2/1-5 agg 4
-> no linkagg static port 2/1-5

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-9
linkagg static port agg Link Aggregation Commands

Related Commands

linkagg static agg size Creates a static aggregate group.

show linkagg port Displays information about link aggregation ports.

MIB Objects
alclnkaggAggPortTable
alclnkaggAggPortGlobalPortNumber
alclnkaggAggPortLacpType
alclnkaggAggPortSelectedAggNumber

page 10-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp agg size

linkagg lacp agg size

Creates a dynamic aggregate group that uses the Link Aggregation Control Protocol (LACP) to establish
and maintain link aggregation. The size parameter is required to create the link aggregate group.
linkagg lacp agg agg_id[-agg_id2] size size
[name name]
[admin-state {enable | disable}]
[actor admin-key actor_admin_key]
[actor system-priority actor_system_priority]
[actor system-id actor_system_id]
[partner system-id partner_system_id]
[partner system-priority partner_system_priority]
[partner admin-key partner_admin_key]
[multi-chassis active]
[hash (source-mac | destination-mac | source-and-destination-mac | source-ip | destination-ip |
source-and-destination-ip}]
no linkagg lacp agg agg_id[-agg_id2] size size

Syntax Definitions

agg_id The ID number corresponding to the dynamic aggregate group.

-agg_id2 The last link aggregate ID in a range of link aggregate IDs.
size The maximum number of links that can belong to the aggregate.
name The name of the dynamic aggregate group. can be an alphanumeric
string. Spaces must be contained within quotes (for example, “Dynamic
Group 1”).
enable Specifies that the dynamic aggregate group is active and is able to
aggregate links.
disable Specifies that the dynamic aggregate group is inactive and not able to
aggregate links.
actor_admin_key The administrative key value associated with the dynamic aggregate
group.
actor_system_priority The priority of the dynamic aggregate group.
actor_system_id The MAC address of the dynamic aggregate group on the switch.
partner_system_id The MAC address of the aggregate group of the remote system which is
attached to the aggregate group of the switch.
partner_system_priority The priority of the remote system to which the aggregation group is
attached.
partner_admin_key The administrative key for the remote partner of the aggregation group.
multi-chassis active Note: This parameter is not supported in this release.
source-mac Selects the source MAC address hashing option.
destination-mac Selects the destination MAC address hashing option.
source-and-destination-mac Selects the source MAC address and destination MAC address hashing
option.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-11
linkagg lacp agg size Link Aggregation Commands

source-ip Selects the source IP hashing option.

destination-ip Selects the destination IP hashing option.
source-and-destination-ip Selects the source IP and destination IP hashing option.

Defaults

parameter default
enable | disable enable
hash_option source-and-destination-IP (Layer 3 traffic)
source-and-destination-mac (Layer 2 traffic)

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a dynamic aggregate group from the configuration.

• You must disable the group with the linkagg lacp agg admin-state command before you can delete a
dynamic link aggregate group.
• Optional parameters for the dynamic aggregate group can be configured when the aggregate is created.
The dynamic aggregate group can be modified after the optional parameters are assigned.
• Specify the hash parameter option when the link aggregate is first created. The hashing algorithm
options apply to unicast traffic and are not modifiable once the aggregate is created. If different options
are required:
– Disassociate all ports currently associated with the aggregate.
– Delete the aggregate from the switch configuration.
– Create the aggregate again with the new hashing options.
• It is not necessary to administratively down the linkagg ports before changing the hashing algorithm,
but doing so is recommended.
• The hashing algorithm does not take into consideration the speed of the ports to distribute the traffic. In
other words, the same number of flows is distributed evenly on each port without consideration of the
line speed.
• Aggregate load balancing is performed at the ingress side.

• Per-aggregate hashing is local to the switch, so each side of the aggregation can use different
configurations for the hashing algorithms.
• Link aggregation follows the global hash control settings configured through the hash-control brief or
hash-control extended commands.
• For example, if the source-mac option is specified for L2 hashing:
– If the global hash-control is in brief mode, hashing is based on source MAC address only.
– If the global hash-control is in extended mode, hashing is based on source MAC address, VLAN,
Ethertype, and source module ID/port.

page 10-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp agg size

• For example, if the source-ip option is specified for L3 hashing:

– If the global hash-control is in brief mode, hashing is based on source IP address only.
– If the global hash-control is in extended mode, hashing is based on source IP address and source
UDP-TCP Port.
• To load balance Unknown Destination/Broadcast/Multicast traffic on all the ports of the aggregate, use
the hash-control command to enable load balancing of DFL traffic.
• Use the linkagg static agg size command to create static aggregate groups. See page 10-3 for more
information about this command.

Examples
-> linkagg lacp agg 2-5 size 4
-> linkagg lacp agg 3 size 2 admin-state disable actor system-priority 65535
-> no linkagg lacp agg 2-5 size 4

Release History
Release 8.1.1; command introduced.

Related Commands

show linkagg Displays information about static and dynamic (LACP) aggregate
groups.

MIB Objects
alclnkaggAggTable
alclnkaggAggNumber
alclnkaggAggSize
alclnkaggAggLacpType
alclnkaggAggName
alclnkaggAggAdminState
alclnkaggAggActorAdminKey
alclnkaggAggActorSystemPriority
alclnkaggAggActorSystemID
alclnkaggAggPartnerSystemID
alclnkaggAggPartnerSystemPriority
alclnkaggAggPartnerAdminKey

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-13
linkagg lacp agg name Link Aggregation Commands

linkagg lacp agg name

Configures a name for a dynamic aggregate group.
linkagg lacp agg agg_id name name
no linkagg lacp agg agg_id[-agg_id2] name

Syntax Definitions

agg_id The ID number corresponding to the dynamic aggregate group.

-agg_id2 The last link aggregate ID in a range of link aggregate IDs.
name The name of the dynamic aggregate group. Can be an alphanumeric
string. Spaces must be contained within quotes (for example, “Dynamic
Group 1”).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a name from a single or a range of dynamic aggregate
groups simultaneously.
• Assign names to individual dynamic link aggregate groups separately.

Examples
-> linkagg lacp agg 2 name finance
-> no linkagg lacp agg 2-5 name

Release History
Release 8.1.1; command introduced.

page 10-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp agg name

Related Commands

linkagg lacp agg size Creates a dynamic aggregate group.

show linkagg Displays information about static and dynamic (LACP) aggregate
groups.

MIB Objects
alclnkaggAggTable
alclnkaggAggNumber
alclnkaggAggName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-15
linkagg lacp agg admin-state Link Aggregation Commands

linkagg lacp agg admin-state

Configures the administrative state of a dynamic aggregate group or a range of dynamic aggregate groups.
linkagg lacp agg agg_id[-agg_id2] admin-state {enable | disable}

Syntax Definitions

agg_id The ID number corresponding to the dynamic aggregate group.

-agg_id2 The last link aggregate ID in a range of link aggregate IDs.
enable Specifies that the dynamic aggregate group is active and is able to
aggregate links.
disable Specifies that the operation of a dynamic aggregate group cannot be
performed.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When the administrative state is set to disable, the operation of a dynamic aggregation (LACP) group
cannot be performed.
• You can also enable or disable the admin-state for a range of link aggregate IDs simultaneously, using
this command.

Examples
-> linkagg lacp agg 2 admin-state disable
-> linkagg lacp agg 2-10 admin-state disable

Release History
Release 8.1.1; command introduced.

page 10-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp agg admin-state

Related Commands

linkagg lacp agg size Creates a dynamic aggregate group.

show linkagg Displays information about static and dynamic (LACP) aggregate
groups.
show linkagg port Displays information about ports associated with a particular aggregate
group or all aggregates.

MIB Objects
alclnkaggAggTable
alclnkaggAggNumber
alclnkaggAggAdminState

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-17
linkagg lacp agg actor admin-key Link Aggregation Commands

linkagg lacp agg actor admin-key

Configures the administrative key associated with a dynamic aggregate group.
linkagg lacp agg agg_id[-agg_id2] actor admin-key actor_admin_key
no linkagg lacp agg agg_id[-agg_id2] actor admin-key

Syntax Definitions

agg_id The ID number corresponding to the dynamic aggregate group.

-agg_id The last link aggregate ID in a range of link aggregate IDs.
actor_admin_key The administrative key value associated with the dynamic aggregate
group.

Defaults

parameter default
actor_admin_key 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to remove an actor admin key from a dynamic aggregate group.

Examples
-> linkagg lacp agg 3-5 actor admin-key 2
-> no linkagg lacp agg 3-5 actor admin-key

Release History
Release 8.1.1; command introduced.

Related Commands

linkagg lacp agg size Creates a dynamic aggregate group.

show linkagg Displays information about static and dynamic (LACP) aggregate
groups.

MIB Objects
alclnkaggAggTable
alclnkaggAggNumber
alclnkaggAggActorAdminKey

page 10-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp agg actor system-priority

linkagg lacp agg actor system-priority

Configures the priority of the dynamic aggregate group.
linkagg lacp agg agg_id[-agg_id2] actor system-priority actor_system_priority
no linkagg lacp agg agg_id[-agg_id2] actor system-priority

Syntax Definitions

agg_id The ID number corresponding to the link aggregate group.

-agg_id2 The last link aggregate ID in a range of link aggregate IDs.
actor_system_priority The priority of the dynamic aggregate group of the switch in relation to
other aggregate groups.

Defaults

parameter default
actor_system_priority 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to return the value to its default.

• Ports with the same system priority value can join the same dynamic aggregate group.

• To assign or remove the actor system-priority for a series of link aggregate IDs, specify the range of
link aggregate IDs with the agg keyword. Use a hyphen to separate the first and last link aggregate IDs
of a range.

Examples
-> lacp linkagg 3 actor system-priority 100
-> no lacp linkagg 3 actor system-priority

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-19
linkagg lacp agg actor system-priority Link Aggregation Commands

Related Commands

linkagg lacp agg size Creates a dynamic aggregate group.

show linkagg Displays information about static and dynamic (LACP) aggregate
groups.

MIB Objects
alclnkaggAggTable
alclnkaggAggNumber
alclnkaggAggActorSystemPriority

page 10-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp agg actor system-id

linkagg lacp agg actor system-id

Configures the MAC address of a dynamic aggregate group on the switch.
linkagg lacp agg agg_id[-agg_id2] actor system-id actor_system_id
no linkagg lacp agg agg_id[-agg_id2] actor system-id

Syntax Definitions

agg_id The ID number corresponding to the dynamic aggregate group.

-agg_id2 The last link aggregate ID in a range of link aggregate IDs.
actor_system_id The MAC address of the dynamic aggregate group on the switch in the
hexadecimal format xx:xx:xx:xx:xx:xx.

Defaults

parameter default
actor_system_id 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the MAC address assignment (actor system ID) from a
dynamic link aggregate or a range of dynamic link aggregates simultaneously.
• You can configure the MAC address for a range of dynamic link aggregate IDs simultaneously. Use a
hyphen to separate the first and last link aggregate IDs of a range along with this command.

Examples
-> linkagg lacp agg 2 actor system-id 00:20:da:81:d5:b0
-> no linkagg lacp agg 3-10 actor system-id
-> no linkagg lacp agg 11 actor system-id

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-21
linkagg lacp agg actor system-id Link Aggregation Commands

Related Commands

linkagg lacp agg size Creates a dynamic aggregate group.

show linkagg Displays information about static and dynamic (LACP) aggregate
groups.

MIB Objects
alclnkaggAggTable
alclnkaggAggNumber
alclnkaggAggActorSystemID

page 10-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp agg partner system-id

linkagg lacp agg partner system-id

Configures the MAC address of the dynamic aggregate group of the remote system that is attached to the
dynamic aggregate group of the local switch.
linkagg lacp agg agg_id[-agg_id2] partner system-id partner_system_id
no linkagg lacp agg agg_id[-agg_id2] partner system-id

Syntax Definitions

agg_id The ID number corresponding to the dynamic aggregate group on the

switch.
-agg_id2 The last link aggregate ID in a range of link aggregate IDs.
partner_system_id The MAC address of the dynamic aggregate group of the remote switch
in the hexadecimal format xx:xx:xx:xx:xx:xx.

Defaults

parameter default
partner_system_id 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a partner system ID from a dynamic aggregate group or a
range of groups assigned with the same partner system IDs together.
• The partner_system_id and the partner_system_priority together specify the priority of the remote
system.
• You can configure a partner system ID for a range of dynamic link aggregate IDs simultaneously. Use
a hyphen to separate the first and last link aggregate IDs of a range along with this command.

Examples
-> linkagg lacp agg 2 partner system-id 00:20:da4:32:81
-> linkagg lacp agg 2-10 partner system-id 00:20:da4:32:82
-> no linkagg lacp agg 2-10 partner system-id

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-23
linkagg lacp agg partner system-id Link Aggregation Commands

Related Commands

linkagg lacp agg size Creates a dynamic aggregate group.

show linkagg Displays information about static and dynamic (LACP) aggregate
groups.

MIB Objects
alclnkaggAggTable
alclnkaggAggNumber
alclnkaggAggPartnerSystemID

page 10-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp agg partner system-priority

linkagg lacp agg partner system-priority

Configures the priority of the dynamic aggregate group of the remote system which is attached to the
dynamic aggregate group of the local switch.
linkagg lacp agg agg_id[-agg_id2] partner system-priority partner_system_priority
no linkagg lacp agg agg_id[-agg_id2] partner system-priority

Syntax Definitions

agg_id The ID number corresponding to the dynamic aggregate group.

-agg_id2 The last link aggregate ID in a range of link aggregate IDs.
partner_system_priority The priority of the dynamic aggregate group of the remote system which
is attached to the dynamic aggregate group of the local switch.

Defaults

parameter default
partner_system_priority 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to return to the priority value to its default.

• The partner_system_id and the partner_system_priority together specify the priority of the remote
system.
• You can apply the partner system-priority to a range of link aggregate IDs simultaneously. Use a
hyphen to separate the first and last link aggregate IDs of a range after the agg keyword.

Examples
-> linkagg lacp agg 3 partner system-priority 65535
-> linkagg lacp agg 3-6 partner system-priority 65535
-> no linkagg lacp agg 3-6 partner system-priority

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-25
linkagg lacp agg partner system-priority Link Aggregation Commands

Related Commands

linkagg lacp agg size Creates a dynamic aggregate group.

show linkagg Displays information about static and dynamic (LACP) aggregate
groups.

MIB Objects
alclnkaggAggTable
alclnkaggAggNumber
alclnkaggAggPartnerSystemPriority

page 10-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp agg partner admin-key

linkagg lacp agg partner admin-key

Configures the administrative key for the remote partner of the dynamic aggregation group.
linkagg lacp agg agg_id[-agg_id2] partner admin-key partner_admin_key
no linkagg lacp agg agg_id[-agg_id2] partner admin-key

Syntax Definitions

agg_id The ID number corresponding to the dynamic aggregate group.

-agg_id2 The last link aggregate ID in a range of link aggregate IDs.
partner_admin_key The administrative key for the remote partner of the dynamic
aggregation group.

Defaults

parameter default
partner_admin_key 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a partner admin-key from a dynamic aggregate group.

• The partner admin-key can be assigned for a range of dynamic link aggregate IDs simultaneously.

Examples
-> linkagg lacp agg 3-5 partner admin-key 3
-> no linkagg lacp agg 3-10 partner admin-key

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-27
linkagg lacp agg partner admin-key Link Aggregation Commands

Related Commands

linkagg lacp agg size Creates a dynamic aggregate group.

show linkagg Displays information about static and dynamic (LACP) aggregate
groups.

MIB Objects
alclnkaggAggTable
alclnkaggAggNumber
alclnkaggAggPartnerAdminKey

page 10-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp port actor admin-key

linkagg lacp port actor admin-key

Configures an actor administrative key for a port, which allows the port to join a dynamic aggregate
group.
linkagg lacp port chassis_id/slot/port[-port2] actor admin-key actor_admin_key
[actor admin-state {[active] [timeout] [aggregate] [synchronize] [collect] [distribute] [default]
[expire] | none}]
[actor system id actor_system_id]
[actor system priority actor_system_priority]
[partner admin system id partner_admin_system_id]
[partner admin-key partner_admin_key]
[partner admin system priority partner_admin_system_priority]
[partner admin-state {[active] [timeout] [aggregate] [synchronize] [collect] [distribute] [default]
[expire] | none}]
[actor port priority actor_port_priority]
[partner admin port partner_admin_port]
[partner admin port priority partner_admin_port_priority]
no linkagg lacp port chassis_id/slot/port[-port2] [actor admin-state {[active] [timeout] [aggregate]
[synchronize] [collect] [distribute] [default] [expire] | none}]
[actor system id actor_system_id]
[actor system priority actor_system_priority]
[partner admin system id partner_admin_system_id]
[partner admin-key partner_admin_key]
[partner admin system priority partner_admin_system_priority]
[partner admin-state {[active] [timeout] [aggregate] [synchronize] [collect] [distribute] [default]
[expire] | none}]
[actor port priority actor_port_priority]
[partner admin port partner_admin_port]
[partner admin port priority partner_admin_port_priority]

Syntax Definitions

chassis_id The chassis ID number.

slot The slot number for this aggregate.
port The port that the switch initially uses as the Spanning Tree virtual port
for this aggregate.
-port2 The last port number in a range of slot/port IDs.
actor_admin_key The administrative key associated with this dynamic aggregate group.
actor admin-state See the linkagg lacp port actor admin-state command.
actor_system_id The MAC address of this dynamic aggregate group on the switch.
actor_system_priority The priority of the dynamic aggregate group.
partner_admin_system_id The MAC address of the dynamic aggregate group of the remote switch.
partner_admin_key The administrative key for the remote partner of the dynamic
aggregation group.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-29
linkagg lacp port actor admin-key Link Aggregation Commands

partner_admin_system_priority The priority of the remote system to which the dynamic aggregation
group is attached.
partner admin-state See the linkagg lacp agg partner admin-state command.
actor_port_priority The priority of the actor port.
partner_admin_port The administrative state of the partner port.
partner_admin_port_priority The priority of the partner port.

Defaults

parameter default
[active] [timeout] .... active, timeout, aggregate

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a slot and port from a dynamic aggregate group.

• A port can belong to only one aggregate group.

• Ports that belong to a dynamic link aggregate must be configured to the same link speed.

• Ports that belong to the same dynamic aggregate group need not be configured sequentially and can be
on any Network Interface (NI).

Examples
-> linkagg lacp agg 3/1 actor admin-key 0
-> no linkagg lacp agg 3/1 actor admin-key

Release History
Release 8.1.1; command introduced.

Related Commands

linkagg lacp agg size Creates a dynamic aggregate group.

show linkagg port Displays information about ports associated with a particular aggregate
group or all aggregates.

page 10-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp port actor admin-key

MIB Objects
alclnkaggAggPortTable
alclnkaggAggPortGlobalPortNumber
alclnkaggAggActorAdminKey
alclnkaggAggPortLacpType
alclnkaggAggPortActorAdminState
alclnkaggAggPortActorSystemID
alclnkaggAggPortActorSystemPriority
alclnkaggAggPortPartnerAdminSystemID
alclnkaggAggPortPartnerAdminKey
alclnkaggAggPortPartnerAdminSystemPriority
alclnkaggAggPortPartnerAdminState
alclnkaggAggPortActorPortPriority
alclnkaggAggPortPartnerAdminPort
alclnkaggAggPortPartnerAdminPortPriority

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-31
linkagg lacp port actor admin-state Link Aggregation Commands

linkagg lacp port actor admin-state

Configures the system administrative state of the slot and port for the dynamic aggregate group on the
local switch. The state values correspond to bits in the actor state octet in the LACPDU frame.
linkagg lacp port chassis_id/slot/port[-port2] actor admin-state {[active] [timeout] [aggregate]
[synchronize] [collect] [distribute] [default] [expire] | none}
no linkagg lacp port chassis_id/slot/port[-port2] actor admin-state {[active] [timeout] [aggregate]
[synchronize] [collect] [distribute] [default] [expire] | none}

Syntax Definitions

chassis_id The chassis ID number.

slot The slot number for this aggregate.
port The port that the switch initially uses as the Spanning Tree virtual port
for this aggregate.
-port2 The last port number in a range of port IDs.
active Specifies that bit 0 in the actor state octet is enabled. When this bit is set,
the dynamic aggregate group is able to exchange LACPDU frames. By
default, this value is set.
timeout Specifies that bit 1 in the actor state octet is enabled. When this bit is set,
a short timeout is used for LACPDU frames. When this bit is disabled, a
long timeout is used for LACPDU frames. By default, this value is set.
aggregate Specifies that bit 2 in the actor state octet is enabled. When this bit is set,
the system considers this port to be a potential candidate for
aggregation. If this bit is not enabled, the system considers the port to be
individual (it can only operate as a single link). By default, this value is
set.
synchronize Specifying that this keyword has no effect because the system always
determines its value. When this bit (bit 3) is set by the system, the port is
allocated to the correct dynamic aggregation group. If this bit is not set
by the system, the port is not allocated to the correct dynamic
aggregation group.
collect Specifying that this keyword has no effect because the system always
determines its value. When this bit (bit 4) is set by the system, incoming
LACPDU frames are collected from the individual ports that make up
the dynamic aggregate group.
distribute Specifying that this keyword has no effect because the system always
determines its value. When this bit (bit 5) is set by the system,
distributing outgoing frames on the port is disabled.
default Specifying that this keyword has no effect because the system always
determines its value. When this bit (bit 6) is set by the system, it
indicates that the actor is using the defaulted partner information
administratively configured for the partner.

page 10-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp port actor admin-state

expire Specifying that this keyword has no effect because the system always
determines its value. When this bit (bit 7) is set by the system, the actor
cannot receive LACPDU frames.
none Resets all administrative states to their default configurations.

Defaults

parameter default
[active] [timeout] .... active, timeout, aggregate

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to restore the LACPDU bit settings to their default configuration.

• When the actor admin-state is set to none, all bit values are restored to their default configurations.

Examples
-> linkagg lacp port 4/2 actor admin-state synchronize collect distribute
-> no linkagg lacp port 4/2 actor admin-state synchronize collect
-> linkagg lacp port 4/2 actor admin-state none

Release History
Release 8.1.1; command introduced.

Related Commands

linkagg lacp agg size Creates a dynamic aggregate group.

show linkagg port Displays information about ports associated with a particular aggregate
group or all aggregate groups.

MIB Objects
alclnkaggAggPortTable
alclnkaggAggPortGlobalPortNumber
alclnkaggAggPortActorAdminState

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-33
linkagg lacp port actor system-id Link Aggregation Commands

linkagg lacp port actor system-id

Configures the system ID (i.e., MAC address) for the local port associated with a dynamic aggregate
group.
linkagg lacp port chassis_id/slot/port[-port2] actor system-id actor_system_id
no linkagg lacp port chassis_id/slot/port[-port2] actor system-id

Syntax Definitions

chassis_id The chassis ID number.

slot The slot number for this aggregate.
port The port that the switch initially uses as the Spanning Tree virtual port
for this aggregate.
-port2 The last port number in a range of port IDs.
actor_system_id The MAC address of the dynamic aggregate group on the switch in the
hexadecimal format xx:xx:xx:xx:xx:xx.

Defaults

parameter default
actor_system_id 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the actor system ID from a slot and port or a range of slot
and ports associated with a dynamic aggregate group.
• Configure the system ID for a range of local ports simultaneously. Use a hyphen to separate the first
and last port IDs of a range after the port keyword.

Examples
-> linkagg lacp port 3/1-10 actor system-id 00:20:da:06:ba:d3
-> no linkagg lacp port 3/1-10 actor system-id

Release History
Release 8.1.1; command introduced.

page 10-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp port actor system-id

Related Commands

linkagg lacp agg size Creates a dynamic aggregate group.

show linkagg port Displays information about ports associated with a particular aggregate
group or all aggregate groups.

MIB Objects
alclnkaggAggPortTable
alclnkaggAggPortGlobalPortNumber
alclnkaggAggPortActorSystemID

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-35
linkagg lacp port actor system-priority Link Aggregation Commands

linkagg lacp port actor system-priority

Configures the system priority of the port on the switch that belongs to the dynamic aggregate group.
linkagg lacp port chassis_id/slot/port[-port2] actor system-priority actor_system_priority
no linkagg lacp port chassis_id/slot/port[-port2] actor system-priority

Syntax Definitions

chassis_id The chassis ID number.

slot The slot number for this aggregate.
port The port that the switch initially uses as the Spanning Tree virtual port
for this aggregate.
-port2 The last port number in a range of port IDs.
actor_system_priority The priority of the dynamic aggregate group.

Defaults

parameter default
actor_system_priority 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an actor system priority value from a slot and port or a
range of slot and ports associated with a dynamic aggregate group.
• Configure the actor system-priority to a range of ports simultaneously. Use a hyphen to separate the
first and last port of a range after the port keyword.

Examples
-> linkagg lacp port 3/2-10 actor system-priority 65
-> no linkagg lacp port 3/2-10 actor system-priority

Release History
Release 8.1.1; command introduced.

page 10-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp port actor system-priority

Related Commands

linkagg lacp agg size Creates a dynamic aggregate group.

show linkagg port Displays information about ports associated with a particular aggregate
group or all aggregates.

MIB Objects
AlcLnkAggAggPortTable
alclnkaggAggPortGlobalPortNumber
alclnkaggAggPortActorSystemPriority

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-37
linkagg lacp agg partner admin-state Link Aggregation Commands

linkagg lacp agg partner admin-state

Configures the system administrative state of the slot and port for the dynamic aggregate group on the
remote switch. The state values correspond to bits in the actor state octet in the LACPDU frame.
linkagg lacp port chassis_id//slot/port[-port2] partner admin-state {[active] [timeout] [aggregate]
[synchronize] [collect] [distribute] [default] [expire] | none}
no linkagg lacp port chassis_id//slot/port[-port2] partner admin-state {[active] [timeout] [aggregate]
[synchronize] [collect] [distribute] [default] [expire] | none}

Syntax Definitions

chassis_id The chassis ID number.

slot The slot number for this aggregate.
port The port that the switch initially uses as the Spanning Tree virtual port
for this aggregate.
-port2 The last port number in a range of port IDs.
active Specifies that bit 0 in the partner state octet is enabled. When this bit is
set, the dynamic aggregate group is able to exchange LACPDU frames.
By default, this value is set.
timeout Specifies that bit 1 in the partner state octet is enabled. When this bit is
set, a short timeout is used for LACPDU frames. When this bit is
disabled, a long timeout is used for LACPDU frames. By default, this
value is set.
aggregate Specifies that bit 2 in the partner state octet is enabled. When this bit is
set, the system considers this port to be a potential candidate for
aggregation. If this bit is not enabled, the system considers the port to be
individual (it can only operate as a single link). By default, this value is
set.
synchronize Specifies that bit 3 in the partner state octet is enabled. When this bit is
set, the port is allocated to the correct dynamic aggregation group. If this
bit is not enabled, the port is not allocated to the correct aggregation
group. By default, this value is disabled.
collect Specifying this keyword has no effect because the system always
determines its value. When this bit (bit 4) is set by the system, incoming
LACPDU frames are collected from the individual ports that make up
the dynamic aggregate group.
distribute Specifying that this keyword has no effect because the system always
determines its value. When this bit (bit 5) is set by the system,
distributing outgoing frames on the port is disabled.
default Specifying that this keyword has no effect because the system always
determines its value. When this bit (bit 6) is set by the system, it
indicates that the partner is using the defaulted actor information
administratively configured for the actor.

page 10-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp agg partner admin-state

expire Specifying that this keyword has no effect because the system always
determines its value. When this bit (bit 7) is set by the system, the
partner cannot receive LACPDU frames.
none Resets all administrative states to their default configurations.

Defaults

parameter default
[active] [timeout] .... active, timeout, aggregate

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to restore the LACPDU bit settings to their default configuration for
a single port or a range of ports.
• When the partner admin-state is set to none, all bit values are restored to their default configurations.

• Configure the system administrative state for a range of ports simultaneously. Use a hyphen to
separate the first and last port of a range after the port keyword.

Examples
-> lacp port 4/2-10 partner admin-state synchronize collect distribute
-> no lacp agg 4/2-10 partner admin-state synchronize collect

Release History
Release 8.1.1; command introduced.

Related Commands

linkagg lacp agg size Creates a dynamic aggregate group.

show linkagg port Displays information about ports associated with a particular aggregate
group or all aggregate groups.

MIB Objects
alclnkaggAggPortTable
alclnkaggAggPortGlobalPortNumber
alclnkaggAggPortPartnerAdminState

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-39
linkagg lacp port partner admin system-id Link Aggregation Commands

linkagg lacp port partner admin system-id

Configures the partner administrative system ID for a dynamic aggregate group port.
linkagg lacp port chassis_id//slot/port[-port2] partner admin system-id partner_admin_system_id
no linkagg lacp port chassis_id//slot/port[-port2] partner admin system-id

Syntax Definitions

chassis_id The chassis ID number.

slot The slot number for this aggregate.
port The port that the switch initially uses as the Spanning Tree virtual port
for this aggregate.
-port2 The last port number in a range of port IDs.
partner_admin_system_id The MAC address of the remote dynamic aggregate group in the
hexadecimal format xx:xx:xx:xx:xx:xx.

Defaults

parameter default
partner_admin_system_id 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to remove a partner administrative system ID from a slot and port or a
range of slot and ports associated with a dynamic aggregate group.

Examples
-> linkagg lacp port 3/1-10 partner admin system-id 00:20:da:05:f6:23

Release History
Release 8.1.1; command introduced.

page 10-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp port partner admin system-id

Related Commands

linkagg lacp agg size Creates a dynamic aggregate group.

show linkagg port Displays information about ports associated with a particular aggregate
group or all aggregate groups.

MIB Objects
AlcLnkAggAggPortTable
alclnkaggAggPortGlobalPortNumber
alclnkaggAggPortPartnerAdminSystemID

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-41
linkagg lacp port partner admin-key Link Aggregation Commands

linkagg lacp port partner admin-key

Configures the partner administrative key for a dynamic aggregate group port.
linkagg lacp port chassis_id/slot/port[-port2] partner admin-key partner_admin_key
no linkagg lacp port chassis_id/slot/port[-port2] partner admin-key

Syntax Definitions

chassis_id The chassis ID number.

slot The slot number for this aggregate.
port The port that the switch initially uses as the Spanning Tree virtual port
for this aggregate.
-port2 The last port number in a range of port IDs.
partner_admin_key The administrative key for the remote partner of a dynamic aggregation
group.

Defaults

parameter default
partner_admin_key 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a partner admin key value from a slot and port or a range
of slot and ports associated with a dynamic aggregate group.

Examples
-> linkagg lacp port 2/1-5 partner admin-key 0
-> no linkagg lacp port 2/1-5 partner admin-key

Release History
Release 8.1.1; command introduced.

page 10-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp port partner admin-key

Related Commands

linkagg lacp agg size Creates a dynamic aggregate group.

show linkagg port Displays information about ports associated with a particular aggregate
group or all aggregate groups.

MIB Objects
AlcLnkAggAggPortTable
alclnkaggAggPortGlobalPortNumber
alclnkaggAggPortPartnerAdminKey

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-43
linkagg lacp port partner admin system-priority Link Aggregation Commands

linkagg lacp port partner admin system-priority

Configures the partner system priority for a dynamic aggregate group port.
linkagg lacp port chassis_id/slot/port[-port2] partner admin system-priority
partner_admin_system_priority
no linkagg lacp port chassis_id/slot/port[-port2] partner admin system-priority

Syntax Definitions

chassis_id The chassis ID number.

slot The slot number for this aggregate.
port The port that the switch initially uses as the Spanning Tree virtual port
for this aggregate.
-port2 The last port number in a range of port IDs.
partner_admin_system_priority The priority of the dynamic aggregate group of the remote switch to
which the aggregation group is attached.

Defaults

parameter default
partner_admin_system_priority 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to remove a partner_system_priority value from a slot and port
or a range of slot and ports associated with a dynamic aggregate group.

Examples
-> linkagg lacp port 2/1-5 partner admin system-priority 65
-> no linkagg lacp port 2/1-5 partner admin system-priority

Release History
Release 8.1.1; command introduced.

page 10-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp port partner admin system-priority

Related Commands

linkagg lacp agg size Creates a dynamic aggregate group.

show linkagg port Displays information about ports associated with a particular aggregate
group or all aggregate groups.

MIB Objects
AlcLnkAggAggPortTable
alclnkaggAggPortGlobalPortNumber
alclnkaggAggPortAdminSystemPriority

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-45
linkagg lacp port actor port priority Link Aggregation Commands

linkagg lacp port actor port priority

Configures the priority for an actor port.
linkagg lacp port chassis_id/slot/port[-port2] actor port-priority actor_port_priority
no linkagg lacp port chassis_id/slot/port[-port2] actor port-priority

Syntax Definitions

chassis_id The chassis ID number.

slot The slot number for this aggregate.
port The port that the switch initially uses as the Spanning Tree virtual port
for this aggregate.
-port2 The last port number in a range of port IDs.
actor_port_priority The priority of the actor port.

Defaults

parameter default
actor_port_priority 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to remove an actor_port_priority value from a slot and port
or a range of slot and ports associated with a dynamic aggregate group.

Examples
-> linkagg lacp port 2/1-5 actor port-priority 100
-> no linkagg lacp port 2/1-5 actor port-priority

Release History
Release 8.1.1; command introduced.

page 10-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp port actor port priority

Related Commands

linkagg lacp agg size Creates a dynamic aggregate group.

show linkagg port Displays information about ports associated with a particular aggregate
group or all aggregate groups.

MIB Objects
AlcLnkAggAggPortTable
alclnkaggAggPortGlobalPortNumber
alclnkaggAggPortActorPortPriority

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-47
linkagg lacp port partner admin-port Link Aggregation Commands

linkagg lacp port partner admin-port

Configures the administrative status of a partner port.
linkagg lacp port chassis_id/slot/port[-port2] partner admin-port partner_admin_port
no linkagg lacp port chassis_id/slot/port[-port2] partner admin-port

Syntax Definitions

chassis_id The chassis ID number.

slot The slot number for this aggregate.
port The port that the switch initially uses as the Spanning Tree virtual port
for this aggregate.
-port2 The last port number in a range of port IDs.
partner_admin_port The administrative state of the partner port.

Defaults

parameter default
partner_admin_port 0

N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to remove a partner_admin_port value from a slot and port or a range of
slot and ports associated with a dynamic aggregate group.

Examples
-> linkagg lacp port 2/1-5 partner admin-port 255
-> no linkagg lacp port 2/1-5 partner admin-port

Release History
Release 8.1.1; command introduced.

page 10-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp port partner admin-port

Related Commands

linkagg lacp agg size Creates a dynamic aggregate group.

show linkagg port Displays information about ports associated with a particular aggregate
group or all aggregate groups.

MIB Objects
AlcLnkAggAggPortTable
alclnkaggAggPortGlobalPortNumber
alclnkaggAggPortPartnerAdminPort

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-49
linkagg lacp port partner admin port-priority Link Aggregation Commands

linkagg lacp port partner admin port-priority

Configures the priority for a partner port.
linkagg lacp port chassis_id/slot/port[-port2] partner admin port-priority partner_admin_port_priority
no linkagg lacp port chassis_id/slot/port[-port2] partner admin port-priority

Syntax Definitions

chassis_id The chassis ID number.

slot The slot number for this aggregate.
port The port that the switch initially uses as the Spanning Tree virtual port
for this aggregate.
-port2 The last port number in a range of port IDs.
partner_admin_port_priority The priority of the partner port.

Defaults

parameter default
partner_admin_port_priority 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to remove a partner_admin_port_priority value from a slot and port or a
range of slot and ports associated with a dynamic aggregate group.

Examples
-> linkagg lacp port 2/1-5 partner admin port-priority 100
-> no linkagg lacp port 2/1-5 partner admin port-priority

page 10-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg lacp port partner admin port-priority

Release History
Release 8.1.1; command introduced.

Related Commands

linkagg lacp agg size Creates a dynamic aggregate group.

show linkagg port Displays information about ports associated with a particular aggregate
group or all aggregate groups.

MIB Objects
AlcLnkAggAggPortTable
alclnkaggAggPortGlobalPortNumber
alclnkaggAggPortPartnerAdminPortPriority

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-51
dhl name Link Aggregation Commands

dhl name
Configures a Dual-homed Link (DHL) session associated with the specified session ID number.
dhl dhl_num [name name]
no dhl dhl_num

Syntax Definitions

dhl_num The DHL session ID number. Valid range is 1–1000.

name The name of the DHL session.

Defaults
By default, if a name is not assigned to a DHL session, the session is configured as DHL-1.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a DHL session ID from the switch configuration.

• Use the optional name parameter to specify a name for the DHL session.

• Only one DHL session can be configured on a switch.

• Once the DHL session ID is created, assign a link A port and a link B port to the session. This is
required before administratively enabling the DHL session is allowed.

Examples
-> dhl 1 name dhl_session1
-> no dhl 1

Release History
Release 8.2.1; command was introduced.

page 10-52 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands dhl name

Related Commands

dhl num linka linkb Associates a pair of links (port or linkagg) with the DHL session.
dhl num admin-state Configures the administrative status of the DHL session.
show dhl num Displays information about a specific DHL session.

MIB Objects
alaDHLSessionTable
alaDHLSessionIndex
alaDHLSessionDescr

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-53
dhl num linka linkb Link Aggregation Commands

dhl num linka linkb

Configures two ports or two link aggregates or a combination of both as linkA and linkB for the specified
DHL session. Only two links are allowed per DHL session; only one DHL session per switch is allowed.
dhl dhl_num linka {port chassis/slot/port | linkagg agg_id} linkb {port chassis/slot/port | linkagg
agg_id}
no dhl dhl_num linka {port chassis/slot/port | linkagg agg_id} linkb {port chassis/slot/port | linkagg
agg_id}

Syntax Definitions

dhl_num An existing DHL session ID number.

chassis_id The chassis ID number.
slot The slot number to designate as a link for the DHL session.
port The physical port number to designate as a link for the DHL session.
agg_id The link aggregate ID number to designate as a link for the DHL
session.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the linkA and linkB ports from the specified session ID.
Before attempting to remove the links, administratively disable the DHL session.
• Make sure that DHL linkA and linkB are associated with each of the VLAN that the DHL session will
protect. Any VLAN not associated with both the links or only associated with one of the links is
unprotected.
• DHL linkA and linkB should belong to the same default VLAN. In addition, select a default VLAN
that is one of the VLANs that the DHL session will protect. For example, if the session is going to
protect VLANs 10-20, then assign one of those VLANs as the default VLAN for linkA and linkB.
• Only one DHL session per switch is allowed. Each session can have only two links (linkA and linkB).
Specify a physical switch port or a link aggregate (linkagg) ID as a DHL link. The same port or link
aggregate is not configurable as both linkA or linkB.
• DHL is not supported on mobile, 802.1x-enabled, GVRP, or UNI ports. DHL is also not supported on a
port that is a member of a link aggregate or a port the is enabled for transparent bridging.
• The administrative state of a DHL session is not configurable until a linkA port and a linkB port are
associated with the specified DHL session ID number.
• Changing the port designations for linkA and linkB is not recommended while the DHL session is
enabled.

page 10-54 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands dhl num linka linkb

• Removing a link aggregate from the switch configuration is not allowed if the aggregate is configured
as a link for a DHL session.

Examples
-> dhl 1 linka port 1/1 linkb port 1/2
-> dhl 1 linka linkagg 1 linkb port 1/2
-> dhl 1 linka port 1/1 linkb linkagg 1
-> dhl 1 linka linkagg 1 linkb linkagg 2
-> no dhl 1 linka port 1/1 linkb port 1/2

Release History
Release 8.2.1; command was introduced.

Related Commands

dhl name Configures a session ID for the DHL session.

dhl num admin-state Configures the administrative status for the DHL session.
show dhl Displays the global status of the DHL configuration.
show dhl num Displays information about a specific DHL session.
show dhl num link Displays information about a specific link.

MIB Objects
AlaDHLLinksTable
alaDHLLinksSessionIndex
alaDHLLinkslinkA
alaDHLLinkslinkB

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-55
dhl num admin-state Link Aggregation Commands

dhl num admin-state

Enables or disables the administrative state of a DHL session.
dhl dhl_num admin-state {enable | disable}

Syntax Definitions

dhl_num An existing DHL session ID number.

enable Enables the DHL session.
disable Disables the DHL session.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The DHL session ID specified with this command must already exist in the switch configuration.

• The administrative state cannot be enabled until a linkA port and a linkB port are associated with the
specified DHL session ID number.

Examples
-> dhl 1 admin-state enable
-> dhl 1 admin-state disable

Release History
Release 8.2.1; command was introduced.

Related Commands

dhl name Configures a session ID for the DHL session.

dhl num admin-state Configures the administrative status for the DHL session.
show dhl Displays the global status of the DHL configuration.
show dhl num Displays information about a specific DHL session.

MIB Objects
alaDHLSessionTable
alaDHLSessionAdminStatus

page 10-56 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands dhl num vlan-map linkb

dhl num vlan-map linkb

Configures a VLAN-MAP (a single VLAN or a range of VLANs) from a common pool of VLANs to
operate on DHL link B.
dhl dhl_num vlan-map linkb {vlan_id[-vlan_id]}
no dhl dhl_num vlan-map linkb {vlan_id[-vlan_id]}

Syntax Definitions

dhl_num A DHL session ID number.

vlan_id[-vlan_id] A VLAN ID number or a range of VLAN IDs to map to linkB. The valid
range is 1–4094.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• A DHL session has to be created before a VLAN-MAP can be configured.

• When the DHL session is active, the common VLAN that both the dual homed links belong to is
treated as a protected VLAN. The VLAN containing only one dual homed link is treated as an
unprotected VLAN. Traffic is forwarded only on the dual homed links belonging to the protected
VLAN.
• If a VLAN is removed globally and if the VLAN belongs to a particular dual homed link, then the
VLAN will automatically be removed from the dual homed link.
• If one dual homed link, for example linkA, is moved out of a protected VLAN, then the VLAN
becomes unprotected and the VPA is removed from the second dual homed link, for example linkB.
• If the admin state of a VLAN is changed to disabled, and if the VLAN is part of a protected VLAN,
then the disabled VLAN is removed from the operational DHL VLAN list but will be present in the
protected VLAN list.
• If the admin state of a dual homed link, for example linkA, is changed to disabled, then the protected
VLANs of the disabled linkA are moved to the other link, for example linkB. When linkA is re-
enabled, then the VLANs are moved back to linkA.
• If the VLAN-MAP of linkB is removed, then the VPAs for the linkB will also be removed and the
VLANs configured on linkB are moved to linkA.
• If a VLAN is configured as default on one dual homed link, for example linkA, then the same VLAN
cannot be configured as tagged on the other link, for example linkB.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-57
dhl num vlan-map linkb Link Aggregation Commands

Examples
-> vlan 10-30
-> vlan 10-20 802.1q 1/1
-> vlan 4
-> vlan port default 1/1-2
-> dhl 1 name dhl_session1
-> dhl 1 linka port 1/1 linkb port 1/2
-> dhl 1 vlan-map linkb 18-20
-> no dhl 1 vlan-map linkb 18-20

Release History
Release 8.2.1; command was introduced.

Related Commands

dhl name Configures a session ID for the DHL session.

dhl num admin-state Configures the administrative status for the DHL session.
show dhl Displays the global status of the DHL configuration.
show dhl num Displays information about a specific DHL session.
show dhl num link Displays information about a specific link.

MIB Objects
alaDHLVlanMapTable
alaDHLVlanMapSessionIndex
alaDHLVlanMapVlanStart
alaDHLVlanMapVlanEnd
alaDHLVlanMapRowStatus

page 10-58 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands dhl num pre-emption-time

dhl num pre-emption-time

Configures the pre-emption timer for the DHL session. A pre-emption timer is a recovery-delay timer that
is used to delay the switchover of VLANs to their primary links. It is the delay in the resumption of traffic
when a link that is down is brought up.
dhl dhl_num pre-emption-time seconds

Syntax Definitions

dhl_num A DHL session ID number.

seconds The number of seconds for the delay in the switchover of VLANs to
their primary links. The valid range is 0–600.

Defaults

parameter default
seconds 30 seconds

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Pre-emption timer is applicable only when a failed port is brought up. If both ports are down, the pre-
emption timer is activated only when the second port is brought up.
• If the pre-emption timer value is set to 0, then there will be no delay in the VLANs being moved back
to their primary link.
• If a link fails when the pre-emption timer is active, that is when the remaining pre-emption time value
is not equal to 0, then the timer will be halted.
• When the pre-emption timer is active for a particular link and if the other link goes down, then the
VLANs of the link that is down are automatically moved to the port for which the pre-emption timer is
active.
• When DHL ports spanned across the NIs or DHC ports are on the same NI but data port is on different
NI, it is advised to configure mac-flush mechanism (either Raw/MVRP) for faster convergence.

Examples
-> dhl 1 pre-emption-time 40sec

Release History
Release 8.2.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-59
dhl num pre-emption-time Link Aggregation Commands

Related Commands

dhl name Configures a session ID for the DHL session.

show dhl Displays the global status of the DHL configuration.
show dhl num Displays information about a specific DHL session.
show dhl num link Displays information about a specific link.

MIB Objects
alaDHLSessionTable
alaDHLSessionPreemptionTime

page 10-60 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands dhl num mac-flushing

dhl num mac-flushing

Configures the MAC-flushing technique for the DHL session. The MAC-flushing technique is used to
correct any stale MAC entries that are caused when a dual homed link goes down.
dhl dhl_num mac-flushing {none | raw | mvrp}

Syntax Definitions

dhl_num A DHL session ID number.

none Flushing of the MAC address tables does not occur.
raw Method of flushing when VPAs of the links moved across them due to
link up/down or configuration change (VLAN-map). The switch
determines the MAC addresses within the affected VLANs
mvrp Method of flushing when one link fails and the other link issues 'join'
declarations to establish connectivity. These new joins are flagged as
'new' and they are forwarded by the core devices causing flushing on the
core network for the active VLANs.

Defaults

parameter default
none | raw | mvrp none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Before enabling MVRP on dual homed links, the Registrar Mode should be set to 'forbidden', failing
which an error message is displayed when configuring DHL. If the Registrar Mode is set to 'not
forbidden, then changes cannot be made to the MVRP configuration on the dual homed links.
• If the MAC-flushing technique is set to MVRP and if MVRP is not enabled on the dual homed links,
then the show dhl command displays the active MAC-flushing technique as none. When MVRP is
enabled on the dual homed links, then the MAC-flushing technique changes to MVRP and the
Registrar Mode of the links is automatically set to ‘forbidden’.
• If VLANs are moved across the dual homed links as a result of configuration changes, then MAC-
flushing is automatically enabled, if configured, excepting dual homed links that are changed on the
fly.

Examples
-> dhl 1 mac-flushing none
-> dhl 1 mac-flushing raw

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-61
dhl num mac-flushing Link Aggregation Commands

Release History
Release 8.2.1; command was introduced.

Related Commands

dhl name Configures a session ID for the DHL session.

show dhl Displays the global status of the DHL configuration.
show dhl num Displays information about a specific DHL session.
show dhl num link Displays information about a specific link.

MIB Objects
alaDHLSessionTable
alaDHLSessionMacFlushingtech

page 10-62 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands show dhl

show dhl
Displays the global status of the DHL configuration.
show dhl

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines

N/A

Examples
-> show DHL
Number Name Admin Oper Pre-emption Mac-flushing Active Mac-flushing
state state time
-------+------+--------+-------+-----------+------------------+--------------------
1 DHL-1 UP UP 30sec Raw Raw

output definitions
Number Number of the DHL session.
Name The user-defined text description of the DHL session.
Admin state The administrative status of the DHL session.
Oper state The operational status of the DHL session.
Pre-emption time The pre-emption time in seconds of the DHL session.
Mac-flushing Mac-flushing technique on the DHL session.
Active Mac-flushing Mac-flushing technique that is currently active on the DHL session.

Release History
Release 8.2.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-63
show dhl Link Aggregation Commands

Related Commands

dhl name Configures a session ID for the DHL session.

show dhl num Displays information about a specific DHL session.
show dhl num link Displays information about a specific link.

MIB Objects
alaDHLSessionTable
alaDHLSessionIndex
alaDHLSessionDesc
alaDHLSessionAdminStatus
alaDHLSessionOperStatus
alaDHLSessionPreemptionTime
alaDHLSessionMacFlushingtech

page 10-64 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands show dhl num

show dhl num

Displays information about a specific DHL session.
show dhl dhl_num

Syntax Definitions

dhl_num A DHL session ID number.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show dhl 1
DHL session name : Arice,
Admin state : Up,
Operational state : Up,
Pre-emption time : 40 sec,
Mac-flushing : Raw-Flushing,
Active Mac-flushing : Raw-Flushing,

Protected VLANs : 10-20,23,25,30-100,600,700,800,

linkA:
Port : 1/2,
Operational state : Up

Un protected VLANs : 900,1980,1987,234,

Active VLAN : 10-20,23,25,30-100,600,700,800,

linkB:
Port : 1/1,
Operational state : Down,
Un protected VLANs : 1730-1800,
Vlan-map : 30-100,600,
Active Vlans : none,

output definitions
DHL session Name The user-defined text description of the DHL session.
Admin state The current administrative status of the DHL session.
Operational state The operational state of the DHL session.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-65
show dhl num Link Aggregation Commands

output definitions
Pre-emption time The delay-interval in seconds to move the VLANs back to their original
links.
Mac-flushing Mac-flushing technique on the DHL session.
Active Mac-flushing The active Mac-flushing technique that is enabled on the specified
DHL session.
Protected VLANs The common VLANs that contain both the dual homed links, for
example linkA and linkB.
LinkA A dual homed link that is part of a pair of DHL links that can be
configured per switch.
Port The port number of linkA.
Operational state The operational state of the port. The operational states are UP or
DOWN.
Un protected VLANs The VLANs containing only one dual homed link.
Active VLANs The VLANs that are in an active state.
LinkB A dual homed link that is part of a pair of DHL links that can be
configured per switch.
Port The port number of linkB.
Operational state The operational state of the port. The operational states are UP or
DOWN.
Un protected VLANs The VLANs containing only one dual homed link.
VLAN-map The DHL VLAN map for linkB. This specifies the VLANs that are
operational on DHL linkB from the common pool of VLANs between
DHL linkA and linkB.
Operational VLANs The VLANs that are in an operational state.

Release History
Release 8.2.1; command was introduced.

Related Commands

dhl name Configures a session ID for the DHL session.

show dhl num link Displays information about a specific link.

page 10-66 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands show dhl num

MIB Objects
alaDHLSessionTable
alaDHLSessionIndex
alaDHLSessionDescr
alaDHLSessionAdminStatus
alaDHLSessionOperStatus
alaDHLSessionPreemptionTime
alaDHLSessionMacFlushingtech
alaDHLLinksTable
alaDHLLinksSessionIndex
alaDHLLinkslinkA
alaDHLLinkslinkAOperStatus
alaDHLLinkslinkB
alaDHLLinkslinkBOperStatus
alaDHLVlanMapTable
alaDHLVlanMapSessionIndex
alaDHLVlanMapVlanStart
alaDHLVlanMapVlanEnd
alaDHLVpaTable
alaDHLVpalink
alaDHLVpaVlan
alaDHLVpaVlanType
alaDHLVpaOperationalLink

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-67
show dhl num link Link Aggregation Commands

show dhl num link

Displays information about a specific DHL link, for example linkA or linkB and the VLAN details of the
specified link.
show dhl dhl_num [linkA | linkB]

Syntax Definitions

dhl_num A DHL session ID number.

linkA The dual homed link that is part of a pair of DHL links that can be
configured per switch.
linkB The dual homed link that is part of a pair of DHL links that can be
configured per switch.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show dhl 1 linkA

linkA:
Port : 1/2,
Operational state : Up,

Protected VLANs : 10-20, 23, 25, 30-100,600,700,800,

Un protected VLANs : 900, 1980, 1987,234,
Active VLAN : 10-20, 23, 25, 30-100,600,700,800,

Release History
Release 8.2.1; command was introduced.

page 10-68 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands show dhl num link

Related Commands

dhl name Configures a session ID for the DHL session.

dhl num linka linkb Configures a port or a link aggregate as dual homed links (linkA, linkB)
of a DHL session.
dhl num vlan-map linkb Configures a VLAN or a range of VLANs from a common pool to
operate on DHL linkB.
show dhl num Displays information about a specific DHL session.

MIB Objects
alaDHLLinksTable
alaDHLLinksSessionIndex
alaDHLLinkslinkA
alaDHLLinkslinkAOperStatus
alaDHLLinkslinkB
alaDHLVpaTable
alaDHLVpalink
alaDHLVpaVlan
alaDHLVpaVlanType
alaDHLVpaOperationalLink
alaDHLVlanMapTable
alaDHLVlanMapSessionIndex
alaDHLVlanMapVlanStartala
alaDHLVlanMapVlanEnd

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-69
linkagg range Link Aggregation Commands

linkagg range
Modifies the range of standard and MC-LAG link aggregation identifiers.

Note: This command is not supported in this release.

linkagg range local {agg_id-agg_id | none} peer {agg_id-agg_id | none} multi-chassis {agg_id-agg_id
| none}

Syntax Definitions

agg_id The first or last identifier in the range.

local The range of standard local aggregate identifiers.
peer The range of standard peer aggregate identifiers.
multi-chassis The range of MC-LAG aggregate identifiers.
none No aggregate identifiers range is specified.

Defaults

parameter default
local 0-47
peer 48-95
multi-chassis 96-127

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use this command in conjunction with the MC-LAG feature to change the maximum number of MC-
LAG link aggregates that can be configured.
• The switch must be rebooted for the ranges to take affect.

• The maximum number of combined standard and MC-LAG link aggregates is 128.

Examples
-> linkagg range local 0-9 peer 10-19 multi-chassis 20-127
-> linkagg range local none peer none multi-chassis 0-127

Release History
Release 8.1.1; command introduced.

page 10-70 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands linkagg range

Related Commands

show linkagg range Displays the link aggregate ranges.

MIB Objects
alclnkaggAggConfig
alclnkAggLocalRangeOperMin
alclnkAggLocalRangeOperMax
alclnkAggLocalRangeConfiguredMin
alclnkAggLocalRangeConfiguredMax
alclnkAggPeerRangeOperMin
alclnkAggPeerRangeOperMax
alclnkAggPeerRangeConfiguredMin
alclnkAggPeerRangeConfiguredMax
alclnkAggMcLagRangeOperMin
alclnkAggMcLagRangeOperMax
alclnkAggMcLagRangeConfiguredMin
alclnkAggMcLagRangeConfiguredMax

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-71
show linkagg Link Aggregation Commands

show linkagg
Displays information about static and dynamic (LACP) aggregate groups.
show linkagg [agg [agg_id[-agg_id2]]

Syntax Definitions

agg_id Specifies the aggregate group ID. Configured through the linkagg static
agg size or linkagg lacp agg size command.
-agg_id2 The last link aggregate ID in a range of link aggregate IDs.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If no aggregation number is specified, information for all aggregate groups is displayed. If an
aggregate number is specified, only the information about the relevant aggregate group is displayed.
The fields included in the display depend on whether the aggregate group is a static or dynamic.
• Use the show linkagg port command to display information about aggregate group ports.

Examples
No aggregate group is specified:
-> show linkagg

Number Aggregate SNMP Id Size Admin State Oper State Att/Sel Ports
-------+----------+--------+----+-------------+-------------+--------+-----
1 Static 40000001 8 ENABLED UP 2 2
2 Dynamic 40000002 4 ENABLED DOWN 0 0
3 Dynamic 40000003 8 ENABLED DOWN 0 2
4 Dynamic 40000004 8 ENABLED UP 3 3
5 Static 40000005 2 DISABLED DOWN 0 0

output definitions
Number The aggregate group number.
Aggregate The type of aggregate group, which can be Static or Dynamic.
SNMP Id The SNMP ID associated with the aggregate group.
Size The number of links in this aggregate group.

page 10-72 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands show linkagg

output definitions (continued)

Admin State The current administrative state of the aggregate group, which can be
ENABLED or DISABLED. You can modify this parameter with the
linkagg static agg admin-state command (see page 10-8) for static
aggregate groups and with the linkagg lacp agg admin-state command
(see page 10-16) for dynamic aggregate groups.
Oper State The current operational state of the aggregate group, which can be UP
or DOWN.
Att Ports The number of ports actually attached to this aggregate group.
Sel Ports The number of ports that could possibly attach to the aggregate group.

A static aggregate is specified:

-> show linkagg agg 5
Static Aggregate
SNMP Id : 40000005,
Aggregate Number : 5,
SNMP Descriptor : Omnichannel Aggregate Number 5 ref 40000005 size 2,
Name : AGG5,
Admin State : ENABLED,
Operational State : DOWN,
Aggregate Size : 2,
Number of Selected Ports : 0,
Number of Reserved Ports : 0,
Number of Attached Ports : 0,
Primary Port : NONE
Port Selection Hash : Tunnel-Protocol,
Wait To Restore Time : 0 Minutes

output definitions
SNMP Id The SNMP ID associated with this static aggregate group.
Aggregate Number The group number.
SNMP Descriptor The standard MIB name for this static aggregate group.
Name The name of this static aggregate group. You can modify this parameter
with the linkagg static agg name command (see page 10-6).
Admin State The administrative state of this static aggregate group, which can be
ENABLED or DISABLED. You can modify this parameter with the
linkagg static agg admin-state command (see page 10-8).
Operational State The operational state of this static aggregate group, which can be UP or
DOWN.
Aggregate Size The number of links configured for this static aggregate group.
Number of Selected Ports The number of ports that could possibly attach to this static aggregate
group.
Number of Reserved Ports The total number of ports reserved for use in link aggregation by this
static aggregate group. (Note: This field is not relevant for static
aggregate groups.)
Number of Attached Ports The number of ports actually attached to this static aggregate group.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-73
show linkagg Link Aggregation Commands

output definitions (continued)

Primary Port The port number of the first port to join this static aggregate group. If
the first port to join the aggregate is no longer part of the aggregate
group, the switch automatically assigns another port in the aggregate
group to be the primary port.
Port Selection Hash The hashing option selected for a link aggregate port.
Wait To Restore Time The wait-to-restore timer value, in minutes, for the aggregate.

A dynamic aggregate group is specified:

-> show linkagg agg 1-2

Dynamic Aggregate
SNMP Id : 40000002,
Aggregate Number : 2,
SNMP Descriptor : Dynamic Aggregate Number 2 ref 40000002 size 4,
Name : AGG 2,
Admin State : ENABLED,
Operational State : DOWN,
Aggregate Size : 4,
Number of Selected Ports : 0,
Number of Reserved Ports : 0,
Number of Attached Ports : 0,
Primary Port : NONE,
Port Selection Hash : Source Destination Ip,
Wait To Restore Time : 0 Minutes
LACP
MACAddress : [00:1f:cc:00:00:00],
Actor System Id : [00:20:da:81:d5:b0],
Actor System Priority : 50,
Actor Admin Key : 120,
Actor Oper Key : 0,
Partner System Id : [00:20:da:81:d5:b1],
Partner System Priority : 70,
Partner Admin Key : 220,
Partner Oper Key : 0

output definitions
SNMP Id The SNMP ID associated with this dynamic aggregate group.
Aggregate Number The group number of this dynamic aggregate group.
SNMP Descriptor The standard MIB name for this dynamic aggregate group.
Name The name of this dynamic aggregate group. You can modify this
parameter with the linkagg lacp agg name command (see page 10-14).
Admin State The administrative state of this dynamic aggregate group, which can be
ENABLED or DISABLED. You can modify this parameter with the
linkagg lacp agg admin-state command (see page 10-16).
Operational State The operational state of this dynamic aggregate group, which can be
UP or DOWN.
Aggregate Size The number of links configured for this dynamic aggregate group.
Number of Selected Ports The number of ports available to this dynamic aggregate group.

page 10-74 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands show linkagg

output definitions (continued)

Number of Reserved Ports The total number of ports reserved for use in link aggregation by this
dynamic aggregate group.
Number of Attached Ports The number of ports actually attached to this dynamic aggregate group.
Primary Port The port number of the first port to join this dynamic aggregate group.
If the first port to join the aggregate group is no longer part of the
aggregate group, the switch automatically assigns another port in the
aggregate group to be the primary port.
Port Selection Hash The hashing option selected for a link aggregate port.
Wait To Restore Time The wait-to-restore timer value, in minutes, for the aggregate.
MACAddress The MAC address associated with the primary port.
Actor System Id The MAC address of this dynamic aggregate group. You can modify
this parameter with the linkagg lacp agg actor system-id command
(see page 10-21).
Actor System Priority The priority of this dynamic aggregate group. You can modify this
parameter with the linkagg lacp agg actor system-priority command
(see page 10-19).
Actor Admin Key The administrative key associated with this dynamic aggregate group.
You can modify this parameter with the linkagg lacp agg actor admin-
key command (see page 10-18).
Actor Oper Key The operational key associated with this dynamic aggregate group.
Partner System Id The MAC address of the remote dynamic aggregate group. You can
modify this parameter with the linkagg lacp agg partner system-id
command (see page 10-23).
Partner System Priority The priority of the remote system to which this dynamic aggregation
group is attached. You can modify this parameter with the linkagg lacp
agg partner system-priority command (see page 10-25).
Partner Admin Key The administrative key for the remote partner of the dynamic
aggregation. You can modify this parameter with the linkagg lacp agg
partner admin-key command (see page 10-27).
Partner Oper Key The operational key of the remote system to which the dynamic
aggregation group is attached.

Release History
Release 8.1.1; command introduced.

Related Commands

linkagg static agg size Creates a static aggregate group.

linkagg lacp agg size Creates a dynamic aggregate group.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-75
show linkagg Link Aggregation Commands

MIB Objects
alclnkaggAggTable
alclnkAggSize
alclnkaggAggNumber
alclnkaggAggDescr
alclnkaggAggName
alclnkaggAggLacpType
alclnkaggAggAdminState
alclnkaggAggOperState
alclnkaggAggNbrSelectedPorts
alclnkaggAggNbrAttachedPorts
alclnkaggPrimaryPortIndex
alclnkaggAggPortSelectionHash
alclnkaggAggWTRTimer
alclnkaggAggMACAddress
alclnkaggAggActorSystemPriority
alclnkaggAggActorSystemID
alclnkaggAggPartnerAdminKey
alclnkaggAggActorAdminKey
alclnkaggAggActorOperKey
alclnkAggLocalRangeOperMin
alclnkAggLocalRangeOperMax
alclnkAggLocalRangeConfiguredMin
alclnkAggLocalRangeConfiguredMax
alclnkAggPeerRangeOperMin
alclnkAggPeerRangeOperMax
alclnkaggAggPartnerSystemID
alclnkaggAggPartnerSystemPriority
alclnkaggAggPartnerOperKey

page 10-76 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands show linkagg port

show linkagg port

Displays information about link aggregation ports.
show linkagg {agg agg_id[-agg_id2]} port [chassis_id/slot/port]

Syntax Definitions

agg_id The ID number corresponding to the link aggregate group.

-agg_id2 The last link aggregate ID in a range of link aggregate IDs.
chassis_id The chassis ID number.
slot The slot number for this aggregate.
port The port number for this aggregate.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If no slot/port is specified, the information for all slots/ports is displayed.

• If a particular slot or port is specified, the fields displayed depend upon whether the port belongs to a
static aggregate group or a dynamic (LACP) aggregate group.
• If only a link aggregate or a range of link aggregates are specified along with the agg keyword, the port
and related information for only the specified link aggregate IDs are displayed.

Examples
-> show linkagg port

Slot/Port Aggregate SNMP Id Status Agg Oper Link Prim

---------+----------+--------+----------+----+----+----+----+----
2/1 Static 2001 ATTACHED 1 UP UP YES

-> show linkagg agg 1-5 port

Slot/Port Aggregate SNMP Id Status Agg Oper Link Prim
---------+-----------+--------+--------------+------+----+----+----+-----
1/16 Static 2016 CONFIGURED 1 UP UP YES
1/17 Static 2017 CONFIGURED 2 UP UP NO
3/1 Static 3001 CONFIGURED 3 UP UP NO
3/2 Static 3045 CONFIGURED 4 UP UP NO
3/3 Static 3069 CONFIGURED 5 UP UP NO

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-77
show linkagg port Link Aggregation Commands

output definitions
Slot/Port The slot/port associated with the aggregate group.
Aggregate The type of aggregate group associated with the port, either Static or
Dynamic.
SNMP Id The SNMP ID associated with the aggregate group.
Status The current status of the port, which can be CONFIGURED,
PENDING, SELECTED, or RESERVED.
Agg The number of the aggregate groups associated with this port.
Oper The operational status of the port.
Link The physical link status of the port.
Prim Specifies if the port is the primary port of the aggregate. The primary
port is the lowest numbered port in a link aggregate.

A port that belongs to a static aggregate is specified:

-> show linkagg port 4/1

Static Aggregable Port

SNMP Id : 4001,
Slot/Port : 4/1,
Administrative State : ENABLED,
Operational State : DOWN,
Port State : CONFIGURED,
Link State : DOWN,
Selected Agg Number : 2,
Port position in the aggregate: 0,
Primary port : NONE

output definitions
SNMP Id The SNMP ID associated with this port.
Slot/Port The slot and port number.
Administrative State The current administrative state of this port, which can be ENABLED
or DISABLED.
Operational State The current operational state of the port, which can be UP or DOWN.
Port State The current operational state of the port, which can be
CONFIGURED, PENDING, SELECTED, or RESERVED.
Link State The current operational state of the link from this port to its remote
partner, which can be UP or DOWN.
Selected Agg Number The number associated with the static aggregate group to which the
port is attached.
Port position in the aggregate The rank of this port within the static aggregate group.
Primary Port The port number of the first port to join this static aggregate group. If
the first port to join the aggregate is no longer part of the aggregate
group, the switch automatically assigns another port in the aggregate
group to be the primary port.

page 10-78 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands show linkagg port

A port that belongs to a static link aggregate is specified:

-> show linkagg agg 1

Static Aggregate
SNMP Id : 40000001,
Aggregate Number : 1,
SNMP Descriptor : Omnichannel Aggregate Number 1 ref 40000001 size 4,
Name : ,
Admin State : ENABLED,
Operational State : DOWN,
Aggregate Size : 4,
Number of Selected Ports : 0,
Number of Reserved Ports : 0,
Number of Attached Ports : 0,
Primary Port : NONE

A port that belongs to a dynamic aggregate is specified:

-> show linkagg port 2/1

Dynamic Aggregable Port

SNMP Id : 2001,
Slot/Port : 2/1,
Administrative State : ENABLED,
Operational State : DOWN,
Port State : CONFIGURED,
Link State : DOWN,
Selected Agg Number : NONE,
Primary port : UNKNOWN,
LACP
Actor System Priority : 10,
Actor System Id : [00:d0:95:6a:78:3a],
Actor Admin Key : 8,
Actor Oper Key : 8,
Partner Admin System Priority : 20,
Partner Oper System Priority : 20,
Partner Admin System Id : [00:00:00:00:00:00],
Partner Oper System Id : [00:00:00:00:00:00],
Partner Admin Key : 8,
Partner Oper Key : 0,
Attached Agg Id : 0,
Actor Port : 7,
Actor Port Priority : 15,
Partner Admin Port : 0,
Partner Oper Port : 0,
Partner Admin Port Priority : 0,
Partner Oper Port Priority : 0,
Actor Admin State : act1.tim1.agg1.syn0.col0.dis0.def1.exp0
Actor Oper State : act1.tim1.agg1.syn0.col0.dis0.def1.exp0,
Partner Admin State : act0.tim0.agg1.syn1.col1.dis1.def1.exp0,
Partner Oper State : act0.tim0.agg1.syn0.col1.dis1.def1.exp0

output definitions
SNMP Id The SNMP ID associated with this port.
Slot/Port The slot and port number.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-79
show linkagg port Link Aggregation Commands

output definitions (continued)

Administrative State The current administrative state of this port, which can be ENABLED
or DISABLED.
Operational State The current operational state of the port, which can be UP or DOWN.
Port State The current operational state of the port, which can be
CONFIGURED, PENDING, SELECTED, or AGGREGATED.
Link State The current operational state of the link from this port to its remote
partner, which can be UP or DOWN.
Selected Agg Number The number associated with the dynamic aggregate group to which the
port is attached.
Primary Port The port number of the first port to join this dynamic aggregate group.
If the first port to join the aggregate is no longer part of the aggregate
group, the switch automatically assigns another port in the aggregate
group to be the primary port.
Actor System Priority The actor system priority of this port. You can modify this parameter
with the linkagg lacp port actor system-priority command (see page
10-36).
Actor System Id The actor system ID (i.e., MAC address) of this port. You can modify
this parameter with the linkagg lacp port actor system-id command
(see page 10-34).
Actor Admin Key The actor administrative key value for this port. You can modify this
parameter with the linkagg lacp port actor admin-key command (see
page 10-29).
Actor Oper Key The actor operational key associated with this port.
Partner Admin System The administrative priority of the remote system to which this port is
Priority attached. You can modify this parameter with the linkagg lacp port
partner admin system-priority command (see page 10-44).
Partner Oper System Priority The operational priority of the remote system to which this port is
attached.
Partner Admin System Id The administrative MAC address associated with the system ID of a
remote partner. This value is used along with Partner Admin System
Priority, Partner Admin Key, and Partner Admin Port Priority to
manually configure aggregation. You can modify this parameter with
the linkagg lacp port partner admin system-id command (see page
10-40).
Partner Oper System Id The MAC address that corresponds to the system ID of the remote
partner.
Partner Admin Key The administrative value of the key for the remote partner. This value is
used along with Partner Admin System Priority, Partner Admin System,
Partner Admin Port, and Partner Admin Port Priority to manually
configure aggregation. You can modify this parameter with the linkagg
lacp port partner admin-key command (see page 10-42).
Partner Oper Key The current operational value of the key for the protocol partner.
Attached Agg ID The ID of the aggregate group that the port has attached itself to. A
value of zero indicates that the port is not attached to an aggregate
group.
Actor Port The port number locally assigned to this port.

page 10-80 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands show linkagg port

output definitions (continued)

Actor Port Priority The actor priority value assigned to the port. You can modify this
parameter with the linkagg lacp port actor port priority command
(see page 10-46).
Partner Admin Port The administrative value of the port number for the protocol partner.
This value is used along with Partner Admin System Priority, Partner
Admin System ID, Partner Admin Key, and Partner Admin Port
Priority to manually configure aggregation. You can modify this
parameter with the linkagg lacp port partner admin-port command
(see page 10-48).
Partner Oper Port The operational port number assigned to the port by the protocol
partner of the port.
Partner Admin Port Priority The administrative port priority of the protocol partner. This value is
used along with Partner Admin System Priority, Partner Admin System
ID, and Partner Admin Key to manually configure aggregation. You
can modify this parameter with the linkagg lacp port partner admin
port-priority command (see page 10-50).
Partner Oper Port Priority The priority value assigned to the this port by the partner.
Actor Admin State The administrative state of the port. You can modify this parameter
with the linkagg lacp port actor admin-state command (see page
10-32).
Actor Oper State The current operational state of the port.
Partner Admin State The administrative state of the partner port. You can modify this
parameter with the linkagg lacp agg partner admin-state command
(see page 10-38).
Partner Oper State The current operational state of the partner port.

Release History
Release 8.1.1; command introduced.

Related Commands

linkagg static port agg Configures a slot and port for a static aggregate group.
linkagg lacp port actor admin- Configures a slot and port for a dynamic aggregate group.
key
show linkagg Displays information about static and dynamic (LACP) aggregate
groups.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-81
show linkagg port Link Aggregation Commands

MIB Objects
alclnkaggAggPortTable
alclnkaggAggPortActorSystem
alclnkaggAggPortActorSystemPriority
alclnkaggAggPortActorSystemID
alclnkaggAggPortActorAdminKey
alclnkaggAggPortActorOperKey
alclnkaggAggPortPartnerAdminSystemPriority
alclnkaggAggPortPartnerOperSystemPriority
alclnkaggAggPortPartnerAdminSystemID
alclnkaggAggPortPartnerOperSystemID
alclnkaggAggPortPartnerAdminKey
alclnkaggAggPortPartnerOperKey
alclnkaggAggPortSelectedAggID
alclnkaggAggPortAttachedAggID
alclnkaggAggPortActorPort
alclnkaggAggPortActorPortPriority
alclnkaggAggPortPartnerAdminPort
alclnkaggAggPortPartnerOperPort
alclnkaggAggPortPartnerAdminPortPriority
alclnkaggAggPortPartnerOperPortPriority
alclnkaggAggPortActorAdminState
alclnkaggAggPortActorOperState
alclnkaggAggPortPartnerAdminState
alclnkaggAggPortPartnerOperState

page 10-82 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Link Aggregation Commands show linkagg range

show linkagg range

Displays information about the configured or operational link aggregate range identifiers for standard and
MC-LAG link aggregates.

Note: This command is not supported in this release.

show linkagg range [operation | config]

Syntax Definitions

operation Displays the operational ranges.

config Displays the configured ranges.

Defaults
By default, both the operational and configured ranges are shown.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the operation parameter to display only the operational link aggregate identifiers.

• Use the config parameter to display only the configured link aggregate identifiers.

• A chassis reboot is required for the configured values to become operational.

Examples
-> show linkagg range
Operational Configured
Min Max Min Max
--------------------+--------+--------+-------------+-------+
Local 0 127 0 0
Peer 0 127 0 0
Multi-Chassis 0 127 0 127

output definitions
Operational Min/Max The currently operational ranges.
Configured Min/Max The currently configured ranges.
Local The local link aggregate identifiers.
Peer The peer link aggregate identifiers.
Multi-Chassis The MC-LAG link aggregate identifiers.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 10-83
show linkagg range Link Aggregation Commands

Related Commands

linkagg range Configures the standard and MC-LAG aggregate identifier ranges.

MIB Objects
alclnkaggAggConfig
alclnkAggLocalRangeOperMin
alclnkAggLocalRangeOperMax
alclnkAggLocalRangeConfiguredMin
alclnkAggLocalRangeConfiguredMax
alclnkAggPeerRangeOperMin
alclnkAggPeerRangeOperMax
alclnkAggPeerRangeConfiguredMin
alclnkAggPeerRangeConfiguredMax
alclnkAggMcLagRangeOperMin
alclnkAggMcLagRangeOperMax
alclnkAggMcLagRangeConfiguredMin
alclnkAggMcLagRangeConfiguredMax

page 10-84 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 11 Virtual Chassis
Commands

A Virtual Chassis is a group of switches managed through a single management IP address and that
behave as a single bridge or router. It provides both node level and link level redundancy for devices
connecting to the aggregation layer via dual-homed standard 802.3ad link aggregation mechanisms. The
use of Virtual Chassis provides node level redundancy without the need to use redundancy protocols such
as STP and VRRP between the edge and the aggregation/core layer.
MIB information for the Virtual Chassis commands is as follows:
Filename: ALCATEL-IND1-VIRTUAL-CHASSIS-MIB.mib
Filename:ALCATEL-IND1-VC-SPLIT-PROTECTION-MIB.mib
A summary of available commands is listed here:

virtual-chassis configured-chassis-id
virtual-chassis chassis-group
virtual-chassis configured-chassis-priority
virtual-chassis configured-control-vlan
virtual-chassis hello-interval
virtual-chassis vf-link-mode
virtual-chassis auto-vf-link-port
virtual-chassis vf-link-mode
vc-takeover

show virtual-chassis topology

show virtual-chassis consistency
show virtual-chassis vf-link
show virtual-chassis auto-vf-link-port
show virtual-chassis auto-vf-link-port
show virtual-chassis slot-reset-list
show virtual-chassis consistency
show virtual-chassis neighbors
show configuration vcm-snapshot chassis-id

virtual-chassis split-protection admin-state

virtual-chassis split-protection linkagg
virtual-chassis split-protection guard-timer
virtual-chassis split-protection helper admin-state
virtual-chassis split-protection helper linkagg
show virtual-chassis split-protection status
show virtual-chassis split-protection vc-units
show virtual-chassis split-protection helper status

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-1
virtual-chassis configured-chassis-id Virtual Chassis Commands

virtual-chassis configured-chassis-id
Assigns a globally unique chassis identifier to the switch.
virtual-chassis chassis-id oper-chassis configured-chassis-id config-chassis
no virtual-chassis chassis-id oper-chassis configured-chassis-id

Syntax Definitions

oper-chassis Chassis ID number. The operational/current chassis identifier.

config-chassis Chassis ID number. The configured/next chassis identifier.

Defaults

parameter default
oper-chassis 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Two switches that have the same chassis identifier are not allowed to operate in a virtual chassis. If a
duplicate chassis identifier is detected one of the switches will be in an inconsistent role and its status
will be set to Duplicate-Chassis-ID.
• The configured chassis identifier will only take effect after the next reboot of the target chassis.

• Snapshots produced through the show configuration vcm-snapshot, show configuration snapshot virtual
chassis or write memory commands always include the operational chassis identifier.
• Changing the chassis-id will not cause the Control VLAN or Group ID to change. These parameters
must also be manually changed if required.

Examples
-> virtual-chassis chassis-id 1 configured-chassis-id 2
-> no virtual-chassis chassis-id 0 configured-chassis-id

Release History
Release 8.1.1; command introduced.

page 11-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands virtual-chassis configured-chassis-id

Related Commands

show virtual-chassis Displays the system level mandatory consistency parameters of both the
consistency local and peer switches.
show virtual-chassis topology Displays details about the configured and operational parameters related
to all switches participating in the virtual chassis topology.

MIB Objects
virtualChassisGlobalTable
virtualChassisOperChasId
virtualChassisConfigChassisId

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-3
virtual-chassis chassis-group Virtual Chassis Commands

virtual-chassis chassis-group
Assigns a globally unique chassis group identifier to a chassis. Each peer switch in a virtual chassis
domain must use the same group ID number. The group ID number uniquely identifies switches operating
in the same virtual chassis.
virtual-chassis [chassis-id oper-chassis] chassis-group group

Syntax Definitions

oper-chassis Chassis ID number. The operational/current chassis identifier.

group virtual chassis group identifier (0-255), which is used to identify a group
of chassis belonging to the same virtual chassis.

Defaults

parameter default
group 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Each virtual chassis domain must use a different group ID number to differentiate the domain within
the network environment.
• If no operational chassis identifier is specified or if the value specified is zero, then the value is applied
to all switches in the virtual chassis.
• When a set of switches is running as a virtual chassis the chassis group can only be configured with
exactly the same value as the master chassis when the configuration applies to a single and specific
switch.
• When a set of switches is running as a virtual chassis the chassis group can be configured with any
value within the valid range as long as the configuration applies to all switches at the same time.
• It is strongly recommended that the same chassis group value is set for all switches that will participate
on the same virtual chassis group. Failure to adhere to this recommendation followed by a system reset
will prevent the switches whose values are different from joining the same virtual chassis group.

Examples
-> virtual-chassis chassis-id 1 chassis-group 10
-> virtual-chassis chassid-id 2 chassis-group 10
-> virtual-chassis chassis-group 10 // All switches

Release History
Release 8.1.1; command introduced.

page 11-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands virtual-chassis chassis-group

Related Commands

show virtual-chassis Displays the system level mandatory consistency parameters of both the
consistency local and peer switches.
show virtual-chassis topology Displays details about the configured and operational parameters related
to all switches participating in the virtual chassis topology.

MIB Objects
virtualChassisGlobalTable
virtualChassisOperChasID
virtualChassisGroup

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-5
virtual-chassis configured-chassis-priority Virtual Chassis Commands

virtual-chassis configured-chassis-priority
Sets the configured chassis priority for a chassis specified by its operational chassis identifier.
virtual-chassis [chassis-id oper-chassis] configured-chassis-priority priority

Syntax Definitions

oper-chassis Chassis ID number. The operational/current chassis identifier.

priority Configured chassis priority (0-255) which defines the user preference
above all other election criteria, for the target chassis to become the
master of the virtual chassis.

Defaults

parameter default
priority 100

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The highest number configured-chassis-priority will become the Master chassis. Without setting this
value the smallest chassis identifier becomes the key parameter used to determine which switch will
become the Master.
• If no operational chassis identifier is specified or if the value specified is zero, then the value is applied
to all switches in the virtual chassis.
• The configured chassis priority will only take effect after the next reboot of the target switch.

Examples
All switches:
-> virtual-chassis configured-chassis-priority 50

Chassis 2 only:
-> virtual-chassis chassis-id 2 configured chassis-priority 75

Release History
Release 8.1.1; command introduced.

page 11-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands virtual-chassis configured-chassis-priority

Related Commands

show virtual-chassis Displays the system level mandatory consistency parameters of both the
consistency local and peer switches.
show virtual-chassis topology Displays details about the configured and operational parameters related
to all switches participating in the virtual chassis topology.

MIB Objects
virtualChassisGlobalTable
virtualChassisOperChasID
virtualChassisConfigPriority

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-7
virtual-chassis configured-control-vlan Virtual Chassis Commands

virtual-chassis configured-control-vlan
Sets the configured control VLAN for a virtual chassis.
virtual-chassis configured-control-vlan vlan

Syntax Definitions

vlan Configured/next virtual chassis control VLAN (2-4094), which is used

for all internal control communication between switches over the VFL.

Defaults

parameter default
vlan 4094

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This configured control VLAN will only take effect after the next reboot.

Examples
-> virtual-chassis configured-control-vlan 10

Release History
Release 8.1.1; command introduced.

Related Commands

show virtual-chassis Displays the system level mandatory consistency parameters of both the
consistency local and peer switches.
show virtual-chassis topology Displays details about the configured and operational parameters related
to all switches participating in the virtual chassis topology.

MIB Objects
virtualChassisGlobalTable
virtualChassisOperChasID
virtualChassisConfigControlVlan

page 11-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands virtual-chassis hello-interval

virtual-chassis hello-interval
Sets the virtual chassis configured hello interval parameter on the chassis. Hello packets are sent periodi-
cally on the virtual fabric link (VFL) interfaces to establish a relationship and bidirectional communica-
tion between virtual chassis switches. The hello interval value determines how often these packets are
sent.
virtual-chassis [chassis-id oper-chassis] hello-interval hello

Syntax Definitions

oper-chassis Chassis ID number (1-8). The operational/current chassis identifier.

hello The operational/current virtual chassis hello interval in seconds (1–
65535), which defines how frequently the keep-alives related to the
virtual chassis hello protocol are exchanged over the VFL links.

Defaults

parameter default
hello 15

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If no operational chassis identifier is specified or if the value specified is zero, then the value is applied
to all switches in the virtual chassis.
• When a set of switches is running as a virtual chassis, the configured hello interval can only be
configured with exactly the same value as the master chassis when the configuration applies to a single
and specific switch.
• When a set of switches is running as a virtual chassis, the hello interval can be configured with any
value within the valid range as long as the configuration applies to all switches at the same time.

Examples
-> virtual-chassis hello-interval 10 //All chassis
-> virtual-chassis chassis-id 2 configured-hello-interval 10 //Chassis 2 only

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-9
virtual-chassis hello-interval Virtual Chassis Commands

Related Commands

vc-takeover This command causes a reload of the master chassis from the running
configuration in a virtual chassis environment.
show virtual-chassis Displays the system level mandatory consistency parameters of both the
consistency local and peer switches.
show virtual-chassis topology Displays details about the configured and operational parameters related
to all switches participating in the virtual chassis topology.

MIB Objects
virtualChassisGlobalTable
virtualChassisOperChasID
virtualChassisOperHelloInterval

page 11-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands virtual-chassis vf-link-mode

virtual-chassis vf-link-mode
Configures the Virtual Chassis mode. Virtual Chassis mode determines whether the VFLs are created
automatically or statically.
virtual-chassis vf-link-mode {static | auto}

Syntax Definitions

N/A

Defaults

parameter default
vf-link-mode auto

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The OS6860/6860E will always be in auto mode, static mode is not supported.

Examples
-> virtual-chassis vf-link-mode auto

-Release History
Release 8.2.1; command introduced.

Related Commands

show virtual-chassis vf-link Displays a summary of the configured and operational parameters
related to the virtual fabric link on the switch.

MIB Objects
virtualChassisGlobalTable
virtualChassisOperChasID
virtualChassisVflMode

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-11
virtual-chassis auto-vf-link-port Virtual Chassis Commands

virtual-chassis auto-vf-link-port
Configures the port to be an automatic VFL port.
virtual-chassis auto-vf-link-port chassis/slot/port
no virtual-chassis auto-vf-link-port chassis/slot/port

Syntax Definitions

chassis/slot/port The operational chassis identifier, slot, and port.

Defaults

chassis type default

auto-vf-link-port Dedicated 20G VFL ports

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The dedicated 20G VFL ports are always configured as automatic VFL ports and cannot be changed.

• This command can be used to configure ports other than the dedicated 20G VFL ports to act as VFL
ports.

Examples
-> virtual-chassis auto-vf-link-port 1/1/1
-> no virtual-chassis auto-vf-link-port 1/1/1

Release History
Release 8.2.1; command introduced.

Related Commands

show virtual-chassis auto-vf- Displays a summary of the auto VFL ports.

link-port

MIB Objects
virtualChassisAutoVflPortTable
virtualChassisAutoVflPortIfindex
virtualChassisAutoVflPortRowStatus

page 11-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands virtual-chassis shutdown

virtual-chassis shutdown
Disables all front-panel port including the user ports and all the VFL member ports on a chassis isolating
the chassis from the rest of the virtual chassis topology.
virtual-chassis shutdown [chassis-id oper-chassis]

Syntax Definitions

oper-chassis Chassis ID number. The operational/current chassis identifier.

Defaults
N/A
Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command should not be used to shutdown the Master chassis. It is designed for use on Slave
chassis and can be used to shutdown a Slave chassis that is being replaced.
• This command will disable all front panel ports, including the user ports and all virtual-fabric link
(VFL) member ports on the specified switch.
• After running this command remote access to the target switch is only possible through the local EMP
port on that switch.
• The target switch must be reloaded to bring its ports back to an operational state.

• This command is only functional when executed through the master chassis

• After the shutdown command is executed, the target switch assumes the role of master and remains
isolated from all other switches in the virtual chassis topology.

Examples
-> virtual-chassis shutdown chassis-id 2

Release History
Release 8.1.1; command introduced.

Related Commands

show virtual-chassis Displays the system level mandatory consistency parameters of both the
consistency local and peer switches.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-13
vc-takeover Virtual Chassis Commands

vc-takeover
This command causes a reload of the master chassis from the running configuration in a virtual chassis
environment.
vc-takeover

Syntax Definitions

N/A

Defaults
N/A
Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If there are no slave chassis present in the system, the command will be rejected.

• This is equivalent to reloading the master chassis from the current running directory using the reload
from command. However, this command includes and additional check for the existence of a slave
chassis before executing.

Examples
-> vc-takeover
WARNING - Working Changes Will Be Lost, Confirm VC takeover (Y/N) :

Release History
Release 8.1.1; command introduced.

Related Commands

reload from Reloads the master or slave chassis from the specified directory.

MIB Objects
chasEntPhysTable
chasEntPhysAdminStatus

page 11-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands show virtual-chassis topology

show virtual-chassis topology

This command is used to provide a detailed status of the virtual chassis topology.
show virtual-chassis [chassis-id {oper-chassis}] topology

Syntax Definitions

oper-chassis Chassis ID number. The operational/current chassis identifier.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command can be executed on any CMM within any switch of the system.

• When no operational chassis identifier is specified the command will show data related to the entire
virtual chassis system.
• A chassis-id of 100 to 108 is used to indicate a duplicate chassis-id.

Examples
-> show virtual-chassis topology
Legend: Licenses - A: Advanced; B: Data Center
Config
Chas Role Status Chas ID Pri Group MAC-Address
-----+------------+-------------------+--------+-----+------+------------------
1 Master Running 1 100 1 e8:e7:32:00:2a:55
2 Slave Running 2 100 1 e8:e7:32:07:9f:e1

-> show virtual-chassis chassis-id 2 topology

Oper-Chassis-ID : 2,
Config-Chassis-ID : 2,
Chassis-Role : Master,
Previous-Chassis-Role : Master,
Chassis-Status : Running,
Chassis-Group : 1,
Chassis-MAC : e8:e7:32:00:2a:55,
Up-Time : 0 days 0 hours 22 minutes and 7 seconds,
Designated-NI : 1,
Primary-CMM : CMM-A,
Secondary-CMM : Unknown,
Chassis-Type : OS6860,
Licence : AB,
Hello-Interval : 10,
Oper-Chassis-Priority : 100,
Config-Chassis-Priority : 100,
Oper-Control-VLAN : 4093,

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-15
show virtual-chassis topology Virtual Chassis Commands

Config-Control-VLAN : 4093,
Number-Of-Neighbors : 5,
Number-Of-Direct-Neighbors : 3

Chassis-ID Is-Direct Shortest-Path

------------+----------+---------------------
1 Yes 2/0->1/4
3 Yes 2/2->3/0
4 No 2/2->3/0, 3/3->4/2
5 Yes 2/1->5/1
6 No 2/0->1/4, 1/0->6/0

output definitions
Oper-Chassis-ID (Chas) Operational/current virtual chassis chassis identifier.
Config Chas ID The configured/next chassis identifier for the switch specified by
operational chassis identifier.
Chassis-Role (Role) Chassis Role
Unassigned: Role undefined as election has not completed yet.
Master: Chassis is central point of management and control.
Slave: Chassis is an active or functional participant of the virtual
chassis topology, but it is not the main entry point for management and
control purposes.
Inconsis: Chassis is not an active or functional participant of the virtual
chassis topology due to some inconsistent parameter, which does not
match the match the master chassis' settings.
Startup-Err: Chassis is in start up error mode because it was unable to
come up in a virtual chassis. When a chassis assumes the Startup-Err
role, its chassis status will be equal to either Invalid-Chassis-Id or
Invalid-License, which are described later in this section.
Previous-Chassis-Role Previous chassis role before the last transition.

page 11-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands show virtual-chassis topology

output definitions
Chassis-Status (Status) Chassis Status
Init: Status undefined as the chassis has not completed its initialization.
Running: The chassis is fully operational.
Invalid-Chassis-Id: The chassis is not operational because no valid
chassis identifier has been found in the configuration. Typically this
means that the vcsetup.cfg file is corrupted, empty or contains an
invalid (e.g. out of range) chassis ID identifier.
Invalid-License: The chassis is not operational in because no valid
advanced license has been found.
Hello-Down: The chassis is isolated from the rest of the virtual chassis
topology participants because hello packets have not been received for
a period of time greater than the hello timeout.
Duplicate-Chassis: This chassis is not fully operational because its
operational chassis identifier matches the chassis ID of another chassis
within the virtual chassis topology. As a result, a new operational
chassis identifier from the range (101-102) will be allocated to this
chassis.
Mis-Image: The chassis is not fully operational because its image
versions are not consistent with the master chassis' images. In other
words, the image version are not compatible and some of the software
components running on this chassis are unable to interface with the
software operating in the master chassis.
Mis-Chassis-Type: The chassis is not fully operational because its
chassis type is not consistent with the master chassis' type. Different
chassis types cannot be mixed in the same virtual chassis topology.
Mis-Hello-Interval: The chassis is not fully operational because its
operational hello interval is not consistent with the master chassis'
operational hello interval.
Mis-Control-Vlan: The chassis is not fully operational because its
operational control VLAN is not consistent with the master chassis'
operational control VLAN.
Mis-Chassis-Group: The chassis is not fully operational because its
chassis group does not match the master chassis' chassis group and the
chassis is connected directly or indirectly to the master chassis through
virtual-fabric links. This chassis is unable to join the active virtual
chassis topology whose master chassis is part of.
Mis-License-Config: The chassis is not fully operational because its
license settings do not match the master chassis' license configuration.
An exact match is required to allow successful operation within the
same virtual chassis topology.
Split-Topology: The chassis is not fully operational and all of its front
panel user ports (excluding the virtual-fabric link member ports) are
operationally down because a topology split has occurred. This chassis
became isolated from the master chassis after all of its active virtual-
fabric member ports went down or the virtual chassis manager hello
timeout has expired.
Chassis-Group (Group) Virtual chassis group identifier. Used to identify a group of chassis
belonging to the same virtual chassis.
Chassis-MAC (MAC-Address) Chassis MAC address.
Up-Time Chassis up time.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-17
show virtual-chassis topology Virtual Chassis Commands

output definitions
Designated-NI Designated network interface module (NI), which is the module
responsible for managing the inter-process communication
infrastructure responsible for control communication between distinct
switches within the virtual chassis topology.
Primary-CMM Primary CMM slot.
Secondary-CMM Secondary CMM slot.
Chassis-Type The switch chassis type.
License The licenses installed on the chassis.
Hello-Interval The hello-interval configured for the chassis.
Oper-Chassis-Priority (Pri) Operational/current chassis priority, which defines the user preference,
above all other election criteria, for a switch to become the master
chassis of the virtual chassis topology. The greater this value the more
likely a switch is to be elected as the master chassis.
Config-Chassis-Priority Configured/next chassis priority, which defines the user preference
above all other election criteria.
Oper-Control-VLAN Operational/current virtual chassis control VLAN.
Config-Control-VLAN Configured/next virtual chassis control VLAN, which will take effect
after reset thereby becoming the next operational control VLAN.
Number-of-Neighbors Total number of neighbor switches that are part of the active virtual
chassis topology for a given chassis group.
Number-of-Direct-Neighbors Number of directly attached neighbor switches that are part of the
active virtual chassis topology for a given chassis group These are
switches directly connected to the local switch through a virtual-fabric
link (VFL).
Neighbor The operational chassis identifier of neighbor switch.
Is-Direct Flag identifying whether a particular neighbor is directly attached to a
given switch.
Shortest-Path The shortest path from a given switch to a neighbor switch using the
notation chassis/vfl-id.

Release History
Release 8.1.1; command introduced.

page 11-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands show virtual-chassis topology

Related Commands

virtual-chassis configured- Assigns a globally unique chassis identifier to the switch.

chassis-id
virtual-chassis chassis-group Assigns a globally unique chassis group identifier to a switch. Each peer
switch in a virtual chassis domain must use the same group ID number.
virtual-chassis configured- Sets the configured chassis priority for a switch specified by its
chassis-priority operational chassis identifier.
virtual-chassis configured- Sets the configured control VLAN for a switch specified by its
control-vlan operational chassis identifier.
virtual-chassis configured- Configures the virtual chassis hello interval parameter on the switch.
hello-interval

MIB Objects
virtualChassisGlobalTable
virtualChassisOperChasId
virtualChassisConfigChassisID
virtualChassisRole
virtualChassisPreviousRole
virtualChassisStatus
virtualChassisConfigPriority
virtualChassisOperPriority
virtualChassisGroup
virtualChassisMac
virtualChassisUpTime
virtualChassisDesigNI
virtualChassisPriCmm
virtualChassisSecCmm
virtualChassisOperControlVlan
virtualChassisConfigControlVlan
virtualChassisOperHelloInterval
virtualChassisConfigHelloInterval
virtualChassisType
virtualChassisLicense
virtualChassisNumOfNeighbor
virtualChassisNumOfDirectNeighbor

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-19
show virtual-chassis consistency Virtual Chassis Commands

show virtual-chassis consistency

This command is used to provide a detailed status of the parameters taken into account to determine the
consistency of a group of switches participating in the virtual chassis topology.
show virtual-chassis [chassis-id oper-chassis] consistency

Syntax Definitions

oper-chassis Chassis ID number. The operational/current chassis identifier.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command provides a list of parameters that must be configured consistently on all switches that
will participate on the virtual chassis topology to allow correct system operation.
• In order to determine the consistency of a given parameter, the switch will compare the value of such
parameters on a given switch with the settings of the master chassis. Therefore consistency is always
defined as a comparison with the master chassis.
• The following parameters are considered consistent if they match the settings of the master chassis:
chassis type, license, chassis group, operational control VLAN, configured control VLAN, operational
hello interval and configured hello interval.
• The configured chassis identifier parameter is considered consistent if it is different than the settings of
the master chassis.

Examples
-> show virtual-chassis consistency
Legend: * - denotes mandatory consistency which will affect chassis status
Licenses - A: Advanced; B: Data Center

Config Oper Config

Chas Chas Chas Hello Control Control
Chas* ID Status Type* Group* Interv Vlan* Vlan License*
------+------+------+-------+------+-------+--------+--------+----------
1 1 OK OS6860 0 10 4094 4094 AB
2 2 OK OS6860 0 10 4094 4094 AB
3 2 NOK OS6860 0 10 4094 4000 AB
4 2 OK OS6860 0 10 4094 4094 AB
5 2 OK OS6860 0 10 4094 4094 AB
6 2 NOK OS6860 0 10 4094 4094 A

page 11-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands show virtual-chassis consistency

-> show virtual-chassis chassis-id 2 consistency

Legend: * - denotes mandatory consistency which will affect chassis status
Licenses - A: Advanced; B: Data Center

Given Master
Consistency Chassis Chassis Status
---------------------+----------+----------+---------
Chassis-ID* 2 1 OK
Config-Chassis-ID 2 1 OK
Chassis-Type* OS6860 OS860 OK
License* A AB NOK
Chassis-Group* 0 0 OK
Hello-Interval 10 10 OK
Oper-Control-Vlan* 4094 4094 OK
Config-Control-Vlan 4094 4094 OK

output definitions
Chassis-ID (Chas) Operational/current virtual chassis identifier.
Config-Chassis-ID (Conf Chas The configured/next chassis identifier for the switch specified by
ID) operational chassis identifier.
Chassis-Type (Chas Type) The switch chassis type.
License The licenses installed on the chassis.
Chassis-Group (Chas Group) virtual chassis group identifier. Used to identify a group of chassis
belonging to the same active virtual chassis topology.
Hello-Interval Operational/current hello-interval.
Oper-Control-VLAN Operational/current virtual chassis control VLAN.
Config-Control-VLAN Configured/next virtual chassis control VLAN, which will take effect
after reset thereby becoming the next operational control VLAN.
Status Defines whether a given switch's parameter is considered consistent
with the master chassis' settings. The possible values are:
OK: The switch is operational and the given switch's parameter value is
consistent with the settings of the master chassis.
NOK: The switch is operational but the given switch's parameter value
is inconsistent with the settings of the master chassis.
N/A: The switch is operational but the virtual chassis topology has not
converged and therefore a master chassis is not yet known.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-21
show virtual-chassis consistency Virtual Chassis Commands

Related Commands

virtual-chassis configured- Assigns a globally unique chassis identifier to the switch.

chassis-id
virtual-chassis chassis-group Assigns a globally unique chassis group identifier to a chassis. Each
peer switch in a virtual chassis domain must use the same group ID
number.
virtual-chassis configured- Sets the chassis priority for a chassis specified by its operational chassis
chassis-priority identifier.
virtual-chassis configured- Sets the configured control VLAN for a chassis specified by its
control-vlan operational chassis identifier.
virtual-chassis configured- Sets the configured hello interval parameter on the switch.
hello-interval

MIB Objects
virtualChassisGlobalTable
virtualChassisOperChasId
virtualChassisConfigChassisID
virtualChassisType
virtualChassisLicense
virtualChassisGroup
virtualChassisOperControlVlan
virtualChassisConfigControlVlan
virtualChassisOperHelloInterval
virtualChassisConfigHelloInterval

page 11-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands show virtual-chassis vf-link

show virtual-chassis vf-link

Displays a summary of the configured and operational parameters related to the virtual fabric links on the
virtual chassis topology.
show virtual-chassis [chassis-id oper-chassis] vf-link [member-port]

Syntax Definitions

oper-chassis Chassis ID number. The operational/current chassis identifier.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
In a VC of two chassis when both VFL ports connected, they will act as a link aggregate of two VFL
ports. The VF Link ID will be displayed as 0.

Examples
-> show virtual-chassis vf-link
Primary Config Active Def Speed
Chassis/VFLink ID Oper Port Port Port Vlan Type
-------------------+----------+---------+-------+-------+---------+-----------
1/0 UP 1/1/53 1 1 1 21G
1/1 UP 1/1/54 1 1 1 21G

-> show virtual-chassis chassis-id 1 vf-link member-port

Chassis/VFLink ID Chassis/Slot/Port Oper Is Primary
-------------------+------------------+----------+-------------
1/0 1/1/53 Up Yes
1/0 1/1/54 Up No

output definitions
Chassis/VFLink ID Pair operational/current virtual chassis chassis identifier and virtual-
fabric link (VFL) identifier.
Oper Virtual-fabric link (VFL) operational status. The possible values are Up
and Down.
Primary Port Primary port of the virtual-fabric link (VFL) trunk, which is the port
where non-unicast packets destined a remote chassis are sent out.
Config Port Number of ports configured to operate as virtual-fabric link (VFL)
member ports, i.e. ports that potentially may join a virtual-fabric link
(VFL).

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-23
show virtual-chassis vf-link Virtual Chassis Commands

output definitions
Active Port Number of virtual-fabric link (VFL) member ports that are operational,
i.e. the LACP protocol is fully operational for those ports.
Def Vlan Operational default VLAN on the virtual-fabric link (VFL).
Chassis/Slot/Port The operational chassis/slot/port identifying a particular virtual–fabric
link (VFL) member port.
Is Primary Indicates if this port is the primary port of the VFL.

Release History
Release 8.1.1; command introduced.

Related Commands

virtual-chassis configured- Assigns a globally unique chassis identifier to the switch.

chassis-id

MIB Objects
virtualChassisLinkTable
virtualChassisOperChasID
virtualChassisLinkOperDefaultVlan
virtualChassisLinkLinkOperStatus
virtualChassisLinkPrimaryPort
virutalChassisLinkConfigPortNum
virtualChassisLinkActivePortNum
virtualChassisLinkId
virtualChassisVflMemberPortIfindex
virtualChassisVflMemberPortRowStatus

page 11-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands show virtual-chassis auto-vf-link-port

show virtual-chassis auto-vf-link-port

Displays a summary of the auto VFL ports.
show virtual-chassis [chassis-id oper_chassis] auto-vf-link-port [chassis/slot/port]

Syntax Definitions

oper_chassis Chassis ID number (0-6 on OS6900 / 0-2 on OS10K). The operational/

current chassis identifier.
oper_chassis/slot/port The operational chassis identifier, slot, and port.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command can be executed on any switch within the virtual chassis topology.

Examples
-> show virtual-chassis auto-vf-link-port
Chassis/Slot/Port Chassis/VFL ID VFL member status
-------------------+------------------+-----------------------
1/1/1 1/0 Down
1/1/3 1/1 Up

output definitions
Chassis/Slot/Port The chassis/slot/port identifier.
Chassis/VFL ID The VFL identifier.
VFL member status The status of the VFL member port. Up or Down.

Release History
Release 8.2.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-25
show virtual-chassis auto-vf-link-port Virtual Chassis Commands

Related Commands

virtual-chassis auto-vf-link- Configures the port to be an automatic VFL port.

port

MIB Objects
virtualChassisLinkTable
virtualChassisOperChasID
virtualChassisVflMemberPortRowStatus

page 11-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands show virtual-chassis chassis-reset-list

show virtual-chassis chassis-reset-list

This command displays the list of all chassis that must be reset along with a specified chassis in order to
prevent a virtual chassis topology split.
show virtual-chassis [chassis-id oper-chassis] chassis-reset-list

Syntax Definitions

oper-chassis Chassis ID number. The operational/current chassis identifier.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
When no operational chassis identifier is specified the command will show data related to the entire virtual
chassis system.

Examples
-> show virtual-chassis chassis-reset-list
Chas Chassis reset list
-----+---------------------
1 1
2 2

-> show virtual-chassis chassis-id 1 chassis-reset-list

Chas Chassis reset list
-----+---------------------
1 1

output definitions
Chas Operational/current virtual chassis chassis identifier.
Chassis reset list A list of operational chassis identifiers, which define which switches
must be reset, along with the switch given by Chas in order to prevent a
split of the virtual chassis topology.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-27
show virtual-chassis chassis-reset-list Virtual Chassis Commands

Related Commands

show virtual-chassis topology Displays details about the configured and operational parameters related
to all switches participating in the virtual chassis topology

MIB Objects
virtualChassisChassisResetListTable
virtualChassisOperChasId
virtualChassisChassisResetList

page 11-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands show virtual-chassis slot-reset-list

show virtual-chassis slot-reset-list

For a given chassis and network interface module (NI), this command displays status information
specifying whether bringing down or extracting such network interface module (NI) will lead to a virtual
chassis topology split.
show virtual-chassis [chassis-id oper-chassis] slot-reset-list

Syntax Definitions

oper-chassis Chassis ID number. The operational/current chassis identifier.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When no operational chassis identifier is specified the command will show data related to the entire
virtual chassis system.
• On the OmniSwitch 6860, the slot number depicted in this command always refers to the main board of
the switch (i.e. slot number 1). In other words, this command does not present the status related to
expansion boards.

Examples
-> show virtual-chassis slot-reset-list
Chas Slot Reset status
-----+-------+--------------
1 1 Split
2 1 Split

-> show virtual-chassis chassis-id 1 slot-reset-list

Chas Slot Reset status
-----+-------+--------------
1 1 Split

output definitions
Chas Operational/current virtual chassis chassis identifier.
Slot Slot number identifying a particular network interface module (NI). For
an OS6860 the slot number is always be equal to 1.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-29
show virtual-chassis slot-reset-list Virtual Chassis Commands

output definitions
Reset Status For the network interface module (NI) identified by the pair (Chas,
Slot), this command displays status information specifying whether
bringing down or extracting such network interface module (NI) will
lead to a virtual chassis topology split according to the following
definitions.
Supported: The network interface module can be reset without
splitting the virtual chassis topology.
Split: Resetting this network interface module will cause a virtual
chassis topology split.

Release History
Release 8.1.1; command introduced.

Related Commands

show virtual-chassis topology Displays details about the configured and operational parameters related
to all switches participating in the virtual chassis topology

MIB Objects
virtualChassisSlotResetStatusTable
virtualChassisOperChasID
virtualChassisSlotResetStatus

page 11-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands show virtual-chassis neighbors

show virtual-chassis neighbors

This command displays a list of which neighbors are connected via which VFL for a virtual chassis.
show virtual-chassis [chassis-id oper-chassis] neighbors

Syntax Definitions

oper-chassis Chassis ID number (1-8). The operational/current chassis identifier.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
When no operational chassis identifier is specified the command will show data related to the entire virtual
chassis system.

Examples
-> show virtual-chassis neighbors

Chas VFL VFL

ID 0 1
----+---+---
1 6 2
2 1 3
3 2 4
4 3 5
5 4 6
6 5 1

-> show virtual-chassis chassis-id 2 neighbors

Chas VFL VFL

ID 0 1
----+---+---+
2 1 3

output definitions
Chas ID Operational/current virtual chassis chassis identifier.
VFL The VLF identifier connecting to the remote chassis listed in the table.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-31
show virtual-chassis neighbors Virtual Chassis Commands

Related Commands

show virtual-chassis topology Displays details about the configured and operational parameters related
to all switches participating in the virtual chassis topology

MIB Objects
virtualChassisVflTable
virtualChassisOperChasID
virtualChassisVflId
virtualChassisVflDirectNeighborChasId

page 11-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands show configuration vcm-snapshot chassis-id

show configuration vcm-snapshot chassis-id

Displays a snapshot of the switch specific virtual chassis configuration.
show configuration vcm-snapshot chassis-id oper-chassis

Syntax Definitions

oper-chassis Chassis ID number. The operational/current chassis identifier.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A.

Examples
-> show configuration vcm-snapshot chassis-id 1
! Virtual Chassis Manager:
virtual-chassis chassis-id 1 configured-chassis-id 1
virtual-chassis chassis-id 1 configured-control-vlan 4091
virtual-chassis chassis-id 1 chassis-group 1

! IP:
ip interface local chassis-id 1 emp address 10.255.76.21 mask 255.255.255.0

Release History
Release 8.1.1; command introduced.

Related Commands

show configuration snapshot Displays the configured and operational parameters related to the
virtual-chassis feature on the switch.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-33
virtual-chassis split-protection admin-state Virtual Chassis Commands

virtual-chassis split-protection admin-state

Enable or disables the VC split protection feature.
virtual-chassis split-protection admin-state {enable | disable}

Syntax Definitions

enable Enables VC split protection.

disable Disables VC split protection.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• VCSP cannot be enabled before assigning a Linkagg.

• VCSP cannot be enabled on a device that is already running the helper functionality.

• The virtual chassis and its helper cannot have the same Group ID.

Examples
-> virtual-chassis split-protection admin-state enable
-> virtual-chassis split-protection admin-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

show virtual-chassis split- Displays all the information related to VCSP when enabled.
protection status
virtual-chassis split- Assigns a link aggregate for use with VCSP.
protection linkagg

MIB Objects
alaVCSPConfigInfo
alaVCSPAdminState

page 11-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands virtual-chassis split-protection linkagg

virtual-chassis split-protection linkagg

Assigns a link aggregate for use with VCSP.
virtual-chassis split-protection linkagg agg_id
no virtual-chassis split-protection linkagg

Syntax Definitions

agg_id The link aggregate ID number to associate with the helper for VCSP
support. The valid range is 0–255.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the link aggregate assignment.

• This command must be used to configure VC split protection linkagg before enabling VC split
protection.

Examples
-> virtual-chassis split-protection linkagg 1

Release History
Release 8.1.1; command was introduced.

Related Commands

show virtual-chassis split- Displays all the information related to VCSP when enabled.
protection status

MIB Objects
alaVCSPConfigInfo
alaVCSPLinkaggID

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-35
virtual-chassis split-protection guard-timer Virtual Chassis Commands

virtual-chassis split-protection guard-timer

Configures the timer value for how long the master will wait to receive VCSP PDUs before beginning
transmission of VCSP PDUs.
virtual-chassis split-protection guard-timer time

Syntax Definitions

time Time interval to wait on boot up before choosing any state. The valid
range is 30–100 seconds.

Defaults

parameter default
time 30 seconds

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Changes to the Guard timer only take affect after reboot or by disabling and re-enabling VC split
protection.

Examples
-> virtual-chassis split-protection guard-timer 60

Release History
Release 8.1.1; command was introduced. Not supported in this release.

Related Commands

show virtual-chassis split- Displays all the information related to VCSP when enabled.
protection status

MIB Objects
alaVCSPConfigInfo
alaVCSPGuardTimer

page 11-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands virtual-chassis split-protection helper admin-state

virtual-chassis split-protection helper admin-state

Enables or disables the helper functionality on the helper device.
virtual-chassis split-protection helper admin-state {enable | disable}

Syntax Definitions

enable Enables VC split protection helper functionality.

disable Disables VC split protection helper functionality.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use this command on the helper device to enable the helper functionality.

• The helper functionality cannot be enabled on a device that is running VCSP.

• The virtual chassis and its helper cannot have the same Group ID.

Examples
-> virtual-chassis split-protection helper admin-state enable
-> virtual-chassis split-protection helper admin-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

virtual-chassis split- Configures the link aggregate on which to apply the VCSP protocol for
protection helper linkagg the helper device.

MIB Objects
alaVCSPHelperGlobalConfig
alaVCSPHelperAdminState

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-37
virtual-chassis split-protection helper linkagg Virtual Chassis Commands

virtual-chassis split-protection helper linkagg

Configures the link aggregate ID on which to apply the VCSP protocol on the helper device.
virtual-chassis split-protection helper linkagg agg_id
no virtual-chassis split-protection helper linkagg

Syntax Definitions

agg_id The link aggregate ID number to associate with the helper for VCSP
support. The valid range is 0–255.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the link aggregate assignment.

• Use this command on the helper device to enable the VCSP protocol on the helper link aggregate.

Examples
-> virtual-chassis split-protection helper linkagg 1
-> no virtual-chassis split-protection helper linkagg

Release History
Release 8.1.1; command was introduced.

Related Commands

show virtual-chassis split- Displays the VCSP Helper status of the link aggregation ID assigned.
protection status
virtual-chassis split- Enables or disables the helper functionality.
protection helper admin-
state

MIB Objects
alaVCSPHelperLinkaggTable
alaVCSPHelperLinkaggId
alaVCSPHelperLinkaggRowStatus

page 11-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands show virtual-chassis split-protection status

show virtual-chassis split-protection status

Displays all the information related to VCSP when enabled.
show virtual-chassis split-protection status

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show virtual-chassis split-protection status
VCSP admin status: enabled
VCSP operational status: Active
VCSP linkagg: 31
VCSP Guard Timer: 30
VCSP Uptime: 00d:00h:00m:00s,
VCSP Protection Uptime: 00d:00h:00m:00s

Release History
Release 8.1.1; command was introduced.

Related Commands

virtual-chassis split- Enable or disables the VC split protection feature.

protection admin-state

MIB Objects
alaVCSPConfigInfo
alaVCSPAdminState
alaVCSPOperState
alaVCSPLinkaggId
alaVCSPGuardTimer
alaVCSPUptime
alaVCSPProtectionStateUptime

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-39
show virtual-chassis split-protection vc-units Virtual Chassis Commands

show virtual-chassis split-protection vc-units

Displays the VCSP state of all VC units.
show virtual-chassis split-protection vc-units

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show virtual-chassis split-protection vc-units

CHASSIS STATE
----------+-----------
1 ACTIVE
2 ACTIVE

Release History
Release 8.1.1; command was introduced.

Related Commands

virtual-chassis split- Enable or disables the VC split protection feature.

protection admin-state

MIB Objects
alaVCSPStateTable
alaVCSPTableSlotNiNumber
alaVCSPTableOperState

page 11-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Virtual Chassis Commands show virtual-chassis split-protection helper status

show virtual-chassis split-protection helper status

Displays the VCSP Helper status of the assigned link aggregation ID.
show virtual-chassis split-protection helper status

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show virtual-chassis split-protection helper status
VC Split-Protection Helper Status : Enabled
Link Aggregation Id VC Split-Protection Status
-------------------------+----------------------------------------------------
3 Enabled

Release History
Release 8.1.1; command was introduced.

Related Commands

virtual-chassis split- Enables or disables the helper functionality.

protection helper admin-
state

MIB Objects
alaVCSPHelperGlobalConfig
alaVCSPHelperLinkaggId
alaVCSPHelperState

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 11-41
show virtual-chassis split-protection helper status Virtual Chassis Commands

page 11-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 12 Ethernet Ring Protection
Commands

Ethernet Ring Protection (ERP) is a protection switching mechanism for Ethernet ring topologies, such as
multi-ring and ladder networks. The implementation of ERP on Alcatel-Lucent OmniSwitch is based on
ERP Version 2 (ITU-T G.8032/Y.1344 to 2010) using the Ring Automatic Protection Switching (R-APS)
protocol to coordinate and prevent network loops within a bridged Ethernet ring.
ERPv2 supports multi-rings and ladder to ladder networks. ERPv2 functionalities allow configuration of
Sub-Rings within a Master Ethernet Ring, interconnected nodes and shared links between the rings.
MIB information for Ethernet Ring Protection commands is as follows:
Filename: AlcatelIND1Erp.mib
Module: ALCATEL-IND1-ERP-MIB
A summary of available commands is listed here:

erp-ring
erp-ring rpl-node
erp-ring wait-to-restore
erp-ring enable
erp-ring guard-timer
erp-ring sub-ring
erp-ring virtual-channel
erp-ring revertive
erp-ring clear
erp-ring ethoam-event
clear erp statistics
show erp
show erp statistics
show erp statistics

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 12-1
erp-ring Ethernet Ring Protection Commands

erp-ring
Creates an Ethernet Ring Protection (ERP) using the specified ports and service VLAN ID. The service
VLAN transmits ERP control traffic, such as Ring Automatic Protection Switching (R-APS) messages,
through the ring. The specified level number identifies an APS Management Entity Group (MEG) to
which the service VLAN belongs.
erp-ring ring_id port1 {chassis/slot/port | linkagg agg_num} port2 {chassis/slot/port | linkagg agg_num}
service-vlan vlan_id level level_num [guard-timer guard_timer] [wait-to-restore-timer wtr_timer]
[enable | disable]
no erp-ring ring_id

Syntax Definitions

ring_id The ERP ring ID number. The valid range is 1 to 2147483647.

chassis The chassis identifier.
slot/port The slot number for the module and the physical port number on that
module.
agg_num The link aggregate ID number.
vlan_id The service VLAN ID number.The valid range is 1 to 4094.
level_num The MEG level number for the service VLAN. The valid range is 0 to 7.
guard-timer The guard timer value, in centi seconds, for the ring node.
wtr-timer The wait-to-restore timer value, in minutes, for the Ring Protection Link
(RPL) node.
enable Administratively enables the ERP ring
disable Administratively disables the ERP ring.

Defaults

parameter default
guard_timer 50
wtr_timer 5
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a ring from the switch configuration. Administratively
disable the ring ports before deleting the ring to avoid creating any network loops. Once the ring is
deleted, ensure that the same ports are administratively enabled under Spanning Tree control.
• The specified ring identification number must be unique within a switch.

page 12-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Ring Protection Commands erp-ring

• ERP is not supported on mobile ports, mirroring ports, link aggregate member ports, high availability
ports, Multicast VLAN receiver ports (ERP is supported on Multicast VLAN sender ports only),
VLAN Stacking user network interface (UNI) ports, or RRSTP ring ports.
• If a port is tagged with the service VLAN ID or the service VLAN is the default VLAN for the port,
then the port is not eligible to become an ERP ring port.
• Specify an existing VLAN ID for the service VLAN ID. Use the same VLAN ID and level number for
the service VLAN on each switch that participates in the ERP ring.
• If the ERP switch participates in an Ethernet OAM Maintenance Domain (MD), configure the ERP
service VLAN to use the same level number that is used for the Ethernet OAM MD.
• Specify a static VLAN ID for the ERP service VLAN; dynamic VLANs are not configurable as service
VLANs.
• The service VLAN can belong to only one ERP ring at a time. A maximum of 64 rings are allowed per
switch.
• The specified service VLAN ID must not participate in a Spanning Tree instance that is associated with
non-ERP VLANs. Ideally, change the Spanning Tree configuration for the VLAN ID prior to using
this command.
• An ERP ring port can belong to only one ERP ring at a time.

• Create an ERP type NNI-SVLAN binding before establishing an ERP ring on that SVLAN-NNI
binding.

Examples
-> erp-ring 1 port1 1/1/1 port2 2/1/4 service-vlan 10 level 2 enable
-> erp-ring 2 port1 linkagg 1 port2 2/1/10 service-vlan 20 level 2
-> erp-ring 3 port1 linkagg 2 port2 linkagg 4 service-vlan 30 level 7
-> no erp-ring 2

Release History
Release 8.1.1; command introduced.

Related Commands

show erp Displays the ERP ring configuration for the switch.
show erp statistics Displays ERP ring statistics.
ethernet-service svlan nni Creates an NNI-SVLAN binding.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 12-3
erp-ring Ethernet Ring Protection Commands

MIB Objects
alaErpRingTable
alaErpRingServiceVid
alaErpRingMEGLevel
alaErpRingStatus
alaErpRingPort1
alaErpRingPort2
alaErpRingWaitToRestore
alaErpRingGuardTimer
alaErpRingRowStatus

page 12-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Ring Protection Commands erp-ring rpl-node

erp-ring rpl-node
Configures a switch as a Ring Protection Link (RPL) node. This command also identifies the ERP port as
an RPL connection port. The RPL remains blocked to prevent loops within the ERP ring.
erp-ring ring_id rpl-node {port chassis/slot/port | linkagg agg_num}
no erp-ring ring_id rpl-node

Syntax Definitions

ring_id An existing ERP ring ID number. The valid range is 1 to 2147483647.

chassis The chassis identifier.
slot/port The slot number for the module and the physical port number on that
module.
agg_num The link aggregate ID number.

Defaults
NA

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the RPL designation for the specified ring.

• The RPL node can be configured only when the ring is disabled. RPL configuration applied to the
Ethernet ring while it is enabled is rejected.
• The specified ERP ring ID must exist in the switch configuration.

• This command applies only to ERP ring ports; ports not configured as ERP ring ports are not eligible
to become RPL ports.
• Only one of the two ring ports configured for the switch can be designated as an RPL node port.

Examples
-> erp-ring 1 rpl-node port 2/1/1
-> erp-ring 2 rpl-node linkagg 2
-> no erp-ring 2 rpl-node

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 12-5
erp-ring rpl-node Ethernet Ring Protection Commands

Related Commands

erp-ring Configures an ERP ring.

erp-ring wait-to-restore Configures the wait-to-restore timer value for the Ring Protection
Link (RPL) node.
show erp Displays the ERP ring configuration for the switch.

MIB Objects
alaErpRingPortEntry
alaErpRingPortIfIndex
alaErpRingPortType

page 12-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Ring Protection Commands erp-ring wait-to-restore

erp-ring wait-to-restore
Configures the wait-to-restore timer value for the Ring Protection Link (RPL) switch. This timer
determines the number of minutes the RPL switch waits before returning the RPL ports to a blocked state
after the ERP ring has recovered from a link failure.
erp-ring ring_id wait-to-restore wtr_timer
no erp-ring ring_id wait-to-restore

Syntax Definitions

ring_id An existing ERP ring ID number. The valid range is 1 to 2147483647.

wtr_timer The number of minutes to wait before restoring the RPL to a blocked
state. The valid range is 1 to 12.

Defaults
By default, the wait-to-restore timer value is set to 5 minutes.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to set the timer back to the default setting of 5 minutes.

• The specified ERP ring ID must exist in the switch configuration.

• This command applies only on a switch that serves as the RPL node for the ERP ring.

Examples
-> erp-ring 1 wait-to-restore 6
-> no erp-ring 1 wait-to-restore

Release History
Release 8.1.1; command introduced.

Related Commands

erp-ring Configures an ERP ring.

erp-ring rpl-node Configures a Ring Protection Link (RPL) port connection.
show erp Displays the ERP ring configuration for the switch.

MIB Objects
alaErpRingId
alaErpRingWaitToRestoreTimer

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 12-7
erp-ring enable Ethernet Ring Protection Commands

erp-ring enable
Enables or disables an ERP ring identified by the specified ring ID. This command applies to enabling or
disabling existing ERP rings.
erp-ring ring_id {enable | disable}

Syntax Definitions

ring_id An existing ERP ring ID number. The valid range is 1to2147483647.

Defaults
By default, ERP rings are disabled when they are created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The specified ring ID must exist in the switch configuration.

• Enabling a ring is also allowed at the time the ring is created.

Examples
-> erp-ring 1 enable
-> erp-ring 1 disable

Release History
Release 8.1.1; command introduced.

Related Commands

erp-ring Configures an ERP ring.

show erp Displays the ERP ring configuration for the switch.

MIB Objects
alaErpRingId
alaErpRingStatus

page 12-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Ring Protection Commands erp-ring guard-timer

erp-ring guard-timer
Configures the guard timer value for the specified ERP ring node. The guard timer is used to prevent ring
nodes from receiving outdated Ring Automatic Protection Switching (R-APS) messages. During the
amount of time determined by this timer, all received R-APS messages are ignored by the ring protection
control process.
erp-ring ring_id guard-timer guard_timer
no erp-ring ring_id guard-timer

Syntax Definitions

ring_id An existing ERP ring ID number. The valid range is 1–2147483647.

guard_timer The guard timer value. The valid range is 1–200 centi-secs.

Defaults

parameter default
guard_timer 50

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to set the timer back to the default value of 50 centi-secs.

• The specified ring ID must exist in the switch configuration.

Examples
-> erp-ring 1 guard-timer 10
-> no erp-ring 1 guard-timer

Release History
Release 8.1.1; command introduced.

Related Commands

erp-ring Configures an ERP ring.

show erp Displays the ERP ring configuration for the switch.

MIB Objects
alaErpRingId
alaErpRingGuardTimer

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 12-9
erp-ring sub-ring Ethernet Ring Protection Commands

erp-ring sub-ring
Creates an Ethernet Ring Protection (ERP) sub-ring.
erp-ring ring_id sub-ring-port {chassis/slot/port | linkagg agg_num} service-vlan vlan_id level
level_num [guard-timer guard_timer] [wait-to-restore-timer wtr_timer] [enable | disable]

Syntax Definitions

ring_id The ERP ring ID number. The valid range is 1 to 2147483647.

chassis The chassis identifier.
slot/port The slot number for the module and the physical port number on that
module.
agg_num The link aggregate ID number.
vlan_id The service VLAN ID number.The valid range is 1 to 4094.
level_num The MEG level number for the service VLAN. The valid range is 0 to 7.
guard-timer The guard timer value, in centi-secs, for the ring node.
wtr-timer The wait-to-restore timer value, in minutes, for the Ring Protection Link
(RPL) node.
enable Administratively enables the ERP sub-ring
disable Administratively disables the ERP sub-ring.

Defaults

parameter default
guard_timer 50
wtr_timer 5
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a sub-ring from the switch configuration. Administratively
disable ring ports before deleting the ring to avoid creating any network loops. Once the ring is deleted,
ensure that the same ports are administratively enabled under Spanning Tree control.
• The specified ring identification number must be unique within a switch.

• ERP is not supported on mobile ports, mirroring ports, link aggregate member ports, high availability
ports, Multicast VLAN receiver ports (ERP is supported on Multicast VLAN sender ports only),
VLAN Stacking user network interface (UNI) ports, or RRSTP ring ports.
• If a port is tagged with the service VLAN ID or the service VLAN is the default VLAN for the port,
the port is not eligible to become an ERP ring port.

page 12-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Ring Protection Commands erp-ring sub-ring

• Specify an existing VLAN ID for the service VLAN ID. Use the same VLAN ID and level number for
the service VLAN on each switch that participates in the ERP ring.
• If the ERP switch participates in an Ethernet OAM Maintenance Domain (MD), configure the ERP
service VLAN to use the same level number that is used for the Ethernet OAM MD.
• Specify a static VLAN ID for the ERP service VLAN; dynamic VLANs are not configurable as service
VLANs.
• The service VLAN can belong to only one ERP ring at a time. A maximum of four rings are allowed
per switch.
• The specified service VLAN ID must not participate in a Spanning Tree instance that is associated with
non-ERP VLANs. Ideally, change the Spanning Tree configuration for the VLAN ID prior to using
this command.
• An ERP ring port can belong to only one ERP ring at a time.

• An ERP type NNI-SVLAN binding must be created before establishing an ERP ring on that SVLAN-
NNI binding.

Examples
-> erp-ring 1 sub-ring-port 1/1/1 service-vlan 10 level 2 enable
-> erp-ring 2 sub-ring-port linkagg 1 port2 2/1/10 service-vlan 20 level 2
-> no erp-ring 2

Release History
Release 8.1.1; command introduced.

Related Commands

erp-ring Creates an Ethernet Ring Protection (ERP) ring.

show erp Displays the ERP ring configuration for the switch.
show erp statistics Displays ERP ring statistics.
ethernet-service svlan nni Creates a NNI-SVLAN binding.

MIB Objects
alaErpRingTable
alaErpRingId
alaErpRingServiceVid
alaErpRingMEGLevel
alaErpRingStatus
alaErpRingPort1
alaErpRingPort2
alaErpRingWaitToRestore
alaErpRingGuardTimer
alaErpRingRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 12-11
erp-ring virtual-channel Ethernet Ring Protection Commands

erp-ring virtual-channel
Enables or disables an Ethernet Ring Protection (ERP) Ring Virtual Channel.
erp-ring ring_id virtual-channel [enable | disable]

Syntax Definitions

ring_id The ERP ring ID number. The valid range is 1 to 2147483647.

enable Administratively enables the ERP virtual channel. If enabled, Ring
Automatic Protection Switching (R-APS) protocol messages are
encapsulated and transmitted over a virtual channel configured on the
major ring.
disable Administratively disables the ERP virtual channel. If disabled, R-APS
messages are terminated at the interconnection nodes between the rings
but not blocked at the Ring Protection Link (RPL) of the sub-ring.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The specified ring identification number must be unique within a switch.

• The ring identified by Ring ID must be created before configuring the virtual channel state for ring
node.

Examples
-> erp-ring 2 virtual-channel disable
-> erp-ring 1 virtual-channel enable

Release History
Release 8.1.1; command introduced.

page 12-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Ring Protection Commands erp-ring virtual-channel

Related Commands

erp-ring Creates an Ethernet Ring Protection (ERP) ring.

erp-ring sub-ring Creates an Ethernet Ring Protection (ERP) ring sub ring.
show erp Displays the ERP ring configuration for the switch.
show erp statistics Displays ERP ring statistics.

MIB Objects
alaErpRingTable
alaErpRingId
alaErpRingVirtualChannel

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 12-13
erp-ring revertive Ethernet Ring Protection Commands

erp-ring revertive
Enables or Disables revertive mode on the specified node.
erp-ring ring_id revertive [enable | disable]

Syntax Definitions

ring_id The ERP ring ID number. The valid range is 1 to 2147483647.

enable Administratively enables Revertive Mode. Now, if the RPL is
unblocked due to a failure within the ring, the RPL automatically reverts
to the “Blocked” state when the failed link recovers.
disable Administratively Disables Revertive Mode. Now, if the RPL is
unblocked due to a failure within the ring, the RPL does not
automatically revert to “Blocked” state when the failed link recovers.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The specified ring identification number must be unique within a switch.

• The ring identified by the Ring ID must be created using the erp-ring command, before configuring
the revertive mode for ring node.

Examples
-> erp-ring 1 revertive enable
-> erp-ring 2 revertive disable

Release History
Release 8.1.1; command introduced.

page 12-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Ring Protection Commands erp-ring revertive

Related Commands

erp-ring Creates an Ethernet Ring Protection (ERP) ring.

erp-ring sub-ring Creates an Ethernet Ring Protection (ERP) ring sub ring.
erp-ring clear Clears any pending state (for example, non-revertive restoring).
show erp Displays the ERP ring configuration for the switch.
show erp statistics Displays ERP ring statistics.

MIB Objects
alaErpRingTable
alaErpRingId
alaErpRingRevertive

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 12-15
erp-ring clear Ethernet Ring Protection Commands

erp-ring clear
Clears any pending state (for example, non-revertive restoring).
erp-ring ring_id clear

Syntax Definitions

ring_id The ERP ring ID number. The valid range is 1 to 2147483647.

clear Clears any pending state on the ring.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The specified ring identification number must be unique within a switch.

Examples
-> erp-ring 1 clear

Release History
Release 8.1.1; command introduced.

Related Commands

erp-ring Creates an Ethernet Ring Protection (ERP) ring.

erp-ring sub-ring Creates an Ethernet Ring Protection (ERP) ring sub ring.
show erp Displays the ERP ring configuration for the switch.
show erp statistics Displays ERP ring statistics.

MIB Objects
alaErpRingTable
alaErpRingId
alaErpRingClearAction

page 12-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Ring Protection Commands erp-ring ethoam-event

erp-ring ethoam-event
Configures a ring port to accept a “loss of connectivity” event from Ethernet OAM for a remote endpoint.
erp-ring ring_id ethoam-event {chassis/slot/port | linkagg agg_num} remote-endpoint mep_id
no erp-ring ring_id ethoam-event {chassis/slot/port | linkagg agg_num}

Syntax Definitions

ring_id The ERP ring ID number. The valid range is 1 to 2147483647.

chassis The chassis identifier.
slot/port The slot number for the module and the physical port number on that
module.
agg_num The link aggregate ID number.
mep_id The remote endpoint ID.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The specified ring identification number must be unique within a switch.

Examples
-> erp-ring 1 ethoam-event 1/1/1 remote-endpoint 10
-> erp-ring 1 ethoam-event linkagg 1 remote-endpoint 10

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 12-17
erp-ring ethoam-event Ethernet Ring Protection Commands

Related Commands

erp-ring Creates an Ethernet Ring Protection (ERP) ring.

erp-ring sub-ring Creates an Ethernet Ring Protection (ERP) ring sub ring.
show erp Displays the ERP ring configuration for the switch.
show erp statistics Displays ERP ring statistics.

MIB Objects
alaErpRingTable
alaErpRingId
alaErpRingPortIfIndex
alaErpRingPortEthOAMEvent
alaErpRingPortRmepId

page 12-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Ring Protection Commands clear erp statistics

clear erp statistics

Clears ERP statistics for all rings, a specific ring, or a specific ring port.
clear erp statistics [ring ring_id [port chassis/slot/port | linkagg agg_num]]

Syntax Definitions

ring_id An existing ERP ring ID number. The valid range is 1 to 2147483647.

chassis The chassis identifier.
slot/port The slot number for the module and the physical port number on that
module.
agg_num The link aggregate ID number.

Defaults
By default, statistics are cleared for all ERP rings in the switch configuration.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enter a ring ID to clear the statistics for a specific ring.

• Enter a ring ID and a ring port number or link aggregate ID to clear the statistics for a specific port or
link aggregate.
• The specified ring ID must exist in the switch configuration.

• The specified port must belong to the ring identified by the ring ID.

Examples
-> clear erp statistics
-> clear erp statistics ring 5
-> clear erp statistics ring 5 port 1/1/2
-> clear erp statistics ring 5 linkagg 10

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 12-19
clear erp statistics Ethernet Ring Protection Commands

Related Commands

erp-ring Configures an ERP ring.

show erp Displays the ERP ring configuration for the switch.
show erp statistics Displays ERP ring statistics.

MIB Objects
alaErpClearStats
alaErpRingTable
alaErpRingId
alaErpRingClearStats
alaErpRingPortTable
alaErpRingPortIfIndex
alaErpRingPortClearStats

page 12-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Ring Protection Commands show erp

show erp
Displays the ERP configuration information for all rings, a specific ring, or for a specific ring port.
show erp [ring ring_id | [port chassis/slot/port | linkagg agg_num]]

Syntax Definitions

ring_id An existing ERP ring ID number. The valid range is 1 to 2147483647.

chassis The chassis identifier.
slot/port The slot number for the module and the physical port number on that
module.
agg_num The link aggregate ID number.

Defaults
By default, configuration information is displayed for all ERP rings in the switch configuration.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enter a ring ID to display the configuration for a specific ring.

• Enter a ring port number or a link aggregate ID to display the configuration for a specific port or link
aggregate.
• The specified ring ID must exist in the switch configuration.

Examples
-> show erp
Legends: * to Inactive Configuration
WTR to Wait To Restore
MEG to Maintenance Entity Group

Ring Ring Ring Ring

Serv WTR Guard MEG Ring Ring
ID Port1 Port2 Status
VLAN Timer Timer Level State Node
(min) (csec)
------+------+------+---------+----+-----+-----+-----+-----------+--------
1 1/1/15 1/1/1 enabled 4094 3 50 2 idle rpl
2 6/1/7 4/1/1 enabled 4093 1 50 1 idle rpl
3 4/1/7 6/1/1 enabled 4092 1 50 3 idle rpl
4 4/1/8 6/1/23 enabled 4091 5 50 4 idle non-rpl

Total number of rings configured = 4

-> show erp ring 1

Legend: * to Inactive Configuration

Ring Id : 1,

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 12-21
show erp Ethernet Ring Protection Commands

Ring Port1 : 1/1/15,

Ring Port2 : 1/1/1,
Ring Status : enabled,
Service VLAN : 4094,
WTR Timer (min) : 3,
Guard Timer (centi-sec) : 50,
MEG Level : 2,
Ring State : idle,
Ring Node Type : rpl,
RPL Port : 1/1/1,
Last State Change : SUN DEC 25 06:50:17 2016 (sysUpTime 00h:01m:31s

output definitions
Ring ID The ERP ring ID number.
Ring Ports The slot and port number of the ring ports.
Ring Status The ring status (enabled or disabled).
Service VLAN The Service VLAN ID.
WTR Timer The wait-to-restore timer value in minutes for RPL node.
Guard Timer The guard timer value in centi-secs for the ring node.
MEG Level The Service VLAN Management Entity Group (MEG) level.
Ring State Indicates the state of the ring.
Ring Node Type Indicates the type of the ring node.
Last State Change Indicates the time when the last state change occurred.

-> show erp port 1/1/15

Legend: * to Inactive Configuration

Ring-Id : 1
Ring Port Status : forwarding,
Ring Port Type : non-rpl,
Ethoam Event : disabled

-> show erp port 1/1/1

Legend: * to Inactive Configuration

Ring Id : 1
Ring Port Status : blocking,
Rint Port Type : RPL,
Ethoam Event : enabled,
Rmepid : 10

output definitions
Ring ID The ERP ring ID number.
Ring Port Status The status of the ring port (blocking or forwarding).
Ring Port Type The type of ring port (RPL or non-RPL).

page 12-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Ring Protection Commands show erp

output definitions (continued)

Ethoam Event Indicates whether or not the ring port will accept Ethernet OAM loss of
connectivity events (enabled or disabled).
Rmepid The remote Ethernet OAM MEP ID number from which this port
accepts loss of connectivity events. This field displays only when the
ring port is configured to receive such events.

Release History
Release 8.1.1; command introduced.

Related Commands

show erp statistics Displays ERP ring statistics.

MIB Objects
alaErpRingId
alaErpRingStatus
alaErpRingServiceVid
alaErpRingMEGLevel
alaErpRingPort1
alaErpRingPort2
alaErpRingPortIfIndex
alaErpRingState
alaErpRingPortStatus
alaErpRingPortType
alaErpRingPortEthOAMEvent
alaErpRingPortRmepId
alaErpRingWaitToRestoreTimer
alaErpRingGuardTimer
alaErpRingLastStateChange
alaErpRingTimeToRevert

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 12-23
show erp statistics Ethernet Ring Protection Commands

show erp statistics

Displays the ERP statistics for all rings, a specific ring, or a specific ring port.
show erp statistics [ring ring_id [port chassis/slot/port | linkagg agg_num]]

Syntax Definitions

ring_id An existing ERP ring ID number. The valid range is 1 to 2147483647.

chassis The chassis identifier.
slot/port The slot number for the module and the physical port number on that
module.
agg_num The link aggregate ID number.

Defaults
By default, statistics are displayed for all ERP rings in the switch configuration.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enter a ring ID to display the statistics for a specific ring.

• Enter a ring ID and a ring port number or link aggregate ID to display the statistics for a specific port or
link aggregate.
• The specified ring ID must exist in the switch configuration.

• The specified port must belong to the ring identified by the ring ID.

Examples
-> show erp statistics
Legends: R-APS to Ring Automatic Protection Switching
RPL to Ring Protection Link

Ring-Id : 1
Ring Port : 1/1/15
Signal Fail PDUs
Sent : 3,
Recv : 0,
Drop : 0
No Request PDUs
Sent : 37,
Recv : 37,
Drop : 0
No Request RPL Block PDUs
Sent : 4322,
Recv : 0,
Drop : 0

page 12-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Ring Protection Commands show erp statistics

Invalid R-APS PDUs

Recv : 0

Ring Port : 1/1/1

Signal Fail PDUs
Sent : 6,
Recv : 0,
Drop : 0
No Request PDUs
Sent : 37,
Recv : 38,
Drop : 0
No Request RPL Block PDUs
Sent : 4322,
Recv : 0,
Drop : 0
Invalid R-APS PDUs
Recv : 0

Ring-Id : 2
Ring Port : 6/1/7
Signal Fail PDUs
Sent : 6,
Recv : 0,
Drop : 0
No Request PDUs
Sent : 16,
Recv : 14,
Drop : 0
No Request RPL Block PDUs
Sent : 4347,
Recv : 0,
Drop : 4341
Invalid R-APS PDUs
Recv : 0

-> show erp statistics ring 3

Legends: R-APS to Ring Automatic Protection Switching
RPL to Ring Protection Link

Ring-Id : 3
Ring Port : 4/1/7
Signal Fail PDUs
Sent : 6,
Recv : 0,
Drop : 0
No Request PDUs
Sent : 16,
Recv : 14,
Drop : 0
No Request RPL Block PDUs
Sent : 4351,
Recv : 0,
Drop : 0
Invalid R-APS PDUs
Recv : 0

Ring Port : 6/1/1

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 12-25
show erp statistics Ethernet Ring Protection Commands

Signal Fail PDUs

Sent : 6,
Recv : 0,
Drop : 0
No Request PDUs
Sent : 13,
Recv : 13,
Drop : 0
No Request RPL Block PDUs
Sent : 4358,
Recv : 0,
Drop : 0
Invalid R-APS PDUs
Recv : 0

-> show erp statistics ring 1 port 1/1/15

Legends: R-APS to Ring Automatic Protection Switching
RPL to Ring Protection Link

Ring-Id : 1
Ring Port : 1/1/15
Signal Fail PDUs
Sent : 3,
Recv : 0,
Drop : 0
No Request PDUs
Sent : 37,
Recv : 37,
Drop : 0
No Request RPL Block PDUs
Sent : 4338,
Recv : 0,
Drop : 0
Invalid R-APS PDUs
Recv: 0

output definitions
Ring ID The ERP ring ID number.
Ring Port The slot and port number of the ring port.
R-APS The type of Ring Automatic Switching Protocol (R-APS) event
message (NR = no request, RB = RPL is blocked, SF = signal failure).
APS is the protocol ERP uses to monitor and control ring links.
Send Total number of R-APS messages sent.
Recv Total number of R-APS messages received.
Drop Total number of R-APS messages dropped.

Release History
Release 8.1.1; command introduced.

page 12-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet Ring Protection Commands show erp statistics

Related Commands

show erp Displays the ERP ring configuration for the switch.
clear erp statistics Clears ERP ring statistics.

MIB Objects
alaERPClearStats
alaERPRingClearStats
alaErpRingPortClearStats
alaErpRingId
alaErpRingPortIfIndex
alaErpStatsSignalFailPduTx
alaErpStatsSignalFailPduRx
alaErpStatsSignalFailPduDrop
alaErpStatsNoRequestPduTx
alaErpStatsNoRequestPduRx
alaErpStatsNoRequestPduDrop
alaErpStatsRPLBlockPDUTx
alaErpStatsRPLBlockPDURx
alaErpStatsRPLBlockPDUDrop
alaErpStatsPDUErr

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 12-27
show erp statistics Ethernet Ring Protection Commands

page 12-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 13 MVRP Commands

MVRP (Multiple VLAN Registration Protocol) provides a mechanism for maintaining the contents of
Dynamic VLAN Registration Entries for each VLAN, and for propagating the information they contain to
other Bridges. MVRP uses MRP (Multiple Registration Protocol) as the underlying mechanism, for the
maintenance and propagation of the VLAN information.
MVRP acts as an MRP application, sending and receiving MVRP information encapsulated in an Ethernet
frame on a specific MAC address. MVRP allows both end stations and Bridges in a Bridged Local Area
Network to issue and revoke declarations relating to membership of VLANs.
A summary of the available commands is listed here:

mvrp
mvrp port
mvrp maximum-vlan
mvrp registration
mvrp applicant
mvrp timer join
mvrp timer leave
mvrp timer leaveall
mvrp timer periodic-timer
mvrp periodic-transmission
mvrp restrict-vlan-registration
mvrp restrict-vlan-advertisement
mvrp static-vlan-restrict
show mvrp configuration
show mvrp port
show mvrp linkagg
show mvrp timer
show mvrp statistics
show mvrp last-pdu-origin
show mvrp vlan-restrictions
show mvrp vlan-restrictions
mvrp clear-statistics

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-1
mvrp MVRP Commands

mvrp
Enables or disables MVRP globally on the switch.
mvrp {enable | disable}

Syntax Definitions

enable Enables MVRP globally on the switch.

disable Disables MVRP globally on the switch.

Defaults
By default, MVRP is disabled on the switch.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Disabling MVRP globally deletes all the MVRP learned VLANs.

• MVRP is supported only when the switch is operating in the flat Spanning Tree mode and it is not
supported in the per-VLAN mode.

Examples
-> mvrp enable
-> mvrp disable

Release History
Release 8.1.1; command introduced.

Related Commands

show mvrp configuration Displays the global configuration for MVRP.

MIB Objects
alaMvrpGlobalStatus

page 13-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands mvrp port

mvrp port
Enables or disables MVRP on specific ports on the switch.
mvrp port chassis/slot/port [– port2] {enable | disable}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
enable Enables MVRP on a port.
disable Disables MVRP on a port.

Defaults
By default, MVRP is disabled on all the ports.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• MVRP can be enabled on switch ports regardless of whether it is globally enabled on the switch.
However, for the port to become an active participant in the MVRP operation, MVRP must be enabled
globally on the switch.
• When MVRP is globally enabled on the switch and is not enabled on the port, that port is excluded
from the MVRP protocol operation.
• MVRP can be enabled only on fixed ports, 802.1 Q ports, aggregate ports, and VLAN Stacking
Network ports. Other ports (mirroring ports, aggregable ports, VLAN Stacking User ports) do not
support MVRP.

Examples
-> mvrp port 1/1/2 enable
-> mvrp port 1/1/2 disable
-> mvrp port 1/1/1-10 enable
-> mvrp port 1/1/1-10 disable

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-3
mvrp port MVRP Commands

Related Commands

show mvrp port Displays the MVRP configurations for all the ports, including timer
values, registration and applicant modes.
show mvrp statistics Displays the MVRP statistics for all the ports, aggregates, or specific
ports.

MIB Objects
alaMvrpPortConfigTable
alaMvrpPortStatus

page 13-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands mvrp linkagg

mvrp linkagg
Enables or disables MVRP on specific aggregates on the switch.
mvrp linkagg agg_id[-agg_id2] {enable | disable}

Syntax Definitions

agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
enable Enables MVRP on a port.
disable Disables MVRP on a port.

Defaults
By default, mvrp is disabled on all the ports.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• MVRP can be enabled on switch ports regardless of whether it is globally enabled on the switch.
However, for the port to become an active participant in the MVRP operation, MVRP must be enabled
globally on the switch.
• When MVRP is globally enabled on the switch and is not enabled on the port, that port is excluded
from the MVRP protocol operation.
• MVRP can be enabled only on fixed ports, 802.1 Q ports, aggregate ports, and VLAN Stacking
Network ports. Other ports (mirroring ports, aggregable ports, mobile ports, VPLS Access ports,
VLAN Stacking User ports) do not support MVRP.
• To use the agg_id parameter, the link aggregate group must be created.

Examples
-> mvrp linkagg 10 enable
-> mvrp linkagg 10 disable
-> mvrp linkagg 2-5 enable
-> mvrp linkagg 1-5 disable

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-5
mvrp linkagg MVRP Commands

Related Commands

show mvrp port Displays the MVRP configurations for all the ports, including timer
values, registration and applicant modes.
show mvrp statistics Displays the MVRP statistics for all the ports, aggregates, or specific
ports.

MIB Objects
alaMvrpPortConfigTable
alaMvrpPortStatus

page 13-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands mvrp maximum-vlan

mvrp maximum-vlan
Configures the maximum number of dynamic VLANs that can be created by MVRP.
mvrp maximum-vlan vlan_limit

Syntax Definitions

vlan_limit The maximum number of VLANs to be created by MVRP. The valid

range is 32–4094.

Defaults
The default value is 256.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command can be used even when MVRP is not enabled on the switch. However, MVRP must be
enabled on the switch for creating dynamic VLANs.
• If the VLAN limit to be set is less than the current number of dynamically learnt VLANs, then the new
configuration takes effect only after the MVRP is disabled and re-enabled on the switch. The VLANs
learnt earlier are retained if this operation is not performed.

Examples
-> mvrp maximum-vlan 100

Release History
Release 8.1.1; command introduced.

Related Commands

show mvrp configuration Displays the global configuration for MVRP.

show mvrp vlan-restrictions Displays the list of VLANS learned through MVRP and their details.

MIB Objects
alaMvrpMaxVlanLimit

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-7
mvrp registration MVRP Commands

mvrp registration
Configures the MVRP registration mode for specific ports or aggregates.
mvrp {port chassis/slot/port[– port2] | linkagg agg_id [-agg_id2]} registration {normal | fixed |
forbidden}

Syntax Definitions

chassis/slot/port[– port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
normal Specifies that both registration and de-registration of VLANs are
allowed. VLANs can be mapped either dynamically (through MVRP) or
statically (through management application) on such a port.
fixed Specifies that only static mapping of VLANs is allowed on the port but
de-registration of previously created dynamic or static VLANs is not
allowed.
forbidden Specifies that dynamic VLAN registration or de-registration is not
allowed on the port. Any dynamic VLANs created earlier is de-
registered.

Defaults

parameter default
normal | fixed | forbidden normal

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
To use the agg_id parameter, the link aggregate group must be created and enabled.

Examples
-> mvrp port 1/1/2 registration forbidden
-> mvrp port 1/1/5 registration normal
-> mvrp linkagg 10 registration fixed
-> mvrp linkagg 20 registration forbidden
-> mvrp port 2/1/5-10 registration normal

Release History
Release 8.1.1; command introduced.

page 13-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands mvrp registration

Related Commands

show mvrp port Displays the MVRP configurations for all the ports, including timer
values, registration and applicant modes.
show mvrp linkagg Displays the MVRP configurations for all the link aggregates, including
timer values, registration and applicant modes.

MIB Objects
alaMvrpPortConfigTable
alaMvrpPortConfigRegistrarMode

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-9
mvrp applicant MVRP Commands

mvrp applicant
Configures the applicant mode of specific ports on the switch. The applicant mode determines whether
MVRP PDU exchanges are allowed on a port depending on the Spanning Tree state of the port.
mvrp {port chassis/slot/port [– port2] | linkagg agg_id[-agg_id2]} applicant {participant | non-
participant | active}

Syntax Definitions

chassis/slot/port[– port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
participant Specifies that MVRP PDU exchanges are only allowed when the port is
in the STP forwarding state.
non-participant Specifies that MVRP PDU's are not sent in this mode and PDU's
received are processed and learning happens as expected.
active Specifies that MVRP PDU exchanges are allowed when the port is in
the STP forwarding state or STP blocking state. This is applicable for
both advertisement and registration.

Defaults

parameter default
participant | non-participant | active
active

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
To use the agg_id parameter, the link aggregate group must be created and enabled.

Examples
-> mvrp port 1/1/2 applicant active
-> mvrp port 1/1/3 applicant participant
-> mvrp port 1/1/4 applicant non-participant
-> mvrp linkagg 10 applicant active
-> mvrp linkagg 15-19 applicant participant
-> mvrp linkagg 20 applicant non-participant

Release History
Release 8.1.1; command introduced.

page 13-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands mvrp applicant

Related Commands

show mvrp port Displays the MVRP configurations for all the ports, including timer
values, registration and applicant modes.
show mvrp linkagg Displays the MVRP configurations for all the link aggregates, including
timer values, registration and applicant modes.

MIB Objects
alaMvrpPortConfigtable
alaMvrpPortConfigApplicantMode

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-11
mvrp timer join MVRP Commands

mvrp timer join

Specifies the join time interval between transmit opportunities for the dynamically registering VLANs on
the switch.
mvrp {port chassis/slot/port[– port2] | linkagg agg_id[-agg_id2]} timer join timer-value

Syntax Definitions

chassis/slot/port[– port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
timer-value Specifies the value of the join timer in milliseconds. The valid range is
250 milliseconds to 1073741773 milliseconds.

Defaults

parameter default
timer-value 600 milliseconds

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use default timer settings unless there is a compelling reason to change the settings. Modifying timers
to inappropriate values can cause an imbalance in the operation of MVRP.
• To use the agg_id parameter, the link aggregate group must be created and enabled.

Examples
-> mvrp port 1/1/2 timer join 600
-> mvrp port 1/1/2-12 timer join 600
-> mvrp linkagg 3 timer join 600
-> mvrp linkagg 3-6 timer join 600

Release History
Release 8.1.1; command introduced.

page 13-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands mvrp timer join

Related Commands

show mvrp timer Displays the timer values configured for all the ports or a specific port.
show mvrp port Displays the MVRP configurations for all the ports, including timer
values, registration and applicant modes.

MIB Objects
alaMvrpPortConfigTable
alaMvrpPortConfigJoinTimer
alaMvrpPortConfigLeaveTimer
alaMvrpPortConfigLeaveAllTimer
alaMvrpPortConfigPeriodicTimer

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-13
mvrp timer leave MVRP Commands

mvrp timer leave

Specifies the period of time that the switch has to wait in the Leave state before changing to the
unregistered state.
mvrp {port chassis/slot/port [– port2] | linkagg agg_id[-agg_id2]} timer leave timer-value

Syntax Definitions

chassis/slot/port[– port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
timer-value Specifies the value of the Leave Timer in milliseconds. The valid range
is 750 milliseconds to 2147483647 milliseconds.

Defaults]

parameter default
timer-value 1800 milliseconds

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use default timer settings unless there is a compelling reason to change the settings. Modifying timers
to inappropriate values can cause an imbalance in the operation of MVRP.
• Leave timer value must be greater than or equal to twice the Join timer value, plus six times the timer
resolution (16.66 milliseconds). Leave timer must be at least be greater than twice the join timer
plus100 milliseconds.
• To use the agg_id parameter, the link aggregate group must be created and enabled.

Examples
-> mvrp port 1/1/2 timer leave 1800
-> mvrp port 1/1/2-12 timer leave 1800
-> mvrp linkagg 3 timer leave 1800
-> mvrp linkagg 3-6 timer leave 1800

Release History
Release 8.1.1; command introduced.

page 13-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands mvrp timer leave

Related Commands

show mvrp timer Displays the timer values configured for all the ports or a specific port.
show mvrp port Displays the MVRP configurations for all the ports, including timer
values, registration and applicant modes.

MIB Objects
alaMvrpPortConfigTable
alaMvrpPortConfigJoinTimer
alaMvrpPortConfigLeaveTimer
alaMvrpPortConfigLeaveAllTimer
alaMvrpPortConfigPeriodicTime

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-15
mvrp timer leaveall MVRP Commands

mvrp timer leaveall

Specifies the frequency with which the LeaveAll messages are communicated.
mvrp {port chassis/slot/port [– port2] | linkagg agg_id[-agg_id2]} timer leaveall timer-value

Syntax Definitions

chassis/slot/port[– port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
timer-value Specifies the value of the LeaveAll Timer in milliseconds. The valid
range is 750 milliseconds to 2147483647 milliseconds.

Defaults

parameter default
timer-value 30000 milliseconds

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use default timer settings unless there is a compelling reason to change the settings. Modifying timers
to inappropriate values can cause an imbalance in the operation of MVRP.
• Leaveall timer value must be greater than or equal to the Leave timer value. It is recommended to have
the leaveall timer 15 times greater than the leave timer.
• To use the agg_id parameter, the link aggregate group must be created and enabled.

Examples
-> mvrp port 1/1/2 timer leaveall 30000
-> mvrp port 1/1/2-12 timer leaveall 30000
-> mvrp linkagg 3 timer leaveall 30000
-> mvrp linkagg 3-6 timer leaveall 30000

Release History
Release 8.1.1; command introduced.

page 13-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands mvrp timer leaveall

Related Commands

show mvrp timer Displays the timer values configured for all the ports or a specific port.
show mvrp port Displays the MVRP configurations for all the ports, including timer
values, registration and applicant modes.

MIB Objects
alaMvrpPortConfigTable
alaMvrpPortConfigJoinTimer
alaMvrpPortConfigLeaveTimer
alaMvrpPortConfigLeaveAllTimer
alaMvrpPortConfigPeriodicTimer

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-17
mvrp timer periodic-timer MVRP Commands

mvrp timer periodic-timer

Specifies the MVRP periodic-timer time interval for the dynamically registering VLANs on the switch.
mvrp {port chassis/slot/port [– port2] | linkagg agg_id[-agg_id2]} timer periodic-timer
timer-value

Syntax Definitions

chassis/slot/port[– port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
timer-value Specifies the value of the Periodic Timer in seconds. The valid range is
between 1 to 2147483647 milliseconds.

Defaults

parameter default
timer-value 1 second

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use default timer settings unless there is a compelling reason to change the settings. Modifying timers
to inappropriate values can cause an imbalance in the operation of MVRP.
• To use the agg_id parameter, the link aggregate group must be created and enabled.

Examples
-> mvrp port 1/1/2 timer periodic-timer 1
-> mvrp port 1/1/2 timer periodic-timer 1
-> mvrp linkagg 3 timer periodic-timer 1
-> mvrp linkagg 3-6 timer periodic-timer 1

Release History
Release 8.1.1; command introduced.

page 13-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands mvrp timer periodic-timer

Related Commands

show mvrp timer Displays the timer values configured for all the ports or a specific port.
show mvrp port Displays the MVRP configurations for all the ports, including timer
values, registration and applicant modes.

MIB Objects
alaMvrpPortConfigTable
alaMvrpPortConfigJoinTimer
alaMvrpPortConfigLeaveTimer
alaMvrpPortConfigLeaveAllTimer
alaMvrpPortConfigPeriodicTimer

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-19
mvrp periodic-transmission MVRP Commands

mvrp periodic-transmission
Enables the periodic transmission status on a port or aggregate of ports.
mvrp {port chassis/slot/port[– port2] | linkagg agg_id[-agg_id2]} periodic-transmission
{enable|disable}

Syntax Definitions

chassis/slot/port[– port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
enable Enables periodic transmission status on a port.
disable Disables periodic transmission status on a port.

Defaults
By default, periodic-transmission status is disabled on all the ports.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
To use the agg_id parameter, the link aggregate group must be created and enabled.

Examples
-> mvrp port 1/1/2 periodic-transmission enable
-> mvrp port 1/1/2 periodic-transmission disable
-> mvrp linkagg 10 periodic-transmission enable
-> mvrp linkagg 10 periodic-transmission disable

Release History
Release 8.1.1; command introduced.

Related Commands

show mvrp port Displays the MVRP configurations for all the ports, including timer
values, registration and applicant modes.
show mvrp linkagg Displays the MVRP configurations for all link aggregates, including
timer values, registration and applicant modes.

MIB Objects
alaMvrpPortConfigTable
alaMvrpPortConfigPeriodicTransmissionStatus

page 13-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands mvrp restrict-vlan-registration

mvrp restrict-vlan-registration
Restricts MVRP processing from dynamically registering the specified VLAN or VLANs on the switch.
mvrp {port chassis/slot/port[– port2] | linkagg agg_id[-agg_id2]} restrict-vlan-registration vlan
vlan_list
no mvrp {port chassis/slot/port[– port2] | linkagg agg_id[-agg_id2]} restrict-vlan-registration vlan
vlan_list

Syntax Definitions

chassis/slot/port[– port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
vlan_list The VLAN ID or the VLAN ID range (for example, 1-10).

Defaults
By default, MVRP dynamic VLAN registrations are not restricted.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to allow registration of dynamic VLAN IDs through MVRP
processing.
• If the specified VLAN exists on the switch, the VLAN is mapped to the receiving port.

• To use the agg_id parameter, the link aggregate group must be created and enabled.

Examples
-> mvrp port 1/1/2 restrict-vlan-registration vlan 5
-> no mvrp port 1/1/2 restrict-vlan-registration vlan 5
-> mvrp linkagg 10 restrict-vlan-registration vlan 6-10
-> no mvrp port 3/1/1 restrict-vlan-registration vlan 6-10

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-21
mvrp restrict-vlan-registration MVRP Commands

Related Commands

show mvrp port Displays the MVRP configurations for all the ports, including timer
values, registration and applicant modes.
show mvrp linkagg Displays the MVRP configurations for all link aggregates, including
timer values, registration and applicant modes.

MIB Objects
alaMvrpPortRestrictVlanConfigTable
alaMvrpPortRestrictRowStatus
alaMvrpPortRestrictVlanAttributeType
alaMvrpPortRestrictVlanID

page 13-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands mvrp restrict-vlan-advertisement

mvrp restrict-vlan-advertisement
Restricts the advertisement of VLANs on a specific port or an aggregate of ports.
mvrp {port chassis/slot/port[–port2] | linkagg agg_id[-agg_id2]} restrict-vlan-advertisement vlan
vlan_list
no mvrp {port chassis/slot/port[–port2] | linkagg agg_id[-agg_id2]} restrict-vlan-advertisement vlan
vlan_list

Syntax Definitions

chassis/slot/port[– port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
vlan_list The list of VLAN IDs or the VLAN ID range (for example, 1-10).

Defaults
By default, MVRP VLAN advertisement is not restricted.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command affects the MVRP processing only if the applicant mode is set to participant or active.

• Use the no form of this command to allow the propagation of VLANs.

• To use the agg_id parameter, the link aggregate group must be created and enabled.

Examples
-> mvrp port 1/1/2 restrict-vlan-advertisement vlan 5
-> no mvrp port 1/1/2 restrict-vlan-advertisement vlan 5
-> mvrp linkagg 10 restrict-vlan-advertisement vlan 6-10
-> no mvrp port 1/1/2 restrict-vlan-advertisement vlan 6-10
-> no mvrp port 1/1/1-2 restrict-vlan-advertisement vlan 6-10

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-23
mvrp restrict-vlan-advertisement MVRP Commands

Related Commands

mvrp applicant Configures the applicant mode of specific ports on the switch. The
applicant mode determines whether MVRP PDU exchanges are allowed
on a port depending on the Spanning Tree state of the port.
mvrp timer join Configures the applicant mode of specific link aggregates on the switch.
The applicant mode determines whether MVRP PDU exchanges are
allowed on a port depending on the Spanning Tree state of the port.
show mvrp port Displays the MVRP configurations for all the ports, including timer
values, registration and applicant modes.
show mvrp linkagg Displays the MVRP configurations for all the link aggregates, including
timer values, registration and applicant modes.

MIB Objects
alaMvrpPortRestrictVlanConfigTable
alaMvrpPortRestrictRowStatus
alaMvrpPortRestrictVlanAttributeType
alaMvrpPortRestrictVlanID

page 13-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands mvrp static-vlan-restrict

mvrp static-vlan-restrict
Restricts a port from becoming a member of a statically created VLAN or a range of VLANs.
mvrp {port chassis/slot/port[– port2] | linkagg agg_id[-agg_id2]} static-vlan-restrict vlan vlan_list
no mvrp {port chassis/slot/port[– port2] | linkagg agg_id[-agg_id2]} static-vlan-restrict vlan vlan_list

Syntax Definitions

chassis/slot/port[– port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
vlan_list The list of VLAN IDs or the VLAN ID range (for example, 1-10).

Defaults
By default, ports are assigned to the static VLAN based on MVRP PDU processing.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command applies only to static VLANs and does not apply to dynamic VLANs.

• Use the no form of this command to set the specified port and VLAN to the default value.

Examples
-> mvrp port 1/1/2 static-vlan-restrict vlan 5
-> no mvrp port 1/1/2 static-vlan-restrict vlan 5
-> mvrp port 1/1/2 static-vlan-restrict vlan 6-9
-> no mvrp port 1/1/2 static-vlan-restrict vlan 6-9
-> mvrp linkagg 3 static-vlan-restrict vlan 4-5
-> no mvrp linkagg 3 static-vlan-restrict aggregate vlan 4-5

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-25
mvrp static-vlan-restrict MVRP Commands

Related Commands

show mvrp port Displays the MVRP configurations for all the ports, including timer
values, registration and applicant modes.
show mvrp linkagg Displays the MVRP configurations for all the link aggregates, including
timer values, registration and applicant modes.

MIB Objects
alaMvrpPortRestrictVlanConfigTable
alaMvrpPortRestrictRowStatus
alaMvrpPortRestrictVlanAttributeType
alaMvrpPortRestrictVlanID
alaMvrpPortConfigRegistrationToStaticVlan
alaMvrpPortConfigRegistrationToStaticVlanLearn
alaMvrpPortConfigRegistrationToStaticVlanRestrict

page 13-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands show mvrp configuration

show mvrp configuration

Displays the global configuration for MVRP.
show mvrp configuration

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show mvrp configuration
MVRP Enabled : yes,
Maximum VLAN Limit : 256

output definitions
MVRP Enabled Indicates whether MVRP is globally enabled.
Maximum VLAN Limit The maximum number of VLANs that can be learned by MVRP in the
system.

Release History
Release 8.1.1; command introduced.

Related Commands

mvrp Enables or disables MVRP globally on the switch.

mvrp maximum-vlan Configures the maximum number of dynamic VLANs that can be
created by MVRP.

MIB Objects
alaMvrpGlobalStatus
alaMvrpMaxVlanLimit

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-27
show mvrp port MVRP Commands

show mvrp port

Displays the MVRP configurations for all the ports, including timer values, registration and applicant
modes.
show mvrp port {chassis/slot/port[-port2]} [enable | disable]

Syntax Definitions

chassis/slot/port[– port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
enable To display only the enabled ports.
disable To display only the disabled ports.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show mvrp port enable

Port Join Leave LeaveAll Periodic Registration Applicant Periodic Tx

Timer Timer Timer Timer Mode Mode Status
(msec) (msec) (msec) (sec)
----+--------+---------------+--------+----------+---------+------------
1/1/1 600 1800 30000 2 fixed active enabled
1/1/2 600 1800 30000 2 fixed active enabled
1/1/7 600 1800 30000 2 fixed active enabled
1/1/8 600 1800 30000 2 fixed active enabled
2/1/24 600 1800 30000 2 fixed active enabled

-> show mvrp port disable

Port Join Leave LeaveAll Periodic Registration Applicant Periodic Tx
Timer Timer Timer Timer Mode Mode Status
(msec) (msec) (msec) (sec)
----+--------+--------------+--------+----------+---------+------------
1/1/9 600 1800 30000 2 fixed active enabled
1/1/10 600 1800 30000 2 fixed active enabled
2/1/1 600 1800 30000 2 fixed active enabled
2/1/2 600 1800 30000 2 fixed active enabled
….
2/1/24 600 1800 30000 2 fixed active enabled

page 13-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands show mvrp port

-> show mvrp port

Port Status Join Leave LeaveAll Periodic Registration Applicant Periodic

Timer Timer Timer Timer Mode Mode Tx Status
(msec) (msec) (msec) (sec)
----+---------+------+------+--------+-------+-------------+-----------+--------
1/1/1 disabled 600 1800 30000 2 fixed participant enabled
1/1/2 enabled 600 1800 30000 2 fixed participant enabled
1/1/3 enabled 600 1800 30000 2 fixed active enabled
1/1/4 enabled 600 1800 30000 2 fixed active enabled
2/1/24 enabled 600 1800 30000 2 fixed active enabled

-> show mvrp port 1/1-3

Port Status Join Leave LeaveAll Periodic Registration Applicant Periodic

Timer Timer Timer Timer Mode Mode Tx Status
(msec) (msec) (msec) (sec)
----+---------+------+------+--------+-------+-------------+-----------+--------
1/1/1 disabled 600 1800 30000 2 fixed participant enabled
1/1/2 enabled 600 1800 30000 2 fixed participant enabled
1/1/3 enabled 600 1800 30000 2 fixed participant enabled

-> show mvrp port 1/1/1

MVRP Enabled : no,

Registrar Mode : normal,
Applicant Mode : participant,
Join Timer (msec) : 600,
Leave Timer (msec) : 1800,
LeaveAll Timer (msec) : 30000,
Periodic Timer (sec) : 1,
Periodic Tx Status : enabled

-> show mvrp port 1/1/1 enable

ERROR: MVRP is disabled on port 1/1/1

output definitions
Port Displays the slot and port number.
Join Timer Displays the value of Join Timer in milliseconds.
Leave Timer Displays the value of the Leave Timer in milliseconds.
LeaveAll Timer Displays the value of the LeaveAll Timer in milliseconds.
Periodic Timer Displays the value of the Periodic Timer in seconds.
Periodic Tx Status The transmission status of MVRP (enable or disable).

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-29
show mvrp port MVRP Commands

Related Commands

mvrp port Enables or disables MVRP on specific ports on the switch.

mvrp Configures VLAN dynamic registration mode to MVRP and deletes all
static configuration of previous mode along with the dynamic data.

MIB Objects
alaMvrpPortConfigTable
alaMvrpPortStatus
alaMvrpPortConfigRegistrarMode
alaMvrpPortConfigApplicantMode
alaMvrpPortConfigJoinTimer
alaMvrpPortConfigLeaveTimer
alaMvrpPortConfigLeaveAllTimer
alaMvrpPortConfigPeriodicTimer
alaMvrpPortConfigPeriodicTransmissionStatus

page 13-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands show mvrp linkagg

show mvrp linkagg

Displays the MVRP configurations for linkaggs, including timer values, registration and applicant modes.
show mvrp linkagg [agg_id[-agg_id2]} [enabled | disabled]

Syntax Definitions

agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
enabled To display only the enabled ports.
disabled To display only the disabled ports.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show mvrp linkagg 1-3

Port Status Join Leave LeaveAll Periodic Registration Applicant Periodic

Timer Timer Timer Timer Mode Mode Tx Status
(msec) (msec) (msec) (sec)
----+---------+------+------+--------+--------+------------+------------+-------
0/1 enabled 600 1800 30000 2 fixed participant enabled
0/2 enabled 600 1800 30000 2 fixed participant enabled
0/3 enabled 600 1800 30000 2 fixed participant enabled

-> show mvrp linkagg 1

MVRP Enabled : yes,

Registrar Mode : normal,
Applicant Mode : participant,
Join Timer (msec) : 600,
Leave Timer (msec) : 1800,
LeaveAll Timer (msec): 30000,
Periodic Timer (sec) : 1,
Periodic Tx Status: enabled

-> show mvrp linkagg 1 disable

ERROR: MVRP is enabled on linkagg 0/1

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-31
show mvrp linkagg MVRP Commands

Note. The command output shown below, the MVRP status is not displayed as the command is only
for enabled ports and link aggregates.

-> show mvrp linkagg 10 enable

Registrar Mode : normal,

Applicant Mode : participant,
Join Timer (msec) : 600,
Leave Timer (msec) : 1800,
LeaveAll Timer (msec) : 30000,
Periodic Timer (sec) : 1,
Periodic Tx status : disabled

output definitions
Port Displays the slot/port number.
Join Timer Displays the value of Join Timer in milliseconds.
Leave Timer Displays the value of the Leave Timer in milliseconds.
LeaveAll Timer Displays the value of the LeaveAll Timer in milliseconds.
Periodic Timer Displays the value of the Periodic Timer in seconds.
Periodic Tx Status The transmission status of MVRP (enable or disable).

Release History
Release 8.1.1; command introduced.

Related Commands

mvrp port Enables or disables MVRP on specific ports on the switch.

MIB Objects
alaMvrpPortConfigTable
alaMvrpPortStatus
alaMvrpPortConfigRegistrarMode
alaMvrpPortConfigApplicantMode
alaMvrpPortConfigJoinTimer
alaMvrpPortConfigLeaveTimer
alaMvrpPortConfigLeaveAllTimer
alaMvrpPortConfigPeriodicTimer
alaMvrpPortConfigPeriodicTransmissionStatus

page 13-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands show mvrp timer

show mvrp timer

Displays the timer values configured for all the ports or a specific port.
show mvrp {port chassis/slot/port[– port2] | linkagg agg_id[-agg_id2]} timer {join | leave | leaveall |
periodic-timer}

Syntax Definitions

chassis/slot/port[– port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
join To display only the join timer.
leave To display only the leave timer.
leaveall To display only the leaveall timer.
periodic-timer To display only the periodic-timer.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the join, leave, leaveall, or periodic-timer parameter with this command to view the specific
timer values configured on all the ports.
• Use the agg_id or chassis/slot/port parameter with this command to display the timer values config-
ured for a specific port.

Examples
-> show mvrp timer

Port Join Timer Leave Timer LeaveAll Timer Periodic Timer

(msec) (msec) (sec) (msec)
--------+--------------+--------------+---------------+----------------
1/1/1 600 1800 30000 2
1/1/2 600 1800 30000 5
1/1/3 600 1800 30000 1
1/1/4 600 1800 30000 1

-> show mvrp port 1/1/21 timer

Join Timer (msec) : 600,

Leave Timer (msec) : 1800,
LeaveAll Timer (msec) : 30000,
Periodic-Timer (sec) : 1

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-33
show mvrp timer MVRP Commands

-> show mvrp port 1/1/21 timer join

Join Timer (msec) : 600

-> show mvrp port 1/1/21 timer leave

Leave Timer (msec) : 1800

-> show mvrp port 1/1/21 timer leaveall

LeaveAll Timer (msec) : 30000

-> show mvrp port 1/1/21 timer periodic-timer

Periodic-Timer (sec) : 1

-> show mvrp timer join

Legend : All timer values are in milliseconds

Port Join Timer
--------+----------------
1/1/1 600
1/1/2 600
1/1/3 600

-> show mvrp timer leaveall

Legend : All timer values are in milliseconds

Port LeaveAll Timer
--------+----------------
1/1/1 1800
1/1/2 1800
1/1/3 1800

-> show mvrp timer leaveall

Legend : All timer values are in milliseconds

Port LeaveAll Timer
--------+----------------
1/1/1 30000
1/1/2 30000
1/1/3 30000

-> show mvrp timer periodic-timer

Port Periodic Timer

--------+----------------
1/1/1 1
1/1/2 1
1/1/3 1

output definitions
Port Displays the slot/port number.
Join Timer Displays the value of Join Timer in milliseconds.
Leave Timer Displays the value of the Leave Timer in milliseconds.

page 13-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands show mvrp timer

output definitions (continued)

LeaveAll Timer Displays the value of the LeaveAll Timer in milliseconds.
Periodic Timer Displays the value of the Periodic Timer in seconds.

Release History
Release 8.1.1; command introduced.

Related Commands

mvrp timer join Specifies the join time interval between transmit opportunities for the
dynamically registering VLANs on the switch.
mvrp timer leave Specifies the period of time that the switch has to wait in the Leave state
before changing to the unregistered state.
mvrp timer leaveall Specifies the frequency with which the LeaveAll messages are
communicated.
mvrp timer periodic-timer Specifies the MVRP periodic-timer time interval for the dynamically
registering VLANs on the switch.
show mvrp port Displays the MVRP configurations for all the ports, including timer
values, registration and applicant modes.

MIB Objects
alaMvrpPortConfigTable
alaMvrpPortConfigJoinTimer
alaMvrpPortConfigLeaveTimer
alaMvrpPortConfigLeaveAllTimer
alaMvrpPortConfigPeriodicTimer

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-35
show mvrp statistics MVRP Commands

show mvrp statistics

Displays the MVRP statistics for all the ports, aggregates, or specific ports.
show mvrp {port chassis/slot/port[– port2] | linkagg agg_id[-agg_id2] } statistics

Syntax Definitions

chassis/slot/port[– port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If no port or link aggregate is specified the MVRP statistics are displayed for all ports.

• Use the agg_id or chassis/slot/port parameter with this command to display the MVRP statistics for a
specific port.

Examples
-> show mvrp port 1/1/21 statistics

Port 1/1/21
New Received : 0,
Join In Received : 1526,
Join Empty Received : 8290,
Leave Received : 0,
In Received : 1,
Empty Received : 0,
Leave All Received : 283,
New Transmitted : 826,
Join In Transmitted : 1532,
Join Empty Transmitted : 39,
Leave Transmitted : 0,
In Transmitted : 0,
Empty Transmitted : 296,
LeaveAll Transmitted : 23,
Failed Registrations : 0,
Total Mrp PDU Received : 1160,
Total Mrp PDU Transmitted : 957,
Total Mrp Msgs Received : 10100,
Total Mrp Msgs Transmitted: 2693,
Invalid Msgs Received : 0

page 13-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands show mvrp statistics

-> show mvrp statistics

Port 1/1/1:
New Received : 0,
Join In Received : 1526,
Join Empty Received : 8290,
Leave Received : 0,
In Received : 1,
Empty Received : 0,
Leave All Received : 283,
New Transmitted : 826,
Join In Transmitted : 1532,
Join Empty Transmitted : 39,
Leave Transmitted : 0,
In Transmitted : 0,
Empty Transmitted : 296,
LeaveAll Transmitted : 23,
Failed Registrations : 0,
Total Mrp PDU Received : 1160,
Total Mrp PDU Transmitted : 957,
Total Mrp Msgs Received : 10100,
Total Mrp Msgs Transmitted: 2693,
Invalid Msgs Received : 0

Port 1/1/2:
New Received : 0,
Join In Received : 1526,
Join Empty Received : 8290,
Leave Received : 0,
In Received : 1,
Empty Received : 0,
Leave All Received : 283,
New Transmitted : 826,
Join In Transmitted : 1532,
Join Empty Transmitted : 39,
Leave Transmitted : 0,
In Transmitted : 0,
Empty Transmitted : 296,
LeaveAll Transmitted : 23,
Failed Registrations : 0,
Total Mrp PDU Received : 1160,
Total Mrp PDU Transmitted : 957,
Total Mrp Msgs Received : 10100,
Total Mrp Msgs Transmitted: 2693,
Invalid Msgs Received : 0

output definitions
New Received The number of new MVRP messages received on the switch.
Join In Received The number of MVRP Join In messages received on the switch
Join Empty Received The number of MVRP Join Empty messages received on the switch.
Leave In Received The number of MVRP Leave In messages received on the switch.
In Received The total MVRP messages received on the switch.
Empty Received The number of MVRP Empty messages received on the switch.
Leave All Received The number of MVRP Leave All messages received on the switch.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-37
show mvrp statistics MVRP Commands

output definitions (continued)

New Transmitted The number of new MVRP messages sent by the switch.
Join In Transmitted The number of MVRP Join In messages sent by the switch
Join Empty Transmitted The number of MVRP Join Empty messages sent by the switch.
Leave Transmitted The number of MVRP Leave messages sent by the switch.
In Transmitted The number of MVRP In messages sent by the switch.
Empty Transmitted The number of MVRP empty messages sent by the switch.
LeaveAll Transmitted The number of Leave All messages sent by the switch.
Failed Registrations The number of failed registrations.
Total Mrp PDU Received The number of total MRP PDUs received by the switch.
Total Mrp Msgs Received The number of total MRP messages received by the switch.
Total Mrp Msgs Transmitted The number of total MRP messages sent by the switch.
Invalid Msgs Received The number of invalid messages received by the switch.

Release History
Release 8.1.1; command introduced.

Related Commands

show mvrp configuration Clears MVRP statistics for all ports, an aggregate of ports, or a specific port.
show mvrp port Displays the MVRP configurations for all the ports, including timer values,
registration and applicant modes.
show mvrp linkagg Displays the MVRP configuration for a specific port or an aggregate of ports.

MIB Objects
alaMvrpPortStatsTable
alaMvrpPortStatsNewReceived
alaMvrpPortStatsJoinInReceived
alaMvrpPortStatsJoinEmptyReceived
alaMvrpPortStatsLeaveReceived
alaMvrpPortStatsInReceived
alaMvrpPortStatsEmptyReceived
alaMvrpPortStatsLeaveAllReceived
alaMvrpPortStatsNewTransmitted
alaMvrpPortStatsJoinInTransmitted
alaMvrpPortStatsJoinEmptyTransmitted
alaMvrpPortStatsLeaveTransmitted
alaMvrpPortStatsInTransmitted
alaMvrpPortStatsEmptyTransmitted
alaMvrpPortStatsLeaveAllTransmitted
alaMvrpPortStatsTotalPDUReceived
alaMvrpPortStatsTotalPDUTransmitted
alaMvrpPortStatsTotalMsgsReceived
alaMvrpPortStatsTotalMsgsTransmitted
alaMvrpPortStatsInvalidMsgsReceived
alaMvrpPortFailedRegistrations

page 13-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands show mvrp last-pdu-origin

show mvrp last-pdu-origin

Displays the source MAC address of the last MVRP message received on specific ports or aggregates.
show mvrp {port chassis/slot/port[– port2] | linkagg agg_id[-agg_id2]} last-pdu-origin

Syntax Definitions

chassis/slot/port[– port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show mvrp port 1/1/1-3 last-pdu-origin

Port Last PDU Origin

--------+-------------------
1/1/1 00:d0:95:ee:f4:64
1/1/2 00:d0:95:ee:f4:65
1/1/3 00:d0:95:ee:f4:66

->show mvrp port 1/1/21 last-pdu-origin

Port Last PDU Origin

--------+-------------------
1/1/21 00:d0:95:ee:f4:64

output definitions
Port Displays the slot and port number.
Last PDU origin The source MAC address of the last PDU message received on the
specific port.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-39
show mvrp last-pdu-origin MVRP Commands

Related Commands

show mvrp linkagg Displays the MVRP configuration for a specific port or an aggregate of
ports.
show mvrp port Displays the MVRP configurations for all the ports, including timer
values, registration and applicant modes.

MIB Objects
alaMvrpPortStatsTable
alaMvrpPortLastPduOrigin

page 13-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands show mvrp vlan-restrictions

show mvrp vlan-restrictions

Displays the VLAN MVRP configuration on a specific port or an aggregate of ports.
show mvrp {port chassis/slot/port[– port2] | linkagg agg_id[-agg_id2]} vlan-restrictions

Syntax Definitions

chassis/slot/port[– port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the agg_id or chassis/slot/port parameter with this command to display the MVRP statistics for a
specific port.

Examples
-> show mvrp port 1/1/21 vlan-restrictions

VLAN ID Static Restricted Restricted

Registration Registration Applicant
---------------+---------------+---------------+-----------
1 LEARN FALSE FALSE
2 LEARN FALSE FALSE
3 LEARN FALSE FALSE
4 LEARN FALSE FALSE
5 LEARN FALSE FALSE
6 LEARN FALSE FALSE
7 LEARN FALSE FALSE
11 RESTRICT FALSE FALSE
12 RESTRICT FALSE FALSE
53 LEARN TRUE FALSE
55 LEARN FALSE TRUE

output definitions
VLAN ID The VLAN identification number for a preconfigured VLAN that
handles the MVRP traffic for this port.
Static Registration Indicates if the port is restricted (RESTRICT) or not restricted
(LEARN) from becoming a member of the static VLAN.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-41
show mvrp vlan-restrictions MVRP Commands

output definitions (continued)

Restricted Registration Indicates if the VLAN is restricted (TRUE) or not restricted (FALSE)
from dynamic registration on the port.
Restricted Applicant Indicates if the VLAN is restricted for advertisement from the port
(TRUE) or not (FALSE).

Release History
Release 8.1.1; command introduced.

Related Commands

show mvrp port Displays the MVRP configurations for all the ports, including timer val-
ues, registration and applicant modes.
show mvrp linkagg Displays the MVRP configuration for a specific port or an aggregate of
ports.

MIB Objects
alaMvrpPortConfigTable
alaMvrpPortConfigRestrictedRegistrationBitmap
alaMvrpPortConfigRestrictedApplicantBitmap
alaMvrpPortConfigRegistrationToStaticVlan

page 13-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
MVRP Commands mvrp clear-statistics

mvrp clear-statistics
Clears MVRP statistics for all the ports, an aggregate of ports, or a specific port.
mvrp [port chassis/slot/port[–port2] | linkagg agg_id[-agg_id2]] clear-statistics

Syntax Definitions

chassis/slot/port[– port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).

Defaults
If no ports are specified, the MVRP statistics are deleted for all the ports.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the agg_id or chassis/slot/port parameter with this command to clear MVRP statistics for a specific
port.

Examples
-> mvrp clear-statistics
-> mvrp port 1/1/2 clear-statistics
-> mvrp linkagg 10 clear-statistics

Release History
Release 8.1.1; command introduced.

Related Commands

show mvrp statistics Displays the MVRP statistics for all the ports, aggregates, or specific
ports.

MIB Objects
alaMvrpGlobalClearStats
alaMvrpPortStatsTable
alaMvrpPortStatsClearStats

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 13-43
mvrp clear-statistics MVRP Commands

page 13-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 14 802.1AB Commands

802.1AB is an IEEE standard for exchanging information with neighboring devices and maintaining a
database of it. The information is exchanged as an LLDPDU (Link Layer Discovery Protocol Data Unit) in
TLV (Time, Length, Value) format. This chapter details configuring and monitoring 802.1AB on a switch.
Alcatel-Lucent’s version of 802.1AB complies with the following:
• IEEE 802.1AB-2009 Station and Media Access Control Discovery

• ANSI-TIA 1057-2006 Link Layer Discovery Protocol for Media End Point Devices .

MIB information for the 802.1AB commands is as follows:

Filename: LLDP-MIB
Module: lldpMIB
Filename: LLDP-EXT-DOT1-MIB
Module: lldpXdot1MIB
Filename: LLDP-EXT-DOT1-V2-MIB
Module: lldpV2Xdot1MIB
Filename: LLDP-EXT-DOT3-MIB
Module: lldpXdot3MIB

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-1
 802.1AB Commands

A summary of available commands is listed here:

lldp nearest-edge mode

lldp transmit hold-multiplier
lldp reinit delay
lldp notification interval
lldp lldpdu
lldp notification
lldp network-policy
lldp med network-policy
lldp tlv management
lldp tlv dot1
lldp tlv dot3
lldp tlv med
show lldp system-statistics
show lldp statistics
show lldp local-system
show lldp local-port
show lldp local-management-address
show lldp config
show lldp network-policy
show lldp med network-policy
show lldp agent-destination-address
show lldp remote-system
show lldp remote-system med
show lldp remote-system application-tlv

Configuration procedures for 802.1AB are explained in “Configuring 802.1AB,” OmniSwitch AOS
Release 8 Network Configuration Guide.

page 14-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands lldp nearest-edge mode

lldp nearest-edge mode

Enables or disables the nearest-edge mode for the switch. When enabled, the switch will use the LLDP
destination MAC address (01:20: DA: 02:01:73) to send LLDPDUs.
lldp nearest-edge mode {enable | disable}

Syntax Definitions

enable Enables the nearest-edge mode.

disable Disables the nearest-edge mode.

Defaults
NA

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The nearest-edge MAC address is used in conjunction with the Auto Download Configuration feature
to advertise the management VLAN.
• This mode is used to learn the Management VLAN ID from a centralized Remote Configuration
management switch.

Examples
-> lldp nearest-edge mode enable

Release History
Release 8.1.1; command introduced.

Related Commands

show lldp local-system Displays local system information.

MIB Objects
lldpDestMac

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-3
lldp transmit 802.1AB Commands

lldp transmit
Sets the transmit options and time interval for LLDPDUs.
lldp transmit {credit-max num | fast-init num | fast-transmit seconds | interval seconds}

Syntax Definitions

credit-max num The number of consecutive LLDPDUs that can be transmitted at any
time. The valid range is 1 - 100.
fast-init num The number of consecutive LLDPDUs that can be transmitted when
MED endpoint neighbor is detected. The valid range is 1 to 8.
fast-transmit seconds The fast transmit interval between LLDPDUs, in seconds. Selection of
time interval between transmissions during fast transmission period.
The valid range is 1 - 3600.
interval seconds The transmit interval between LLDPDUs, in seconds. The valid range is
5 - 32768.

Defaults

parameter default
seconds 30
fast-init num 4
fast-transmit seconds 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The LLDP protocol must be enabled before using this command.

• The transmission of LLDP-MED TLV only starts when the switch has detected a MED capable
endpoint in the port.
• LLDPDU has a length restriction of 1500 bytes. If the set of MED TLVs selected in the local system is
greater than 1500 bytes, then, the LLDPDU is sent containing the mandatory TLVs, and as many of the
optional TLVs in the set that fit in the remaining LLDPDU.

Examples
-> lldp transmit interval 40
-> lldp credit max num 25
-> lldp fast-init num 5
-> lldp fast-transmit seconds 5

Release History
Release 8.1.1; command introduced.

page 14-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands lldp transmit

Related Commands

lldp transmit hold-multiplier Sets the transmit hold multiplier value, which is used to calculate the
Time To Live TLV.
show lldp local-system Displays local system information.

MIB Objects
lldpV2configuration
lldpV2MessageTxInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-5
lldp transmit hold-multiplier 802.1AB Commands

lldp transmit hold-multiplier

Sets the transmit hold multiplier value, which is used to calculate the Time To Live TLV.
lldp transmit hold-multiplier num

Syntax Definitions

num The transmit hold multiplier value. The valid range is 2-10.

Defaults

parameter default
num 4

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The LLDP protocol must be enabled before using this command.

• The Time To Live is a multiple of transmit interval and transmit hold multiplier.

Examples
-> lldp transmit hold-multiplier 6

Release History
Release 8.1.1; command introduced.

Related Commands

lldp nearest-edge mode Sets the transmit time interval for LLDPDUs.
show lldp local-system Displays local system information.

MIB Objects
lldpV2configuration
lldpV2MessageTxHoldMultiplier

page 14-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands lldp reinit delay

lldp reinit delay

Sets the time interval that must elapse before the current status of a port is reinitialized after a status
change.
lldp reinit delay seconds

Syntax Definitions

seconds The number of seconds to reinitialize the ports status after a status
change. The valid range is 1-10.

Defaults

parameter default
seconds 2

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The LLDP protocol must be enabled before using this command.

Examples
-> lldp reinit delay 4

Release History
Release 8.1.1; command introduced.

Related Commands

show lldp local-system Displays local system information.

MIB Objects
lldpV2configuration
lldpV2ReinitDelay
lldpPortConfigAdminStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-7
lldp notification interval 802.1AB Commands

lldp notification interval

Sets the time interval that must elapse before a notification about the local system MIB change is
generated.
lldp notification interval seconds

Syntax Definitions

seconds The minimum number of seconds for generating a notification-event.

The valid range is 5-3600.

Defaults

parameter default
seconds 5

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The LLDP protocol and notification must be enabled before using this command.

• In a specified interval, it is not possible to generate more than one notification-event.

Examples
-> lldp notification interval 25

Release History
Release 8.1.1; command introduced.

Related Commands

lldp notification Specifies the switch to control per port notification status about the
remote device change.
show lldp local-system Displays local system information.

MIB Objects
lldpV2configuration
lldpV2NotificationInterval

page 14-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands lldp lldpdu

lldp lldpdu
Specifies the switch to control the transmission and the reception of LLDPDUs per LLDP agent 1for a
particular chassis, a slot, or a port. Specifies the LLDP destination MAC address sent in LLPDUs.
lldp [nearest-bridge | nearest-customer | non-tpmr | all] {port chassis/slot/port [-port] | slot chassis/
slot | chassis} lldpdu {tx | rx | tx-and-rx | disable}

Syntax Definitions

nearest-bridge Specifies the destination MAC address as 01:80:C2:00:00:0E.

nearest-customer Specifies the destination MAC address as 01:80:C2:00:00:00.
non-tpmr Specifies the destination MAC address as 01:80:C2:00:00:03.
all Specifies that all three LLDP agents must be supported.
chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis_id/slot The chassis ID and slot number for a specific module (3/1).
chassis Specifies the whole chassis.
tx Transmits LLDPDUs.
rx Receives LLDPDUs.
tx-and-rx Transmits and receives LLDPDUs.
disable Disables LLDPDUs transmission and reception.

Defaults

parameter default
tx | rx | tx-and-rx | disable tx-and-rx

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The port can be set to receive, transmit, or transmit and receive LLDPDUs using this command.

• If this command is applied to a slot or chassis, then the existing configuration related to this command
is lost.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-9
lldp lldpdu 802.1AB Commands

Examples
-> lldp port 1/1/2 lldpdu tx-and-rx
-> lldp slot 1/1 lldpdu tx
-> lldp nearest-customer port 1/2 lldpdu tx-and-rx
-> lldp chassis lldpdu disable

Release History
Release 8.1.1; command introduced.

Related Commands

lldp lldpdu Specifies the switch to control the transmission and the reception of
LLDPDUs for a particular chassis, a slot, or a port.
lldp notification Specifies the switch to control per port notification status about the
remote device change.
show lldp local-system Displays local system information.

MIB Objects
lldpDestMac
lldpPortConfigTable
lldpPortConfigPortNum
lldpPortConfigAdminStatus

page 14-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands lldp notification

lldp notification
Specifies the switch to control per LLDP agent per port notification status about the remote device change.
Also specifies the LLDP destination MAC address sent in LLDPDUs.
lldp [nearest-bridge | nearest-customer | non-tpmr | all] {port chassis/slot/port[-port 1] | slot chassis/
slot | chassis} notification {enable | disable}

Syntax Definitions

nearest-bridge Specifies the destination MAC address as 01:80:C2:00:00:0E.

nearest-customer Specifies the destination MAC address as 01:80:C2:00:00:00.
non-tpmr Specifies the destination MAC address as 01:80:C2:00:00:03.
all Specifies that all three LLDP agents must be supported.
chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis_id/slot The chassis ID and slot number for a specific module (3/1).
enable Enables the notification of local system MIB changes.
disable Disables the notification.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The LLDPDU administrative status must be in the receive state before using this command.

• If this command is applied to a slot or chassis, then the existing configuration related to this command
is lost.

Examples
-> lldp chassis port 1/1/2 notification enable
-> lldp nearest-bridge port 1/1/3 notification enable
-> lldp slot 1/1 notification disable

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-11
lldp notification 802.1AB Commands

Related Commands

lldp notification interval Sets the time interval that must elapse before a notification about the
local system MIB change is generated.
lldp lldpdu Specifies the switch to control the transmission and the reception of
LLDPDUs for a particular chassis, a slot, or a port.

MIB Objects
lldpV2PortConfigTable
lldpV2PortConfigPortNum
lldpV2PortConfigNotificationEnable

page 14-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands lldp network-policy

lldp network-policy
Configures a local Network Policy on the switch for a specific application type.
lldp network-policy policy_id application {voice | voice-signaling | guest-voice | guest-voice-signaling
| softphone-voice | video-conferencing | streaming-video | video-signaling} vlan {untagged | priority-
tag | vlan-id} [l2-priority 802.1p_value] [dscp dscp_value]
no lldp network-policy policy_id - [policy_id2]

Syntax Definitions

policy_id -[policy_id2] A network policy identifier (0-31) which is associated to a port. Sup-
ported only with the no form of the command
voice Specifies a voice application type.
voice-signaling Specifies a voice-signaling application type.
guest-voice Specifies a guest-voice application type.
guest-voice-signaling Specifies a guest-voice-signaling application type.
softphone-voice Specifies a softphone-voice application type.
video-conferencing Specifies a video-conferencing application type.
streaming-video Specifies a streaming-video application type.
video-signaling Specifies a video-signaling application type.
untagged Specifies that a VLAN port is untagged.
priority-tag Specifies the internal priority that would be assigned to the VLAN.
vlan_id VLAN identifier. Valid range is 1–4094.
802.1p_value The Layer-2 priority value assigned to the VLAN. Valid range is 0–7.
dscp_value Priority value assigned to the DSCP (Differentiated Service Code Point)
header. Valid range is 0–63.

Defaults

parameter default
802.1p_value for voice 5
application
802.1p_value for other 0
applications
dscp_value 0

By default the VLAN ID is configured in the voice network profile.

Platforms Supported
OmniSwitch 6860, 6860E

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-13
lldp network-policy 802.1AB Commands

Usage Guidelines
• Use the no form of this command to remove the configured network policy from the system.

• When a network policy is deleted, all the associated values and port bindings are also deleted.

• A maximum of 32 network policies can be configured on a single VLAN.

• Once a policy is created, the application type, VLAN ID, 802.1p, and DSCP values can be modified.

• If a network policy ID is bound to a port, it cannot be modified.

• Use a hyphen to specify a range of Policy IDs and a space to separate multiple Policy IDs in the
command.
• The range for Policy IDs is supported only with the no form of this command.

Examples
-> lldp network-policy 10 application voice vlan 20
-> lldp network-policy 11 application guest-voice-signaling vlan untagged l2–
priority 3
-> lldp network-policy 20 application voice vlan priority-tag dscp 39
-> lldp network-policy 20 application voice-signaling vlan 23 l2-priority 2 dscp 43
-> no lldp network-policy 10

-> no lldp network-policy 10-20

Release History
Release 8.1.1; command introduced.

Related Commands

lldp tlv med Configures whether or not LLDP-MED TLVs are included in
transmitted LLDPDUs.
show lldp network-policy Displays the network policy details for a given policy ID.
show lldp med network-policy Displays the network policy configured on a slot or port.

MIB Objects
aLldpXMedLocMediaPolicyTable
alaLldpXMedLocMediaPolicyId
alaLldpXMedLocMediaPolicyAppType
alaLldpXMedLocMediaPolicyVlanType
alaLldpXMedLocMediaPolicyVlanID
alaLldpXMedLocMediaPolicyPriority
alaLldpXMedLocMediaPolicyDscp
alaLldpXMedLocMediaPolicyUnknown
alaLldpXMedLocMediaPolicyTagged
alaLldpXMedLocMediaPolicyRowStatus

page 14-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands lldp med network-policy

lldp med network-policy

Associates an existing network policy per LLDP agent per port, slot, or chassis. Also specifies the LLDP
destination MAC address sent in LLDPDUs.
lldp [nearest-bridge | nearest-customer | non-tpmr | all] {port chassis/slot/port | slot chassis/slot |
chassis} med network-policy policy_id - [policy_id2]
no lldp {port chassis/slot/port | slot chassis/slot | chassis} med network-policy policy_id - [policy_id2]

Syntax Definition

nearest-bridge Specifies the destination MAC address as 01:80:C2:00:00:0E.

nearest-customer Specifies the destination MAC address as 01:80:C2:00:00:00.
non-tpmr Specifies the destination MAC address as 01:80:C2:00:00:03.
all Specifies that all three LLDP agents must be supported.
chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis_id/slot The chassis ID and slot number for a specific module (3/1).
chassis Specifies all switch ports.
policy_id - [policy_id2] A network policy identifier (0–31).

Defaults
NA

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disassociate a network policy from a port.

• The network policy must already be configured in the system before associating it with a port.

• A maximum of 8 network policies can be associated to a port.

• Two or more network policy IDs with the same application type cannot be associated to a port.

Examples
-> lldp chassis med network-policy 22
-> lldp slot 1/1 med network-policy 1-4 5 6
-> lldp por 2/1/3 med network-policy 12
-> no lldp slot 2/3 med network-policy 12

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-15
lldp med network-policy 802.1AB Commands

Related Commands

lldp tlv med Configures whether or not LLDP-MED TLVs are included in
transmitted LLDPDUs.
show lldp network-policy Displays the MED Network Policy details for a given policy ID.
show lldp med network-policy Displays the network policy configured on a slot or port. If no option is
specified, network policies configured on all ports of the chassis are
displayed.

MIB Objects
alaLldpXMedLocMediaPolicyPortTable
alaLldpXMedLocMediaPolicyPortIfIndex
alaLldpXMedLocMediaPolicyId
alaLldpXMedLocMediaPolicyPortRowStatus

page 14-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands lldp tlv management

lldp tlv management

Specifies the switch to control per LLDP agent per port management TLVsto be incorporated in the
LLDPDUs. Also specifies the LLDP destination MAC address sent in LLDPDUs.
lldp [nearest-bridge | nearest-customer | non-tpmr | all] {port chassis_id/slot/port [-port ] | slot
chassis_id/slot | chassis} tlv management {port-description | system-name | system-description |
system-capabilities | management-address} {enable | disable}

Syntax Definitions

nearest-bridge Specifies the destination MAC address as 01:80:C2:00:00:0E.

nearest-customer Specifies the destination MAC address as 01:80:C2:00:00:00.
non-tpmr Specifies the destination MAC address as 01:80:C2:00:00:03.
all Specifies that all three LLDP agents must be supported.
chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis_id/slot The chassis ID and slot number for a specific module (3/1).
port-description Enables or disables the transmission of port description TLV in
LLDPDU.
system-name Enables or disables the transmission of system name TLV in LLDPDU.
system-description Enables or disables transmission of system description TLV in
LLDPDU.
system-capabilities Enables or disables transmission of system capabilities TLV in
LLDPDU.
management-address Enables or disables transmission of management address on per port.
enable Enables management TLV LLDPDU transmission.
disable Disables management TLV LLDPDU transmission.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The LLDPDU must be enabled and set to transmit before using this command.

• If this command is applied to a slot or chassis, then the existing configuration related to this command
is lost.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-17
lldp tlv management 802.1AB Commands

Examples
-> lldp nearest-customer port 1/1/2 tlv management port-description enable
-> lldp non-tpmr slot 1/1 tlv management management-address enable
-> lldp slot 1/1 tlv management system-name disable
-> lldp chassis tlv management system-capabilities enable

Release History
Release 8.1.1; command introduced.

Related Commands

lldp lldpdu Specifies the switch to control the transmission and the reception of
LLDPDUs for a particular chassis, a slot, or a port.
show lldp local-system Displays local system information.
show lldp local-port Displays per port information.
show lldp remote-system Displays per local port and information of remote system.

MIB Objects
lldpPortConfigTable
lldpLocPortPortNum
lldpPortConfigTLVsTxEnable
lldpV2configManAddrTable
lldpV2ConfigManAddrPortsTxEnable

page 14-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands lldp tlv dot1

lldp tlv dot1

Specifies the switch to control per agent per port 802.1 TLVs to be incorporated in the LLDPDUs.
lldp [nearest-bridge] | non-tpmr | customer-bridge | all] {port chassis/slot/port [-port1 ] | slot chassis/
slot | chassis} tlv dot1 {port-vlan | vlan-name} {enable | disable}

Syntax Definitions

nearest-bridge Specifies the destination MAC address as 01:80:C2:00:00:0E.

nearest-customer Specifies the destination MAC address as 01:80:C2:00:00:00.
non-tpmr Specifies the destination MAC address as 01:80:C2:00:00:03.
all Specifies that all three LLDP agents must be supported.
chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis_id/slot The chassis ID and slot number for a specific module (3/1).
port-vlan Enables or disables transmission of port VLAN TLV in LLDPDU.
vlan-name Enables or disables transmission of VLAN name TLV in LLDPDU.
enable Enables 802.1 TLV LLDPDU transmission.
disable Disables 802.1 TLV LLDPDU transmission.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The LLDPDU must be enabled and set to transmit before using this command.

• If this command is applied to a slot or chassis, then the existing configuration related to this command
is lost.
• If one TLV is included then the other TLV is automatically included when you use this command.

Examples
-> lldp port 1/1/1 tlv dot1 port-vlan enable
-> lldp nearest-bridge slot 1/1 tlv dot1 vlan-name enable
-> lldp nearest-bridge slot 1/1 tlv dot1 port-vlan enable
-> lldp slot 1/1 tlv dot1 vlan-name disable

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-19
lldp tlv dot1 802.1AB Commands

Release History
Release 8.1.1; command introduced.

Related Commands

lldp tlv management Specifies the switch to control per port management TLVs to be
incorporated in the LLDPDUs.
show lldp statistics Displays per port statistics.
show lldp local-port Displays per port information.

MIB Objects
lldpV2PortConfigTable
lldpV2PortConfigPortNum
lldpV2Xdot1ConfigPortVlanTable
lldpV2Xdot1ConfigPortVlanTxEnable
lldpV2Xdot1ConfigVlanNameTable
lldpV2Xdot1ConfigVlanNameTxEnable

page 14-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands lldp tlv dot3

lldp tlv dot3

Specifies the switch to control per port 802.3 TLVs to be incorporated in the LLDPDUs.
lldp [nearest-bridge] | non-tpmr | customer-bridge | all] {port chassis/slot/port [-port] | slot chassis/
slot | chassis} tlv dot3 {mac-phy | power-via-mdi} {enable | disable}

Syntax Definitions

nearest-bridge Specifies the destination MAC address as 01:80:C2:00:00:0E.

nearest-customer Specifies the destination MAC address as 01:80:C2:00:00:00.
non-tpmr Specifies the destination MAC address as 01:80:C2:00:00:03.
all Specifies that all three LLDP agents must be supported.
chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis_id/slot The chassis ID and slot number for a specific module (3/1).
mac-phy Uses the PoE controller to determine the amount of PoE power based on
the powered device PoE class.
power-via-mdi Configures the switch to use the power via MDI TLV in the LLDPDU
sent by the powered device.
enable Enables 802.3 TLV LLDPDU transmission.
disable Disables 802.3 TLV LLDPDU transmission.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The LLDPDU must be enabled and set to transmit before using this command.

• If this command is applied to a slot or chassis, then the existing configuration related to this command
is lost.

Examples
-> lldp port 1/1/4 tlv dot3 mac-phy enable
-> lldp slot 1/1 tlv dot3 mac-phy disable
-> lldp all slot 1/1 tlv dot3 mac-phy disable
-> lldp port 1/1/3 tlv dot3 power-via-mdi enable
-> lldp nearest-bridge port 1/1/4 tlv dot3 mac-phy enable

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-21
lldp tlv dot3 802.1AB Commands

Release History
Release 8.1.1; command introduced.

Related Commands

lldp tlv management Specifies the switch to control per port management TLVs to be
incorporated in the LLDPDUs.
lldp tlv dot1 Specifies the switch to control per port 802.1 TLVs to be incorporated
in the LLDPDUs.
show lldp statistics Displays per port statistics.

MIB Objects
lldpV2PortConfigTable
lldpV2PortConfigPortNum
lldpV2Xdot3PortConfigTable
lldpV2Xdot3PortConfigTLVsTxEnable

page 14-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands lldp tlv med

lldp tlv med

Specifies the switch to control per LLDP agent per port LLDP-MED (Media Endpoint Device) TLVs to be
incorporated into the LLDPDUs. Also configures the per port transmission of Network Policy TLVs and
whether this information must be included in the LLDPDUs.
lldp {port chassis_id/slot/port [-port] | slot chassis/slot | chassis} tlv med {power | ext-power-via-mdi |
capability | network-policy} {enable | disable}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis_id/slot The chassis ID and slot number for a specific module (3/1).
ext-power-via-mdi Enables or disables the TIA-1057 Extended power-via-MDI TLV.
capability Enables or disables transmission of LLDP-MED capabilities TLV in
LLDPDU.
network-policy Enables or disables transmission of LLDP-MED network policy TLV in
LLDPDU.
enable Enables LLDP-MED TLV LLDPDU transmission.
disable Disables LLDP-MED TLV LLDPDU transmission.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The LLDPDU must be enabled and set to transmit before using this command.

• To associate a network policy to a port, first create the VLAN, and associate a port to it. Then create
the network policy and then bind it to a port.
• If this command is applied to a slot or chassis, then any configurations on specific ports is overwritten.

• The transmission of LLDP-MED Network Policy TLVs is disabled by default.

Examples
-> lldp port 1/1/4 tlv med ext-power-via-mdi enable
-> lldp slot 1/1 tlv med capability enable
-> lldp chassis tlv med power disable
-> lldp port 1/1/3 tlv med network-policy disable
-> lldp chassis tlv med network-policy enable
-> lldp chassis tlv med network-policy disable

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-23
lldp tlv med 802.1AB Commands

Release History
Release 8.1.1; command introduced.

Related Commands

lldp tlv management Specifies the switch to control per port management TLVs to be
incorporated in the LLDPDUs.
lldp tlv dot1 Specifies the switch to control per port 802.1 TLVs to be incorporated
in the LLDPDUs.
lldp tlv dot3 Specifies the switch to control per port 802.3 TLVs to be incorporated
in the LLDPDUs.

MIB Objects
lldpV2PortConfigTable
lldpV2PortConfigPortNum
lldpV2XMedPortConfigTable
lldpV2XMedPortConfigTLVsTxEnable

page 14-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands show lldp system-statistics

show lldp system-statistics

Displays system-wide statistics.
show lldp system-statistics

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show lldp system-statistics
Local LLDP Agent System Statistics:
Remote Systems Last Change = 0 days 0 hours 3 minutes and 10 seconds,
Remote Systems MIB Inserts = 2,
Remote Systems MIB Deletes = 0,
Remote Systems MIB Drops = 0,
Remote Systems MIB Age Outs = 0

output definitions
Remote Systems Last Change The last change recorded in the tables associated with the remote
system.
Remote Systems MIB Inserts The total number of complete inserts in the tables associated with the
remote system.
Remote Systems MIB Deletes The total number of complete deletes in tables associated with the
remote system.
Remote Systems MIB Drops The total number of LLDPDUs dropped because of insufficient
resources.
Remote Systems MIB Age The total number of complete age-outs in the tables associated with the
Outs remote system.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-25
show lldp system-statistics 802.1AB Commands

Related Commands

lldp notification Specifies the switch to control per port notification status about the
remote device change.
lldp notification interval Sets the time interval that must elapse before a notification about the
local system MIB change is generated.

MIB Objects
lldpStatistics
lldpStatsRemTablesLastChangeTime
lldpStatsRemTablesInserts
lldpStatsRemTablesDeletes
lldpStatsRemTablesDrops
lldpStatsRemTablesAgeouts

page 14-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands show lldp statistics

show lldp statistics

Displays per port statistics.
show lldp [nearest-bridge | non-tpmr | customer-bridge | all] [port chassis/slot/port [-port] slot
chassis/slot] statistics

Syntax Definitions

nearest-bridge Specifies the destination MAC address as 01:80:C2:00:00:0E.

nearest-customer Specifies the destination MAC address as 01:80:C2:00:00:00.
non-tpmr Specifies the destination MAC address as 01:80:C2:00:00:03.
all Specifies that all three LLDP agents must be supported.
chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis_id/slot The chassis ID and slot number for a specific module (3/1).

Defaults
By default, statistics for all LLDP ports are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the slot/port option is not specified, statistics for the chassis are displayed.

• If the statistics are zero they are not displayed.

Examples
-> show lldp statistics
Chas/ LLDPDU LLDPDU LLDPDU LLDPDU LLDPDU TLV TLV Device
Slot/Port Tx TxLenErr Rx Errors Discards Unknown Discards Ageouts
---------+---------+---------+---------+---------+---------+---------+---------+--------
1/1/1 453 0 452 0 0 0 0 0
1/1/2 452 0 453 0 0 0 0 0
1/1/5 452 0 473 0 0 476 476 0
1/1/8 455 0 464 0 0 0 0 0
1/1/9 456 0 464 0 0 0 0 0
2/1/1 452 0 457 0 0 0 0 0
2/1/2 452 0 963 0 0 0 0 0
2/1/3 480 0 459 0 0 0 0 2

output definitions
Slot/Port Slot number for the module and physical port number on that module.
LLDPDU Tx The total number of LLDPDUs transmitted on the port.
LLDPDU Rx The total number of valid LLDPDUs received on the port.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-27
show lldp statistics 802.1AB Commands

output definitions (continued)

LLDPDU Errors The total number of invalid LLDPDUs discarded on the port.
LLDPDU Discards The total number of LLDPDUs discarded on the port.
TLV Unknown The total number of unrecognized LLDP TLVs on the port.
TLV Discards The total number of LLDP TLVs discarded on the port.
Device Ageouts The total number of complete age-outs on the port.

Release History
Release 8.1.1; command introduced.

Related Commands

lldp lldpdu Specifies the switch to control the transmission and the reception of
LLDPDUs for a particular chassis, a slot, or a port.
lldp tlv management Specifies the switch to control per port management TLVs to be incor-
porated in the LLDPDUs.

MIB Objects
lldpStatsTxPortTable
lldpStatsTxPortNum
lldpStatsTxPortFramesTotal
lldpStatsRxPortTable
lldpStatsRxPortNum
lldpStatsRxPortFramesDiscardedTotal
lldpStatsRxPortFramesErrors
lldpStatsRxPortFramesTotal
lldpStatsRxPortTLVsDiscardedTotal
lldpStatsRxPortTLVsUnrecognizedTotal
lldpStatsRxPortAgeoutsTotal

page 14-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands show lldp local-system

show lldp local-system

Displays local system information.
show lldp local-system

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show lldp local-system
Local LLDP Agent System Data:
Chassis ID Subtype = 4 (MAC Address),
Chassis ID = e8:e7:32:9a:45:cf,
System Name = OS6860-DC1,
System Description = Alcatel-Lucent OS6860E-P48 8.1.1.266.R01
Capabilities Supported = Bridge Router,
Capabilities Enabled = Bridge Router,
LLDPDU Transmit Interval = 5 seconds,
TTL Hold Multiplier = 4,
Reintialization Delay = 2 seconds,
Maximum Transmit Credit = 5 ,
LLDPDUs in Fast Transmission = 4 ,
LLDPDU Fast Transmit Interval= 1 ,
MIB Notification Interval = 5 seconds,
LLDP Nearest-edge Mode = Enabled,
Management Address Type = 1 (IPv4),
Management IP Address = 0.0.0.0,

output definitions
Chassis ID Subtype The subtype that describe chassis ID.
Chassis ID The chassis ID (MAC address).
System Name The name of the system.
System Description The description of the system.
Capabilites Supported The capabilities of the system.
Capabilites Enabled The enabled capabilities of the system.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-29
show lldp local-system 802.1AB Commands

output definitions (continued)

LLDPDU Transmit Interval The LLDPDU transmit interval.
TTL Hold Multiplier The hold multiplier used to calculate TTL.
Maximum Transmit Credit The maximum transmit LLDPDUs allowed as per configuration.
LLDPDUs in Fast The LLDPDUs in fast transmission.
Transmission
LLDPDU Fast Transmit The time interval set for LLDPDUs in fast transmission.
Interval
Reintialization Delay The minimum time interval before the reinitialization of local port
objects between port status changes.
MIB Notification Interval The minimum time interval between consecutive notifications of local
system MIB change.
Management Address Type The type of management address used in LLDPDU.
Management IP Address The management IP address. The loopback0 IP address is configured
for the management IP address to be transmitted.

Release History
Release 8.1.1; command introduced.

Related Commands

lldp reinit delay Sets the time interval that must elapse before the current status of a port
is reinitialized after a status change.
lldp transmit hold-multiplier Sets the transmit hold multiplier value, which is used to calculate the
Time To Live TLV.
lldp transmit Sets the minimum time interval between successive LLDPDUs trans-
mitted.

MIB Objects
lldpLocalSystemData
lldpLocChassisIdSubtype
lldpLocChassisId
lldpLocSysName
lldpLocSysDesc
lldpLocSysCapSupported
lldpLocSysEnabled
lldpPortConfigTable
lldpMessageTxInterval
lldpMessageTXHoldMultiplier

lldpReinitDelay
lldpNotificationInterval
lldpLocManAddrTable
lldpLocManAddrSubtype
lldpLocManAddr

page 14-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands show lldp local-port

show lldp local-port

Displays per port information.
show lldp [port chassis/slot/port [-port] | slot chassis/slot] local-port

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis_id/slot The chassis ID and slot number for a specific module (3/1).

Defaults
By default, a list of all LLDP ports is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show lldp local-port
Local Chassis 1/Slot 1/Port 1 LLDP Info:
Port ID = 1001 (Locally assigned),
Port Description = Alcatel-Lucent OS6860 1/1/1,
Local Chassis 1/Slot 1/Port 2 LLDP Info:
Port ID = 1002 (Locally assigned),
Port Description = Alcatel-Lucent OS6860 1/1/2,
Local Chassis 1/Slot 1/Port 3 LLDP Info:
Port ID = 1003 (Locally assigned),
Port Description = Alcatel-Lucent OS6860 1/1/3,
Local Chassis 1/Slot 1/Port 4 LLDP Info:
Port ID = 1004 (Locally assigned),
Port Description = Alcatel-Lucent OS6860 1/1/4,
Local Chassis 1/Slot 1/Port 5 LLDP Info:
Port ID = 1005 (Locally assigned),
Port Description = Alcatel-Lucent OS6860 1/1/5,
.
.
.

output definitions
Port ID The port ID (Port MAC).
Port Description The description of the port (which includes the port number and the
AOS version).

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-31
show lldp local-port 802.1AB Commands

Release History
Release 8.1.1; command introduced.

Related Commands

lldp tlv management Specifies the switch to control per port management TLVs to be incor-
porated in the LLDPDUs.
lldp tlv dot1 Specifies the switch to control per port 802.1 TLVs to be incorporated
in the LLDPDUs.

MIB Objects
lldpLocPortTable
lldpLocPortNum
lldpLocPortIdsubtype
lldpLocPortId
lldpLocPortDesc

page 14-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands show lldp local-management-address

show lldp local-management-address

Displays the local management address information.
show lldp local-management-address

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show lldp local-management-address
Local LLDP Agent Management Address:
Management Address Type = 1 (IPv4),
Management IP Address = 10.255.11.100

output definitions
Management Address Type The address type used to define the interface number (IPv4 or IPv6).
Management IP Address The management IP address. The loopback0 IP address is configured
for the management IP address to be transmitted.

Release History
Release 8.1.1; command introduced.

Related Commands

lldp tlv management Specifies the switch to control per port management TLVs to be
incorporated in the LLDPDUs.
show lldp local-system Displays local system information.

MIB Objects
lldpLocManAddrTable
lldpLocManAddrLen
lldpLocManAddrIfSubtype
lldpLocManAddrIfId

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-33
show lldp config 802.1AB Commands

show lldp config

Displays the general LLDP configuration information for LLDP ports.
show lldp [slot chassis/slot | port chassis/slot/port[-port1]] config application-tlv

Syntax Definitions

chassis_id/slot The chassis ID and slot number for a specific module (3/1).
chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
application-tlv Displays Application Priority TLV parameters. Setting the priority value
for the application TLV is currently not supported.

Defaults
By default, a list of all LLDP ports with their configuration parameters is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the port or slot parameter options to display information for a specific port or for all ports on a
specific switch.

Examples
-> show lldp config
Chas/ Admin Notify Std TLV Mgmt 802.1 802.3 MED App-Prio
Slot/Port Status Trap Mask Address TLV Mask Mask TLV
---------+--------+---------+--------+---------+---------+--------+--------+---------
1/1/1 Rx + Tx Disabled 0x00 Disabled Disabled 0x00 0x00 Disabled
1/1/2 Rx + Tx Disabled 0x00 Disabled Disabled 0x00 0x00 Disabled
1/1/1 Rx + Tx Disabled 0x00 Disabled Disabled 0x00 0x00 Disabled
1/1/2 Rx + Tx Disabled 0x00 Disabled Disabled 0x00 0x00 Disabled
1/1/1 Rx + Tx Disabled 0x00 Disabled Disabled 0x00 0x00 Disabled
1/1/2 Rx + Tx Disabled 0x00 Disabled Disabled 0x00 0x00 Disabled
1/1/1 Rx + Tx Disabled 0x00 Disabled Disabled 0x00 0x00 Disabled
1/1/2 Rx + Tx Disabled 0x00 Disabled Disabled 0x00 0x00 Disabled
1/1/1 Rx + Tx Disabled 0x00 Disabled Disabled 0x00 0x00 Disabled
1/1/2 Rx + Tx Disabled 0x00 Disabled Disabled 0x00 0x00 Disabled
1/1/2 Rx + Tx Disabled 0x00 Disabled Disabled 0x00 0x00 Enabled

output definitions
Chas/Slot/Port Specifies the LLDP port number.
Admin Status Specifies the Administrative status of the LLDP port.The options are -
Disabled, Rx, Tx, and Rx+Tx.
Notify Trap Specifies if the Notify Trap feature is disabled or enabled on a
particular port
Std TLV Mask Specifies the standard TLV mask set for the port.

page 14-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands show lldp config

output definitions
Mgmt Address Specifies whether transmission of the per port IPv4 management
address is enabled or disabled.
802.1 TLV Specifies whether 802.1 TLV status is enabled or disabled on the LLDP
port.
802.3 Mask Specifies the standard 802.3 mask set for the port.
MED Mask Specifies the standard MED mask set for the port.
App-Prio TLV Specifies whether the Application Priority TLV status is enabled or dis-
abled for the LLDP port.

Release History
Release 8.1.1; command introduced.

Related Commands

lldp lldpdu Specifies the switch to control the transmission and the reception of
LLDPDUs for a particular chassis, a slot, or a port.
lldp notification Specifies the switch to control per port notification status about the
remote device change.
lldp tlv management Specifies the switch to control per port management TLVs to be
incorporated in the LLDPDUs.
lldp tlv dot3 Specifies the switch to control per port 802.3 TLVs to be incorporated
in the LLDPDUs.

MIB Objects
lldpPortConfigTable
lldpPortConfigPortNum
lldpPortConfigAdminStatus
lldpPortConfigNotificationEnable
lldpLocPortPortNum
lldpPortConfigTLVsTxEnable
lldpV2configManAddrTable
lldpConfigManAddrPortsTxEnable
lldpXdot3PortConfigTable
lldpXdot3PortConfigTLVsTxEnable

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-35
show lldp network-policy 802.1AB Commands

show lldp network-policy

Displays the MED Network Policy details for a given policy ID.
show lldp network-policy [policy_id]

Syntax Definitions

policy_id Policy identifier for a network policy definition. Valid range is between
0 and 31.

Defaults
By default, all configured policies are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Network policy must be configured on the system before using this command.

• Enter a policy ID with this command to display information for a specific policy.

Examples
-> show lldp network-policy
Legend: 0 Priority Tagged Vlan
- Untagged Vlan

Network Application Vlan Layer2 DSCP

Policy ID Type Id Priority Value
-----------+----------------------+------+--------+-------
1 voice 4000 7 33
12 guest-voice - - 44
21 streaming-voice 0 4 11
31 guest-voice-signaling 23 2 1

-> show lldp network-policy 1

Legend: 0 Priority Tagged Vlan
- Untagged Vlan
d

output definitions
Network Policy ID Policy identifier for a network policy definition.
Application Type Indicates the type of application configured on the port or VLAN.
VLAN ID The VLAN ID assigned to the port on which the network policy is
configured.
Layer2 Priority Layer 2 priority to be used for the specified application type.
DSCP Value DSCP value to be used to provide Diffserv node behavior for the
specified application type.

page 14-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands show lldp network-policy

Release History
Release 8.1.1 command introduced.

Related Commands

lldp network-policy Configures a local network policy on a switch for an application type.

MIB Objects
alaLldpXMedLocMediaPolicyTable
alaLldpXMedLocMediaPolicyId
alaLldpXMedLocMediaPolicyAppType
alaLldpXMedLocMediaPolicyVlanType
alaLldpXMedLocMediaPolicyVlanId
alaLldpXMedLocMediaPolicyPriority
alaLldpXMedLocMediaPolicyDscp
alaLldpXMedLocMediaPolicyUnknown
alaLldpXMedLocMediaPolicyTagged

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-37
show lldp med network-policy 802.1AB Commands

show lldp med network-policy

Displays the network policy configured on a slot or port. If no option is specified, network policies
configured on all ports of the chassis are displayed.
show lldp [slot chassis/slot| port chassis/slot/port] med network-policy

Syntax Definitions

chassis_id/slot The chassis ID and slot number for a specific module (3/1).
chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).

Defaults
By default, all ports with associated policies are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Network policy must be configured on the system before using this command.

• Enter a slot or slot/port number with this command to display information for a specific slot or port.

Examples
-> show lldp slot 1/1 med network-policy

chassis/slot/port Network Policy ID

--------------+-------------------------
1/1/1 1 3 5 7 21 23 30 31
1/1/2 1 2 3 4 7 8 9 10
.
.
.

output definitions
Chassis/Slot/Port Slot number for the module and physical port number on that module.
Network Policy ID Policy identifier for a network policy definition.

Release History
Release 8.1.1; command introduced.

page 14-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands show lldp med network-policy

Related Commands

lldp tlv med Configures whether or not LLDP-MED TLVs are included in
transmitted LLDPDUs.
lldp network-policy Configures a local network policy on a switch for an application type.

MIB Objects
alaLldpXMedLocMediaPolicyPortTable
alaLldpXMedLocMediaPolicyPortIfIndex
alaLldpXMedLocMediaPolicyId

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-39
show lldp agent-destination-address 802.1AB Commands

show lldp agent-destination-address

This command shows destination MAC addresses used in LLDPDUs.
show lldp agent-destination-address

Syntax Definitions

N/A

Defaults
By default, all ports with associated policies are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A.

Examples
-> show lldp agent-destination-address
Destination
LldpAgentName Mac Address
------+-------------------------+-----------------+
1 Nearest-Bridge 00-80-C2-00-00-0E
2 Non-TPMR-Bridge 00-80-C2-00-00-03
3 Nearest-Customer-Bridge 00-80-C2-00-00-00

output definitions
The LLDP Agent name (Nearest-Bridge, Non-TPMR-Bridge, Nearest-
LLDP Agent Name
Customer-Bridge).
Destination MAC Address The destination MAC address.

Release History
Release 8.1.1; command introduced.

Related Commands
N/A

MIB Objects
lldpV2DestAddressTable
ldpV2AddressTableIndex
ldpV2DestMacAddress

page 14-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands show lldp remote-system

show lldp remote-system

Displays per local port and information of remote system.
show lldp [port chassis/slot/port [-port1] | slot chassis/slot] remote-system

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis_id/slot The chassis ID and slot number for a specific module (3/1).

Defaults
By default, a list of all LLDP ports is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show lldp remote-system
Remote LLDP Agents on Local Port 0/1/6:

Chassis 00:e0:b1:28:1d:ad, Port 1013:

Remote ID = 1,
Chassis Subtype = 4 (MAC Address),
Port Subtype = 7 (Locally assigned),
Port Description = (null),
System Name = (null),
System Description = (null),
Capabilities Supported = none supported,
Capabilities Enabled = none enabled
Remote LLDP Agents on Local Port 0/1/13:

Chassis 00:e0:b1:28:1d:ad, Port 1006:

Remote ID = 4,
Chassis Subtype = 4 (MAC Address),
Port Subtype = 7 (Locally assigned),
Port Description = (null),
System Name = (null),
System Description = (null),
Capabilities Supported = none supported,
Capabilities Enabled = none enabled
Remote LLDP Agents on Local Port 0/1/22:

Chassis 00:00:00:00:01:00, Port 00:00:00:00:01:01:

Remote ID = 7,
Chassis Subtype = 4 (MAC Address),

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-41
show lldp remote-system 802.1AB Commands

Port Subtype = 3 (MAC address),

Port Description = (null),
System Name = (null),
System Description = (null),
Capabilities Supported = none supported,
Capabilities Enabled = none enabled

-> show lldp nearest-customer remote-system

Remote LLDP Agents on Local Port 0/1/6:

Chassis 00:e0:b1:28:1d:ad, Port 1013:

Remote ID = 1,
Chassis Subtype = 4 (MAC Address),
Port Subtype = 7 (Locally assigned),
Port Description = (null),
System Name = (null),
System Description = (null),
Capabilities Supported = none supported,
Capabilities Enabled = none enabled
Remote LLDP Agents on Local Port 0/1/13:

Chassis 00:e0:b1:28:1d:ad, Port 1006:

Remote ID = 4,
Chassis Subtype = 4 (MAC Address),
Port Subtype = 7 (Locally assigned),
Port Description = (null),
System Name = (null),
System Description = (null),
Capabilities Supported = none supported,
Capabilities Enabled = none enabled
Remote LLDP Agents on Local Port 0/1/22:

Chassis 00:00:00:00:01:00, Port 00:00:00:00:01:01:

Remote ID = 7,
Chassis Subtype = 4 (MAC Address),
Port Subtype = 3 (MAC address),
Port Description = (null),
System Name = (null),
System Description = (null),
Capabilities Supported = none supported,
Capabilities Enabled = none enabled

-> show lldp all remote-system

Remote LLDP Nearest-Bridge Agents on Local Port 0/1/6:

Chassis 00:e0:b1:28:1d:ad, Port 1013:

Remote ID = 1,
Chassis Subtype = 4 (MAC Address),
Port Subtype = 7 (Locally assigned),
Port Description = (null),
System Name = (null),
System Description = (null),
Capabilities Supported = none supported,
Capabilities Enabled = none enabled
Remote LLDP Nearest-Bridge Agents on Local Port 0/1/13:

Chassis 00:e0:b1:28:1d:ad, Port 1006:

Remote ID = 4,
Chassis Subtype = 4 (MAC Address),

page 14-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands show lldp remote-system

Port Subtype = 7 (Locally assigned),

Port Description = (null),
System Name = (null),
System Description = (null),
Capabilities Supported = none supported,
Capabilities Enabled = none enabled
Remote LLDP Nearest-Bridge Agents on Local Port 0/1/22:

Chassis 00:00:00:00:01:00, Port 00:00:00:00:01:01:

Remote ID = 7,
Chassis Subtype = 4 (MAC Address),
Port Subtype = 3 (MAC address),
Port Description = (null),
System Name = (null),
System Description = (null),
Capabilities Supported = none supported,
Capabilities Enabled = none enabled

Remote LLDP Nearest-Customer Agents on Local Port 0/1/6:

Chassis 00:e0:b1:28:1d:ad, Port 1013:

Remote ID = 1,
Chassis Subtype = 4 (MAC Address),
Port Subtype = 7 (Locally assigned),
Port Description = (null),
System Name = (null),
System Description = (null),
Capabilities Supported = none supported,
Capabilities Enabled = none enabled
Remote LLDP Nearest-Customer Agents on Local Port 0/1/13:

Chassis 00:e0:b1:28:1d:ad, Port 1006:

Remote ID = 4,
Chassis Subtype = 4 (MAC Address),
Port Subtype = 7 (Locally assigned),
Port Description = (null),
System Name = (null),
System Description = (null),
Capabilities Supported = none supported,
Capabilities Enabled = none enabled
Remote LLDP Nearest-Customer Agents on Local Port 0/1/22:

Chassis 00:00:00:00:01:00, Port 00:00:00:00:01:01:

Remote ID = 7,
Chassis Subtype = 4 (MAC Address),
Port Subtype = 3 (MAC address),
Port Description = (null),
System Name = (null),
System Description = (null),
Capabilities Supported = none supported,
Capabilities Enabled = none enabled

Remote LLDP Non-TPMR Agents on Local Port 0/1/6:

Chassis 00:e0:b1:28:1d:ad, Port 1013:

Remote ID = 1,
Chassis Subtype = 4 (MAC Address),
Port Subtype = 7 (Locally assigned),
Port Description = (null),

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-43
show lldp remote-system 802.1AB Commands

System Name = (null),

System Description = (null),
Capabilities Supported = none supported,
Capabilities Enabled = none enabled
Remote LLDP Non-TPMR Agents on Local Port 0/1/13:

Chassis 00:e0:b1:28:1d:ad, Port 1006:

Remote ID = 4,
Chassis Subtype = 4 (MAC Address),
Port Subtype = 7 (Locally assigned),
Port Description = (null),
System Name = (null),
System Description = (null),
Capabilities Supported = none supported,
Capabilities Enabled = none enabled
Remote LLDP Non-TPMR Agents on Local Port 0/1/22:

Chassis 00:00:00:00:01:00, Port 00:00:00:00:01:01:

Remote ID = 7,
Chassis Subtype = 4 (MAC Address),
Port Subtype = 3 (MAC address),
Port Description = (null),
System Name = (null),
System Description = (null),
Capabilities Supported = none supported,
Capabilities Enabled = none enabled

output definitions
Remote LLDP Agents on Local The LLDP Agents port number to which the remote system entry is
Slot/Port associated. (Remote LLDP Nearest-Bridge Agents on Local Port,
Remote LLDP Nearest-Customer Agents on Local Port, Remote
LLDP Non-TPMR Agents on Local Port)
Chassis ID Subtype The sub type that describes chassis ID.
Chassis ID The chassis ID (MAC address).
Port ID Subtype The sub type that describes port ID
Port ID The port ID (Port MAC).
Port Description The description of the port (which includes the port number and the
AOS version).
System Name The name of the system.
System Description The description of the system.
Capabilites Supported The capabilities of the system.
Capabilites Enabled The enabled capabilities of the system.

Release History
Release 8.1.1; command introduced.

page 14-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands show lldp remote-system

Related Commands

show lldp local-port Displays per port information.

show lldp local-system Displays local system information.

MIB Objects
lldpRemTable
lldpRemLocalPortNum
lldpRemChassisIdSubtype
lldpRemChassisId
lldpRemPortIdSubtype
lldpRemPortId
lldpRemPortDesc
lldpRemSysName
lldpRemSysDesc
lldpRemSysCapSupported
lldpRemSysCapEnabled
lldpRemManAddrIfSubtype
lldpRemManAddrIfId

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-45
show lldp remote-system med 802.1AB Commands

show lldp remote-system med

Displays remote system MED information for a single port or all ports on a slot.
show lldp [port chassis/slot/port [-port ] | slot chassis/slot] remote-system med {network-policy |
inventory}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis_id/slot The chassis ID and slot number for a specific module (3/1).
network-policy Display network-policy TLVs from remote Endpoint Devices
inventory Display inventory management TLVs from remote Endpoint Devices

Defaults
By default, a list of all LLDP ports is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the slot/port or slot parameter to display information for a specific port or for all ports on a specific
module.

Examples
-> show lldp port 1/1/22 remote-system med network-policy
Chas/Slot/ Remote Application Unknown Tagged Vlan Layer2 DSCP
Port ID Type Policy Flag Flag Id Priority Value
---------+------+---------------+-----------+---------+------+----------+------
1/1/22 1 Voice(01) Defined Untagged 345 4 34
1/1/22 2 Guest Voice(4) Defined Untagged 50 3 46

output definitions
Slot/Port The Slot number to which the remote system entry is associated and the
physical port number on that module.
Remote ID The Index of the Remote Device.
Application Type The Application type of the peer entity.
1. Voice
2. Voice Signaling
3. Guest Voice
4. Guest Voice Signaling
5. Softphone Voice
6. Video Conferencing
7. Streaming Video
8. Video Signaling

page 14-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands show lldp remote-system med

output definitions (continued)

Unknown Policy Flag Whether the network policy for the specified application type is
currently defined or unknown.
Tagged Flag Whether the specified application type is using a tagged or an
untagged VLAN.
VLAN ID The VLAN identifier (VID) for the port.
Layer 2 Priority Layer 2 priority to be used for the specified application type.
DSCP Value DSCP value to be used to provide Diffserv node behavior for the
specified application type.

-> show lldp port 2/47 remote-system med inventory

Remote LLDP Agents on Local Slot/Port 1/22:
Remote ID 1:
MED Hardware Revision = "1.2.12.3",
MED Firmware Revision = "7.3.2.1",
MED Software Revision = "4.2.1.11",
MED Serial Number = "32421",
MED Manufacturer Name = "Manufacturer1",
MED Model Name = "Alc32d21",
MED Asset ID = "124421",
Remote ID 2:
MED Hardware Revision = "1.2.12.4",
MED Firmware Revision = "7.3.2.2",
MED Software Revision = "4.2.1.13",
MED Serial Number = "32424",
MED Manufacturer Name = "Manufacturer2",
MED Model Name = "Alc32d41",
MED Asset ID = "124424",

output definitions
Remote ID The Index of the Remote Device.
MED Hardware Revision The Hardware Revision of the endpoint
MED Firmware Revision The Firmware Revision of the endpoint.
MED Software Revision The Software Revision of the endpoint.
MED Manufacturer Name The Manufacturer Name of the endpoint.
MED Model Name The Model Name of the endpoint.
MED Asset ID The Asset ID of the endpoint.
DSCP Value DSCP value to be used to provide Diffserv node behavior for the
specified application type.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-47
show lldp remote-system med 802.1AB Commands

Related Commands

show lldp local-port Displays per port information.

show lldp local-system Displays local system information.

MIB Objects
lldpXMedRemMediaPolicyTable
lldpXMedRemMediaPolicyAppType
lldpXMedRemMediaPolicyDscp
lldpXMedRemMediaPolicyPriority
lldpXMedRemMediaPolicyTagged
lldpXMedRemMediaPolicyUnknown
lldpXMedRemMediaPolicyVlanID
lldpXMedRemInventoryTable
lldpXMedRemAssetID
lldpXMedRemFirmwareRev
lldpXMedRemHardwareRev
lldpXMedRemMfgName
lldpXMedRemModelName
lldpXMedRemSerialNum
lldpXMedRemSoftwareRev

page 14-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
802.1AB Commands show lldp remote-system application-tlv

show lldp remote-system application-tlv

Displays remote system Application Priority TLV information for a single port or all ports on a slot.
Note. This command is currently not supported.
show lldp [port chassis/slot/port [-port] | slot chassis/slot] remote-system application-tlv

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis_id/slot The chassis ID and slot number for a specific module (3/1).

Defaults
By default, a list of all LLDP ports is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the slot/port or slot parameter to display information for a specific port or for all ports on a specific
module.

Examples
-> show lldp remote-system application-tlv
Chas/Slot/ Remote
Port ID Selector Protocol Priority
------+-----------+-------------------------------+-----------+------------+
1/1/2 1 Ethertype 35078 3 [fcoe]
1/1/2 1 Tcp/Sctp 3260 4 [iscsi]
1/1/20 1 Tcp/Sctp 3190 3
1/1/20 1 Udp/Dccp 300 4
1/1/20 1 Tcp/Udp/Sctp/Dccp 300 4

output definitions
Slot/Port The port to which the remote system entry is associated.
Remote ID The Index of the Remote Device.
Selector The protocol selector.
Protocol The protocol Ethertype or well-known port.
Priority The 802.1p priority value for the specified protocol to use.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 14-49
show lldp remote-system application-tlv 802.1AB Commands

Related Commands

show lldp config Displays the general LLDP configuration information for LLDP ports.

MIB Objects
alaXdot1dcbxAdminApplicationPriorityAppTable
alaXdot1dcbxAdminApplicationPriorityAESelector
alaXdot1dcbxAdminApplicationPriorityAEProtocol
alaXdot1dcbxAdminApplicationPriorityAEPriority

page 14-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 15 SIP Commands

SIP Snooping feature address the key challenge of real time delivery and monitoring requirements for
media streams from SIP devices. SIP snooping feature provides plug and play support to the device, where
it automatically identifies the ports used. It also enhances the security of device.
SIP Snooping prioritizes voice and video traffic over non-voice traffic. To summarize, SIP Snooping:
• Identifies and marks the SIP and its corresponding media streams. Each media stream contains Real
Time Protocol (RTP) and Real Time Control Protocol (RTCP) flows. Marking is done using the DSCP
field in the IP header.
• Provides user configured QOS treatment for SIP/RTP/RTCP traffic flows based on its marking.

• Also snoops voice quality metrics of media streams from their RTCP packets and displays them to the
user with knowledge of media reception quality in real time and helps to diagnose the problems on
their quality. Also in addition, trap will be generated when voice quality parameters like Jitter, Round
trip time, Packet-lost, R-factor and MOS values of media streams crosses user configured threshold.
This chapter includes SIP commands and their descriptions..
MIB information for SIP commands is as follows:
Filename: AlcatelIND1SIPSnooping.MIB
Module: ALCATEL-IND1-CHASSIS-MIB
A summary of the available commands is listed here:

sip-snooping admin-state
sip-snooping port admin-state
sip-snooping mode
sip-snooping trusted server
sip-snooping sip-control
sip-snooping sos-call number
sip-snooping sos-call dscp
sip-snooping udp port
sip-snooping tcp port
sip-snooping threshold
sip-snooping logging-threshold num-of-calls
show sip-snooping call-records
clear sip-snooping statistics
show sip-snooping config
show sip-snooping ports
show sip-snooping statistics
show sip-snooping registered-clients

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 15-1
sip-snooping admin-state SIP Commands

sip-snooping admin-state
Enables or disables the SIP snooping on the switch.
sip-snooping admin-state {enable | disable}

Syntax Definitions

enable Enables SIP snooping

disable Disables SIP snooping

Defaults
By default, SIP-snooping is disabled on the switch.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If SIP snooping is disabled at the port level, enabling SIP snooping globally will not override the
configuration of that port.
• If SIP snooping is disabled and enabled, it is mandatory that the phones re-register for successful DSCP
marking.

Examples
-> sip-snooping admin-state enable
-> sip-snooping admin-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

sip-snooping port admin-state Configures the status of SIP snooping on a single port, a range of
ports, or on a link aggregate of ports.
show sip-snooping ports Shows the SIP snooping port level data.
show sip-snooping config Shows the configuration done for SIP snooping.

MIB Objects
aluSIPSnoopingStatus

page 15-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
SIP Commands sip-snooping port admin-state

sip-snooping port admin-state

Configures the status of SIP snooping on a single port, a range of ports, or on a link aggregate.
sip-snooping {port chassis/slot/port[-port2] | linkagg agg_num} admin-state {enable | disable}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_num A link aggregate ID number.
enable Enables SIP snooping to mirror all SIP PDU that ingress on that port
disable Disables SIP snooping and will not mirror SIP PDU that ingress on that
port.

Defaults
By default, SIP snooping is disabled on the switch.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use this command for port/linkagg level SIP Snooping configuration on the switch.

• SIP snooping must be enabled globally to activate port/linkagg level configuration.

• Even after SIP snooping is globally disabled, port/linkagg level configuration is saved. This
configuration will be used when SIP snooping is enabled globally again.
• Port level configuration is not allowed on a member port of a linkagg.

• If a port joins a linkagg, port level configuration is overridden by the linkagg configuration. Port level
configuration will be activated if the port leaves the linkagg.

Examples
-> sip-snooping port 1/1/5-6 admin-state enable
-> sip-snooping linkagg 1 admin-state enable

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 15-3
sip-snooping port admin-state SIP Commands

Related Commands

show sip-snooping ports Shows the SIP snooping port level data.

MIB Objects
aluSIPSnoopingSlotPortIndex
aluSIPSnoopingRowStatus

page 15-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
SIP Commands sip-snooping mode

sip-snooping mode
Configures the SIP snooping mode for the specified port or link aggregate.
sip-snooping {port chassis/slot/port[-port2] | linkagg agg_num} mode {force-edge | force-non-edge |
automatic}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_num The link aggregate ID number.
force-edge Media TCAM entries to be created for dialogs that transverse the
specific port
force-non-edge No Media TCAM entries for dialogs that transverse the specific port.
automatic Sets to default mode. The port’s edge/non-edge mode is derived by the
switch/router based on LLDP received or not on the port.

Defaults
By default, the SIP snooping mode is set to automatic.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use this command for port/linkagg level SIP Snooping configuration on the switch.

• Force-edge-port/force-non-edge port option to overwrite default port mode learned by either received
or not received switch/router capability through LLDP.
• Port level configuration is not allowed on a member port of a linkagg.

• If a port joins a linkagg, port level configuration is overridden by linkagg configuration. Port level
configuration will be activated if it leaves the linkagg.

Examples
-> sip-snooping port 1/1/5-6 mode force-edge
-> sip-snooping linkagg 1 mode force-non-edge

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 15-5
sip-snooping mode SIP Commands

Related Commands

show sip-snooping ports Shows the SIP snooping port level data.

MIB Objects
aluSIPSnoopingSlotPortIndex
aluSIPSnoopingPortConfigPortMode

page 15-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
SIP Commands sip-snooping trusted server

sip-snooping trusted server

Configure the IP addresses of the trusted servers on a switch.
sip-snooping trusted-server [ip_address1 ip_address2 ip_address ...ip_address8]
no sip-snooping trusted-server {ip_address | all}

Syntax Definitions

ip_address1[-ip_address2] The IP address of one or more trusted servers.

all Specifies all the IP addresses.

Defaults
By default, no trusted servers are configured. All SIP based calls using any call server will be supported.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used to configure the IP addresses of the trusted servers. If a trusted server is
configured, then only the calls initiated through those servers will be supported.
• A maximum of 8 trusted servers can be configured.

• If no trust servers are configured, all SIP based calls using any call server will be supported.

• Use the no form of the command to remove any trusted IP or all trusted IP addresses.

Examples
-> sip-snooping trusted-server 192.254.32.22 192.254.32.33
-> no sip-snooping trusted-server 192.254.32.22
-> no sip-snooping trusted-server all

Release History
Release 8.1.1; command was introduced.

Related Commands

show sip-snooping config Shows the configuration done for SIP snooping.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 15-7
sip-snooping trusted server SIP Commands

MIB Objects
aluSIPSnoopingSIPTrustedServerIPAddress1
aluSIPSnoopingSIPTrustedServerIPAddress2
aluSIPSnoopingSIPTrustedServerIPAddress3
aluSIPSnoopingSIPTrustedServerIPAddress4
aluSIPSnoopingSIPTrustedServerIPAddress5
aluSIPSnoopingSIPTrustedServerIPAddress6
aluSIPSnoopingSIPTrustedServerIPAddress7
aluSIPSnoopingSIPTrustedServerIPAddress8

page 15-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
SIP Commands sip-snooping sip-control

sip-snooping sip-control
Configures SIP control DSCP marking.
sip-snooping sip-control dscp num
sip-snooping sip-control no dscp

Syntax Definitions

num The DSCP number. The valid range is 1–4 Mbps.

Defaults
By default no marking/prioritizing or rate limit is performed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used for the SIP control DSCP marking. A built-in rate limiter of 1 Mbps is
configured to rate limit SIP PDUs being marked by the switch.
• The packet gets its priority as normal packet, either from the QoS port configuration (trust the packet
DSCP or untrusted) or from a user configured QoS policy.
• Use no form of the command is to set default mode.

Examples
-> sip-snooping sip-control dscp 40
-> sip-snooping sip-control no dscp

Release History
Release 8.1.1; command was introduced.

Related Commands

show sip-snooping config Shows the configuration done for SIP snooping.

MIB Objects
aluSIPSnoopingSIPControlDSCP

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 15-9
sip-snooping sos-call number SIP Commands

sip-snooping sos-call number

Configures the SOS call strings in SIP snooping.
sip-snooping sos-call number string1 string2 … string4
no sip-snooping sos-call number {string | all}

Syntax Definitions

string1 … string4 Specifies the SOS call string.

all Specifies all the SOS call strings.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used for the configuration of the SOS call strings. A maximum of 4 SOS call strings
can be configured for an exact match on the “to” URI (user part only)
• No support of regular expression. If no string is specified, no SOS call can be identified in the system.

• Use no form of this command to remove existing SOS call strings.

Examples
-> sip-snooping sos-call number “911” “2233”
-> no sip-snooping sos-call number “911”
-> no sip-snooping sos-call number all

Release History
Release 8.1.1; command was introduced.

Related Commands

show sip-snooping config Displays the SIP snooping configuration.

MIB Objects
aluSIPSnoopingSOSCallNumber1
aluSIPSnoopingSOSCallNumber2
aluSIPSnoopingSOSCallNumber3
aluSIPSnoopingSOSCallNumber4

page 15-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
SIP Commands sip-snooping sos-call dscp

sip-snooping sos-call dscp

Configures the SOS-Call RTP/RTCP DSCP marking.
sip-snooping sos-call dscp num

Syntax Definitions

num Specifies the DSCP number.

Defaults
The default configuration is 46 EF.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used for the configuration of the SOS-Call RTP/RTCP DSCP marking. A built-in
rate limiter of 128 kbps is configured to rate limit a uni-direction media stream being marked by the
switch.
• SOS calls are identified only for the Audio media type. All other media type calls are considered
normal calls.

Examples
-> sip-snooping sos-call dscp 56

Release History
Release 8.1.1; command was introduced.

Related Commands

show sip-snooping config Displays the SIP snooping configuration for the switch.
show qos dscp-table Displays the internal priority mapping and drop precedence value
for each of the DSCP values.

MIB Objects
aluSIPSnoopingSOSCallRTPDSCP

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 15-11
sip-snooping udp port SIP Commands

sip-snooping udp port

Configures the UDP port for SIP Snooping.
sip-snooping udp-port udp-port1 udp-port 2 ... udp-port 8
no sip-snooping udp-port {udp-port | all}

Syntax Definitions

udp-port 1 ... udp-port 8 Specifies the UDP port for SIP snooping.
all Specifies all the UDP ports designated for SIP snooping.

Defaults
By default no UDP ports and SIP mirroring is performed with the method name and SIP2.0 strings.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• A maximum of 8 UDP ports can be configured on a switch.

• Use no form of this command to remove any UDP port configured earlier.

Examples
-> sip-snooping udp-port 5260 5060
-> no sip-snooping udp-port 5260
-> no sip-snooping udp-port all

Release History
Release 8.1.1; command was introduced.

Related Commands

show sip-snooping config Shows the configuration done for SIP snooping.

MIB Objects
aluSIPSnoopingSIPUDPPort1
aluSIPSnoopingSIPUDPPort2
aluSIPSnoopingSIPUDPPort3
aluSIPSnoopingSIPUDPPort4
aluSIPSnoopingSIPUDPPort5
aluSIPSnoopingSIPUDPPort6
aluSIPSnoopingSIPUDPPort7
aluSIPSnoopingSIPUDPPort8

page 15-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
SIP Commands sip-snooping tcp port

sip-snooping tcp port

Configures the Server listening TCP ports for SIP Snooping.
sip-snooping tcp-port tcp-port1 tcp-port 2 ... tcp-port 8
no sip-snooping tcp-port {tcp-port | all}

Syntax Definitions

tcp-port 1 ... tcp-port 8 Specifies the TCP port for SIP snooping.
all Specifies all the SOS call strings.

Defaults
By default, TCP port is 5260.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• A maximum of 8 TCP ports can be configured on a switch.

• The default port will be overwritten if the user configures any other port.

• Use the no form of this command to remove any TCP port configured earlier.

Examples
-> sip-snooping tcp-port 5260 5060
-> no sip-snooping tcp-port 5260
-> no sip-snooping tcp-port all

Release History
Release 8.1.1; command was introduced.

Related Commands

show sip-snooping config Shows the configuration done for SIP snooping.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 15-13
sip-snooping tcp port SIP Commands

MIB Objects
aluSIPSnoopingSIPTCPPort1
aluSIPSnoopingSIPTCPPort2
aluSIPSnoopingSIPTCPPort3
aluSIPSnoopingSIPTCPPort4
aluSIPSnoopingSIPTCPPort5
aluSIPSnoopingSIPTCPPort6
aluSIPSnoopingSIPTCPPort7
aluSIPSnoopingSIPUDPPort8

page 15-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
SIP Commands sip-snooping threshold

sip-snooping threshold
Configure the various thresholds of SIP snooping.
sip-snooping threshold {audio | video | other} {jitter jitter_ms_num | packet-lost % num | round-trip-
delay round_trip_delay_ms_num | r-factor rfactor_num| mos mos_num}

Syntax Definitions

audio Specify threshold for audio.

video Specify threshold for video.
other Specify threshold for other.
jitter_ms_num Specify jitter in milliseconds. The valid range is 0–300.
% num Specify packet lost in percentage. The valid range is 0–99%
round_trip_delay_ms_num Set round trip delay in milliseconds. The valid range is 0–500
rfactor_num Specify R-factor number. The valid range is 0–100
mos_num Specify MOS number. The valid range is 0–5.

Defaults

parameter default
RTCP monitoring Enable
Jitter Threshold (audio/video/other) 50/100/100 ms
Packet-lost Threshold (audio/video/other) 10 /20/20%
RTT Threshold (audio/video/other) 180 /250/250 ms
R-factor Threshold (audio/video/other) 70/80/80
MOS Threshold (audio/video/other) 3.6/3.0/3.0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Setting a threshold value to 0 disables threshold checking for that parameter.

Examples
-> sip-snooping threshold audio jitter 50
-> sip-snooping threshold audio packet-lost 10
-> sip-snooping threshold video jitter 80
-> sip-snooping threshold video round-trip-delay 180

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 15-15
sip-snooping threshold SIP Commands

Related Commands

show sip-snooping config Shows the configuration done for SIP snooping.

MIB Objects
aluSIPSnoopingThresholdMediumIndex
aluSIPSnoopingThresholdMedium
aluSIPSnoopingThresholdJitter
aluSIPSnoopingThresholdPacketLost
aluSIPSnoopingThresholdRoundTripDelay
aluSIPSnoopingThresholdRFactor
aluSIPSnoopingThresholdMOS

page 15-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
SIP Commands sip-snooping logging-threshold num-of-calls

sip-snooping logging-threshold num-of-calls

Configures the threshold for the number of calls to be logged into the flash file.
sip-snooping logging-threshold num-of-calls num

Syntax Definitions

num Specifies the maximum number of calls to be logged.

Defaults
By default, 200 calls can be logged.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command is used to configure the threshold for the number of calls to be logged into the flash file.

Examples
-> sip-snooping logging-threshold num-of-calls 300

Release History
Release 8.1.1; command was introduced.

Related Commands

show sip-snooping config Displays the SIP snooping configuration for the switch.

MIB Objects
aluSIPSnoopingThresholdNumberOfCalls

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 15-17
show sip-snooping call-records SIP Commands

show sip-snooping call-records

Displays the SIP-snooping active/ended call records.
show sip-snooping call-records {active-calls | ended-calls} [full | threshold-violation]

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command is used to show the SIP-snooping active/ended call records.

Examples
-> show sip-snooping call-records ended-calls full
Legend: start date time duration media-type end-reason
call-id / from-tag / to-tag
IP address port DSCP (forward/reverse)
policy-rule (F/R)
Pkt count (F/R)
statistics min / max / avg %samples exceeding threshold (F/R)

----------------------------------------------------------------------
2012-01-30 09:12:30 UTC 9999d 02h 22m 03s Audio Normal
0123456789012345678901234567890123456789012345678901234567890123 /
01234567890123456789012345678901 / 01234567890123456789012345678901
IP/DSCP 222.222.222.222 22222 63/63 111.111.111.111 11111 63/63
Policy-Rule SIP-VLAN10-Rule SIP-VLAN10-Rule
Pkt-Count 9999999999 9999999999
Pkt-Loss 99.9 / 99.9 / 99.9 99% 99.9 / 99.9 / 99.9 99%
Jitter 999.9 / 999.9 / 999.9 99% 999.9 / 999.9 / 999.9 99%
Delay 99999 / 99999 / 99999 99% 99999 / 99999 / 99999 99%
R-factor 99.9 / 99.9 / 99.9 99.9 / 99.9 / 99.9
MOS 4.9 / 4.9 / 4.9 4.9 / 4.9 / 4.9

2012-01-30 09:12:30 UTC 9999d 02h 22m 03s Audio Normal

1j9FpLxk3uxtm8tn@biloxi.example.com / a73kszlf / 1410948204
IP/DSCP 135.254.170.110 18888 46/32 125.54.110.110 29996 46/32
Policy-Rule SIP-Audio-SRCIP SIP-AUDIO-VLAN100
Pkt-Count 10000 12000
Pkt-Loss 0.9 / 0 / 2.8 0% 0 / 0 / 1 0%
Jitter 3.7 / 0 / 9 0% 0.1 / 0 / 0.2 0%
Delay 50.1 / 44 / 108
R-factor 70.1 / 55 / 77 0% 70.1 / 55 / 77 0%

page 15-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
SIP Commands show sip-snooping call-records

MOS 4.1 / 3.9 / 4.2 0.1% 4.1 / 3.9 / 4.2 0.1%

-------------------------
Number of Call Records: 2

-> show sip-snooping call-records ended-calls

Legend: start date time duration media-type end-reason
call-id / from-tag / to-tag
IP address port DSCP (forward/reverse)
policy-rule (F/R)

----------------------------------------------------------------------
2012-01-30 09:12:30 UTC 9999d 02h 22m 03s Audio Normal
0123456789012345678901234567890123456789012345678901234567890123 /
01234567890123456789012345678901 / 01234567890123456789012345678901
IP/DSCP 222.222.222.222 22222 63/63 111.111.111.111 11111 63/63
Policy-Rule SIP-VLAN10-Rule SIP-VLAN10-Rule

2012-01-30 09:12:30 UTC 9999d 02h 22m 03s Audio Normal

1j9FpLxk3uxtm8tn@biloxi.example.com / a73kszlf / 1410948204
IP/DSCP 135.254.170.110 18888 46/32 125.54.110.110 29996 46/32
Policy-Rule SIP-Audio-SRCIP SIP-AUDIO-VLAN100

-------------------------
Number of Call Records: 2

-> show sip-snooping call-records active-calls threshold-violation

Legend: start date time duration media-type end-reason
call-id / from-tag / to-tag
IP address port DSCP (forward/reverse)
policy-rule (F/R)
statistics min / max / avg %samples exceeding threshold (F/R)

----------------------------------------------------------------------
2012-01-30 09:12:30 UTC 9999d 02h 22m 03s Audio -
1j9FpLxk3uxtm8tn@biloxi.example.com / a73kszlf / 1410948204
IP/DSCP 135.254.170.110 18888 46/32 125.54.110.110 29996 46/32
Policy-Rule SIP-AUDIO-SRCIP SIP-AUDIO-VLAN100
MOS 4.1 / 3.9 / 4.2 0.1% 4.1 / 3.9 / 4.2 0.1%
-------------------------
Number of Call Records: 1

output definitions
Policy-Rule Name of the SIP policy rule.
Pkt-Count Packet Count in percentage for SIP Snooping.
Pkt-Loss Packet Loss in percentage for SIP Snooping.
Jitter Jitter threshold in millisec for SIP Snooping.
Delay Round trip delay in millisec for SIP Snooping.
R-factor R-Factor for SIP Snooping.
MOS MOS for SIP Snooping.
Number of Call Records Number of call records that can be stored onto the device.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 15-19
show sip-snooping call-records SIP Commands

Release History
Release 8.1.1; command was introduced.

Related Commands

show sip-snooping config Displays the SIP snooping configuration.

MIB Objects
alaQoSDSCPEntryNumber
alaQoSDSCPPriority
alaQoSDSCPDropPrecedence

page 15-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
SIP Commands clear sip-snooping statistics

clear sip-snooping statistics

Clears all the values of SIP snooping statistics
clear sip-snooping statistics

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command is used to clear all the SIP-snooping statistics.

Examples
-> clear sip-snooping statistics

Release History
Release 8.1.1; command was introduced.

Related Commands

show sip-snooping statistics Displays SIP snooping statistics.

MIB Objects
aluSIPSnoopingClearStats

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 15-21
show sip-snooping config SIP Commands

show sip-snooping config

Displays the SIP snooping configuration for the switch.
show sip-snooping config

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command is used to show the SIP snooping status and configuration for the switch.

Examples
-> show sip-snooping config
Sip-snooping Status : Enable,
Sip-control DSCP : 40,
SOS-Call RTP/RTCP DSCP : 35,
SOS-Call Number : 911, 2233,
Jitter Threshold (audio/video/other) : 50ms/100ms/100ms,
Packet-Lost Threshold (audio/video/other) : 10/20/20,
Round-Trip-Delay Threshold (audio/video/other) : 180ms/250ms/250ms,
R-factor Threshold (audio/video/other) : 70/80/80,
MOS Threshold (audio/video/other) :3.6/3.0/3.0 ,
Logging Number of calls : 200,
UDP-Port(s) : 5060, 5260
TCP-Port(s) : 5260
Trusted Server IP(s) : 192.254.32.11,192.254.32.22,192.254.32.33
Reserved HW resource : 1,
CPU Rate Limiter for SIP PDUS : 1 mbps,

output definitions
Sip-snooping Status Indicates whether the SIP Snooping status is Enable or Disable.
Sip-control DSCP Displays the SIP control DSCP value
SOS-Call RTP/RTCP DSCP Displays the SOS-Call RTP/RTCP DSCP number.
SOS-Call Number Displays the emergency call number.
Jitter Threshold Displays the Jitter threshold in milliseconds.
Packet-Lost Threshold Displays the packet lost threshold in percentage.
Round-Trip-Delay Threshold Displays the Round-Trip-Delay threshold period in milliseconds.
R-factor Threshold Displays the R-Factor value.

page 15-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
SIP Commands show sip-snooping config

output definitions (continued)

MOS Threshold Displays the MOS for SIP Snooping.
Logging Number of calls Displays the maximum number of calls to be logged in flash file
UDP-Ports Displays the SIP Snooping UDP Ports.
TCP Ports Displays the SIP Snooping TCP ports.
Trusted Server IP(s) Displays the truster server IP addresses.

Release History
Release 8.1.1; command was introduced.

Related Commands

show sip-snooping statistics Displays SIP snooping statistics.

clear sip-snooping statistics Clears all the logs of SIP snooping statistics

MIB Objects
aluSIPSnoopingThresholdMediumIndex
aluSIPSnoopingStatus
aluSIPSnoopingSIPControlDSCP
aluSIPSnoopingSOSCallRTPDSCP
aluSIPSnoopingSOSCallNumber1
aluSIPSnoopingSOSCallNumber2
aluSIPSnoopingSOSCallNumber3
aluSIPSnoopingSOSCallNumber4
aluSIPSnoopingThresholdMedium
aluSIPSnoopingThresholdJitter
aluSIPSnoopingThresholdPacketLost
aluSIPSnoopingThresholdRoundTripDelay
aluSIPSnoopingThresholdNumberOfCalls
aluSIPSnoopingSIPTrustedServerIPAddress1
aluSIPSnoopingSIPTrustedServerIPAddress2
aluSIPSnoopingSIPTrustedServerIPAddress3
aluSIPSnoopingSIPTrustedServerIPAddress4
aluSIPSnoopingSIPTrustedServerIPAddress5
aluSIPSnoopingSIPTrustedServerIPAddress6
aluSIPSnoopingSIPTrustedServerIPAddress7
aluSIPSnoopingSIPTrustedServerIPAddress8
aluSIPSnoopingSIPUDPPort1
aluSIPSnoopingSIPUDPPort2
aluSIPSnoopingSIPUDPPort3
aluSIPSnoopingSIPUDPPort4
aluSIPSnoopingSIPUDPPort5
aluSIPSnoopingSIPUDPPort6
aluSIPSnoopingSIPUDPPort7
aluSIPSnoopingSIPUDPPort8

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 15-23
show sip-snooping ports SIP Commands

show sip-snooping ports

Displays configuration information for SIP snooping ports.
show sip-snooping ports

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command is used to show the SIP-snooping port-level data.

Examples
-> show sip-snooping ports
Legend : sip snooping : * status disabled (Sip-snooping globally disabled)
Port sip-snooping Edge/Non-edge
--------------------------------------------------------
1/1 enable automatic
1/3 enable (*) force-edge
1/3 enable (*) force-non-edge

output definitions
Port Displays ports configured for sip-snooping.
sip-snooping Displays the status of sip-snooping on the port, enable or disable.
Edge/Non-edge Displays the edge status of the port.

Release History
Release 8.1.1; command was introduced.

Related Commands

show sip-snooping statistics Displays SIP snooping statistics.

MIB Objects
aluSIPSnoopingPortConfigSlotPortIndex
aluSIPSnoopingPortConfigPortStatus
aluSIPSnoopingPortConfigPortMode

page 15-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
SIP Commands show sip-snooping statistics

show sip-snooping statistics

Displays SIP snooping statistics.
show sip-snooping statistics

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command is used to show the SIP snooping statistics.

Examples
-> show sip-snooping statistics
Total calls processed : ,
Total audio streams : ,
Total video streams : ,
Total other streams : ,
Total audio streams that crossed threshold : ,
Total video streams that crossed threshold : ,
Total other streams that crossed threshold : ,
Active Streams that crossed threshold : ,
Number of Active calls : ,
Number of active audio streams : ,
Number of active video streams : ,
Number of active other streams : ,
Number of SIP packet received by hardware :
Number of SIP packet received by software :
Number of SIP packet received per method: INVITE(100) ACK(101) BYE(200)
UPDATE(40) PRACK(20)
Number of SIP response packet received:
Number of discarded/malformed/unsupported SIP packets:
Number of discarded SIP packets not from/to trusted servers:
Number of dropped SIP packet due the software error:
(NI overflow, NI/CMM, CMM overflow)
Total Emergency Calls :

output definitions
Total calls processed Total calls processed for SIP Snooping.
Total audio streams Displays the total audio streams.
Total video streams Displays the total video streams.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 15-25
show sip-snooping statistics SIP Commands

output definitions (continued)

Total other streams Displays the total other streams.
Total audio streams that Displays the total audio streams that have exceeded threshold.
crossed threshold
Total video streams that Displays the total video streams that have exceeded threshold.
crossed threshold
Total other streams that Displays the total other streams that have exceeded threshold.
crossed threshold
Number of Active calls Displays the number of active calls.
Number of Active audio Displays the number of active audio streams.
streams
Number of Active video Displays the number of active video streams.
streams
Number of Active other Displays the number of active other streams.
streams
Number of SIP packet received Displays the total SIP packet received by hardware.
by hardware
Number of SIP packet received Displays the total SIP packet received by software.
by software
Number of SIP packet received Displays the method by which the SIP packet is received. The various
by per method per method are Invite, Ack, Bye, Update and Prack.
Number of SIP response Displays the total number of SIP response packet received.
packet received
Number of discarded/ Displays the total number of discarded, malformed or unsupported SIP
malformed/unsupported SIP packets.
packets
Number of discarded SIP Displays the total number of discarded SIP packets not from or to
packets not from/to trusted trusted servers
servers
Number of dropped SIP packet Displays the Total number of SIP packets dropped due the software
due the software error error. (i.e. NI overflow, NI/CMM, CMM overflow etc.)
Total Emergency Calls Displays the total number of Emergency Calls.

Release History
Release 8.1.1; command was introduced.

Related Commands

clear sip-snooping statistics Clears the SIP snooping statistics.

page 15-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
SIP Commands show sip-snooping statistics

MIB Objects
aluSIPSnoopingTotalCallsProcessed
aluSIPSnoopingTotalAudioStreams
aluSIPSnoopingTotalVideoStreams
aluSIPSnoopingTotalOtherStreams
aluSIPSnoopingAudioStreamsBeyondThreshold
aluSIPSnoopingVideoStreamsBeyondThreshold
aluSIPSnoopingOtherStreamsBeyondThreshold
aluSIPSnoopingActiveStreamsBeyondThreshold
aluSIPSnoopingActiveAudioStreams
aluSIPSnoopingActiveVideoStreams
aluSIPSnoopingActiveOtherStreams
aluSIPSnoopingHardwareSIPPackets
aluSIPSnoopingSoftwareSIPPackets
aluSIPSnoopingSIPInvitePackets
aluSIPSnoopingSIPAckPackets
aluSIPSnoopingSIPByePackets
aluSIPSnoopingSIPByePackets
aluSIPSnoopingSIPUpdatePackets
aluSIPSnoopingSIPPrackPackets
aluSIPSnoopingSIPRecvdResponsePackets
aluSIPSnoopingSIPDiscardedPackets
aluSIPSnoopingSIPDiscardedNoTrustServerPackets
aluSIPSnoopingSIPDroppedSWErrorPackets
aluSIPSnoopingTotalEmergencyCalls

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 15-27
show sip-snooping registered-clients SIP Commands

show sip-snooping registered-clients

Shows the registered SIP clients learned by the switch.
show sip-snooping registered-clients

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command is used to show the registered SIP clients learned by the switch.

Examples
-> show sip-snooping registered-clients

S/N Registered Client IP Address

---------------------------------------------
1 10.135.22.18
2 10.135.22.25
3 10.135.23.124

output definitions
Registered Client IP Address The IP address of the registered client.

Release History
Release 8.1.1; command was introduced.

Related Commands

sip-snooping port admin-state Configures the status of SIP snooping on a single port, a range of
ports, or on a link aggregate.

MIB Objects
alaSIPSnoopingRegisteredClientNumber
alaSIPSnoopingRegisteredClientAddrType
alaSIPSnoopingRegisteredClientAddr

page 15-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 16 IP Commands

This chapter details Internet Protocol (IP) commands for the switch. IP is a network-layer (Layer 3)
protocol that contains addressing information and some control information that enables packets to be
forwarded. IP is documented in RFC 791 and is the primary network-layer protocol in the Internet protocol
suite. Along with the Transmission Control Protocol (TCP), IP represents the heart of the Internet
protocols.
IP is enabled on the switch by default and there are few options that can, or need to be, configured. This
chapter provides instructions for basic IP configuration commands. It also includes commands for several
Layer 3 and Layer 4 protocols that are associated with IP:
• Address Resolution Protocol (ARP)—Used to match the IP address of a device with its physical
(MAC) address.
• Internet Control Message Protocol (ICMP)—Specifies the generation of error messages, test packets,
and informational messages related to IP. ICMP supports the ping command that is used to determine
if hosts are online.
• Transmission Control Protocol (TCP)—A major data transport mechanism that provides reliable,
connection-oriented, full-duplex data streams. While the role of TCP is to add reliability to IP, TCP
relies upon IP to do the actual delivering of datagrams.
• User Datagram Protocol (UDP)—A secondary transport-layer protocol that uses IP for delivery. UDP
is not connection-oriented and does not provide reliable end-to-end delivery of datagrams. But some
applications can safely use UDP to send datagrams that do not require the extra overhead added by
TCP.
The IP commands also include protection from Denial of Service (DoS) attacks. The goal of this feature is
to protect a switch from well-known DoS attacks and to notify the administrator or manager when an
attack is underway. Also, notifications can be sent when port scans are being performed.

Note. If all devices are on the same VLAN or if the IP interfaces are created on multiple VLANs to
enable routing of packets, packets can be forwarded using IP. However, IP routing requires one of the
IP routing protocols: Routing Information Protocol (RIP) or Open Shortest Path First (OSPF). See the
following chapters for the appropriate CLI commands: Chapter 19, “RIP Commands,” Chapter 23,
“OSPF Commands.” For more information on VLANs and RIP, see the applicable chapters in the
Configuration Guide. For more information on OSPF, see the “Configuring OSPF” chapter in the
OmniSwitch AOS Release 8 Advanced Routing Configuration Guide.

MIB information for the IP commands is as follows:

Filename: IpForward.mib
Module: IpForward
Filename: Ip.mib
Module: Ip

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-1
 IP Commands

Filename: AlcatelIND1Ip.mib
Module: alcatelIND1IPMIB
Filename: AlcatelIND1Iprm.mib
Module: alcatelIND1IPRMMIB
A summary of the available commands is listed here:

IP ip interface
ip interface tunnel
ip router primary-address
ip router router-id
ip static-route
ip route-pref
ip default-ttl
ping
traceroute
ip directed-broadcast
ip service
ip service port
ip service source-ip
show ip traffic
show ip interface
show ip routes
show ip route-pref
show ip redist
show ip access-list
show ip route-map
show ip router database
show ip emp-routes
show ip config
show ip protocols
show ip router-id
show ip service
show ip service source-ip
IP Route Map Redistribution ip redist
ip access-list
ip access-list address
ip route-map action
ip route-map match ip address
ip route-map match ipv6 address
ip route-map match ip-nexthop
ip route-map match ipv6-nexthop
ip route-map match tag
ip route-map match ipv4-interface
ip route-map match ipv6-interface
ip route-map match metric
ip route-map match route-type
ip route-map match protocol
ip route-map set metric
ip route-map set metric-type
ip route-map set tag
ip route-map set community
ip route-map set local-preference
ip route-map set level
ip route-map set ip-nexthop
ip route-map set ipv6-nexthop
show ip redist
show ip access-list
show ip route-map

page 16-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands

Multiple Virtual Routing and vrf

Forwarding (VRF) show vrf
show vrf-profiles
Route Leak ip export
ip import
show ip export
show ip import
show ip global-route-table
ARP arp
clear arp-cache
ip dos arp-poison restricted-address
arp filter
clear arp filter
show arp
show ip dos arp-poison
show arp filter
ICMP icmp type
icmp unreachable
icmp echo
icmp timestamp
icmp addr-mask
icmp messages
show icmp control
show icmp statistics
TCP show tcp statistics
show tcp ports
UDP show udp statistics
show udp ports
Denial of Service (DoS) ip dos scan close-port-penalty
ip dos scan tcp open-port-penalty
ip dos scan udp open-port-penalty
ip dos scan threshold
ip dos trap
ip dos scan decay
ip dos type
show ip dos config
show ip dos statistics

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-3
ip interface IP Commands

ip interface
Configures an IP interface to enable IP routing on a VLAN or allow remote access. Without an IP
interface, traffic is bridged within the VLAN or across connections to the same VLAN on other switches.
ip interface {if_name | emp | master emp | local chassis-id chassis-id} [address | vip-address
ip_address] [mask subnet_mask] [admin-state [enable | disable]] [vlan vlan_id] [forward | no forward]
[local-proxy-arp | no local-proxy-arp] [e2 | snap] [primary | no primary]
no ip interface if_name

Syntax Definitions

if_name Text string of the interface name. Use quotes around string if description
contains multiple words with spaces between them (for example,
“Alcatel-Lucent Marketing”). This value is case sensitive.
master emp Modifies the EMP port IP address of the master chassis when operating
in virtual chassis mode.
local chassis-id chassis-id Modifies the EMP port IP address of the local chassis when operating in
virtual chassis mode.
emp Modifies the shared EMP port IP address.
address ip_address An IP host address (for example, 10.0.0.1, 171.15.0.20) to specify the IP
router network.
vip-address ip_address Note. This field is not supported in this release.
subnet_mask A valid IP address mask (for example, 255.0.0.0, 255.255.0.0) to
identify the IP subnet for the interface.
enable Enables the administrative status for the IP interface.
disable Disables the administrative status for the IP interface.
vlan_id An existing VLAN ID number (1–4094).
forward Enables forwarding of IP frames to other subnets.
no forward Disables forwarding of IP frames. The router interface still receives
frames from other hosts on the same subnet.
local-proxy-arp Enables Local Proxy ARP on the specified interface.
no local-proxy-arp Disables Local Proxy ARP on the specified interface.
e2 Enter e2 or ethernet2 to specify Ethernet-II encapsulation.
snap SNAP encapsulation.
primary Designates the specified IP interface as the primary interface for the
VLAN.
no primary Removes the configured primary IP interface designation for the
VLAN. The first interface bound to the VLAN becomes the primary by
default.

page 16-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip interface

Defaults

parameter default
ip_address 0.0.0.0
subnet_mask IP address class
enable | disable enable
vlan_id none (unbound)
forward | no forward forward
local-proxy-arp | no local-proxy-arp no local-proxy-arp
e2 | snap e2
primary | no primary First interface bound
to a VLAN.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an IP interface.

• IP multi-netting is supported. As a result, it is possible to configure up to 16 IP interfaces per VLAN.

Each interface is configured with a different subnet, thus allowing traffic from each configured subnet
to coexist on the same VLAN.
• When local proxy ARP is enabled for any one IP router interface associated with a VLAN, the feature
is applied to the entire VLAN. It is not necessary to enable it for each interface. However, if the IP
interface that has this feature enabled is moved to another VLAN, Local Proxy ARP is enabled for the
new VLAN and must be enabled on another interface for the old VLAN.
• When Local Proxy ARP is enabled, all traffic is routed instead of bridged within the VLAN. ARP
requests return the MAC address of the IP router interface. The same MAC address is assigned to each
interface configured for a VLAN.
• Local Proxy ARP takes precedence over any switch-wide ARP or Proxy ARP function. It is not
necessary to have Proxy ARP configured to use Local Proxy ARP. The two features are independent of
each other.
• By default, the first interface bound to a VLAN becomes the primary interface for that VLAN. Use the
primary keyword with this command to configure a different IP interface as the primary.
• To create an IP interface for network management purposes, specify Loopback0 (case sensitive) as the
name of the interface. The Loopback0 interface is not bound to any VLAN, so it always remains
operationally active.

Examples
-> ip interface “Marketing”
-> ip interface “Payroll address” 18.12.6.3 vlan 255
-> ip interface “Human Resources” 10.200.12.101 vlan 500 no forward snap
-> ip interface “Distribution” 11.255.14.102 vlan 500 local-proxy-arp primary

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-5
ip interface IP Commands

Release History
Release 8.1.1; command introduced

Related Commands

show ip interface Displays the status and configuration of IP interfaces.

MIB Objects
alaIpInterfaceTable
alaIpInterfaceName
alaIpInterfaceAddress
alaIpInterfaceVipAddress
alaIpInterfaceMask
alaIpInterfaceAdminState
alaIpInterfaceDeviceType
alaIpInterfaceVlanID
alaIpInterfaceIpForward
alaIpInterfaceEncap
alaIpInterfaceLocalProxyArp
alaIpInterfacePrimCfg
alaIpInterfaceOperState
alaIpInterfaceOperReason
alaIpInterfaceRouterMac
alaIpInterfaceBcastAddr
alaIpInterfacePrimAct

page 16-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip interface tunnel

ip interface tunnel
Configures the end points for a GRE or IPIP tunnel.
ip interface if_name tunnel [source ip_address] [destination ip_address] [protocol {ipip | gre}]

Syntax Definitions

if_name Text string. Use quotes around string if description contains multiple
words with spaces between them (for example, “Alcatel-Lucent
Marketing”). This value is case sensitive.
source ip_address Source IP address of the tunnel.
destination ip_address Destination IP address of the tunnel.
ipip Specifies the tunneling protocol as IPIP.
gre Specifies the tunneling protocol as GRE.

Defaults

parameter default
ipip | gre ipip

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
You can configure an interface as either a VLAN or tunnel interface.

Examples
-> ip interface “tnl-1” tunnel source 23.23.23.1 destination 155.2.2.2 protocol gre
-> ip interface “tnl-1” tunnel source 23.23.23.1 destination 155.2.2.2 protocol
ipip

Release History
Release 8.1.1; command introduced

Related Commands

show ip interface Displays the status and configuration of IP interfaces.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-7
ip interface tunnel IP Commands

MIB Objects
alaIpInterfaceTable
alaIpInterfaceName
alaIpInterfaceTunnelSrc
alaIpInterfaceTunnelDst
alaIpInterfaceDeviceType

page 16-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip router primary-address

ip router primary-address
Configures the router primary IP address. By default, the router primary address is derived from the first
IP interface that becomes operational on the router.
ip router primary-address ip_address

Syntax Definitions

iip_address 32-bit IP address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The router primary address must be a valid IP unicast host address.

• The router primary IP address is used by BGP to derive its unique BGP Identifier, if the router ID is
not a valid IP unicast address.
• It is recommended that the primary address be explicitly configured on dual CMM chassis.

Examples
-> ip router primary-address 172.22.2.115

Release History
Release 8.1.1; command introduced

Related Commands

ip router router-id Configures the router ID for the router.

MIB Objects
alaDcrTmConfig
alaDrcTmIpRouterPrimaryAddress

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-9
ip router router-id IP Commands

ip router router-id
Configures the router ID for the router. By default, the router primary address of the router is used as the
router ID. However, if a primary address has not been explicitly configured, the router ID defaults to the
address of the first IP interface that becomes operational.
ip router router-id ip_address

Syntax Definitions

iip_address 32-bit IP address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The router ID can be any 32-bit number.

• If the router ID is not a valid IP unicast host address, the BGP identifier is derived from the router
primary address.
• It is recommended that the router ID be explicitly configured on dual CMM chassis.

• The router ID is used by OSPF and BGP for unique identification of the router in the network.

Examples
-> ip router router-id 172.22.2.115

Release History
Release 8.1.1; command introduced

Related Commands

ip router primary-address Configures the router primary IP address.

MIB Objects
alaDcrTmConfig
alaDrcTmIpRouterId

page 16-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip static-route

ip static-route
Creates/deletes an IP static route. Static routes are user-defined; they carry a higher priority than routes
created by dynamic routing protocols. That is, static routes always have priority over dynamic routes,
regardless of the metric value.
ip static-route ip_address [mask mask] {gateway gateway_address [bfd-state {enable | disable}] |
interface interface_name | follows ip_address} [metric metric]
no ip static-route ip_address [mask mask] [gateway gateway_address {bfd-state [enable | disable]} \
interface interface_name | follows ip_address] [metric metric]

Syntax Definitions

iip_address Destination IP address of the static route.

mask Subnet mask corresponding to the destination IP address.
gateway IP address of the gateway.
bfd-state Configures the bfd status for the gateway.
interface_name Interface name used to reach the destination IP address.
follows ip_address The static route follows this IP address. The route uses the same
gateway (and interface) that is used to reach the host corresponding to
the IP address specified.
metric Metric or cost (hop count) for the static route. You can set a priority for
the static route by assigning a metric value. The lower the metric value,
the higher the priority. Valid range is 1–65535.

Defaults

parameter default
metric 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• By default, static routes have a higher priority over dynamic routes; however, it can be changed using
the ip route-pref command.
• Static routes do not age out of the routing tables; however, they can be deleted. Use the no form of this
command to delete a static route.
• A static route will be active if the interface it is using is "UP”.

• The subnet mask is not required if you want to use the natural subnet mask. By default, the switch
imposes a natural mask on the IP address.
• In case of directly connected NAT routers interface name can be used instead of gateway IP address,
provided the router is enabled for proxy-ARP to handle ARP requests for the route addresses.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-11
ip static-route IP Commands

• To configure a blackhole route, use the interface parameter with the "Loopback" interface name.

Examples
-> ip static-route 171.11.0.0/16 gateway 171.11.2.1
-> ip static-route 12.0.0.0/8 interface Loopback
-> ip static-route 171.11.0.0 follows 192.168.10.1

Release History
Release 8.1.1; command introduced

Related Commands

ip route-pref Configures the route preference of a router.

show ip routes Displays the IP Forwarding table.
show ip router database Displays the IP router database contents.

MIB Objects
alaIprmStaticRoute
alaIprmStaticRouteDest
alaIprmStaticRouteMask
alaIprmStaticRouteNextHop
alaIprmStaticRouteMetric
alaIprmStaticRouteStatus
alaIprmStaticRouteType
alaIprmStaticRouteBfdStatus

page 16-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-pref

ip route-pref
Configures the route preference of a router.
[vrf if_name] ip route-pref {static | rip | ospf | isisl2 | isisl1 | ibgp | ebgp | import} value

Syntax Definitions

if_name The alphanumeric name (1–20 characters) assigned to the VRF instance.
static Configures the route preference of static routes.
ospf Configures the route preference of OSPF routes
isisl2 Configures the route preference of ISIS L2 routes.
isisl1 Configures the route preference of ISIS L1 routes.
rip Configures the route preference of RIP routes.
ebgp Configures the route preference of external BGP routes.
ibgp Configures the route preference of internal BGP routes.
import Configures the route preference for the routes that are imported.
value Route preference value.

Defaults

parameter default
static value 2
ospf value 110
isisl2 value 118
isisl1 value 115
rip value 120
ebgp value 190
ibgp value 200
import value 210

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Route preference of local routes cannot be changed.

• The route preference configured for ISIS L1 and L2 is applicable for both ISIS IPv4 and ISIS IPv6
routes. The configured value can be viewed in both “show ip route-pref” and “show ipv6 route-pref”
commands.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-13
ip route-pref IP Commands

Examples
-> ip route-pref ebgp 20
-> ip route-pref rip 60
-> ip route-pref import 210

Release History
Release 8.1.1; command introduced

Related Commands

show ip route-pref Displays the configured route-preference of a router.

ip import Configures a route map to import routes from GRT to the destination
VRF.
show ip import Displays the import route configuration details.

MIB Objects
alaIprmRtPrefTable
alaIprmRtPrefEntryType
alaIprmRtPrefEntryValue

page 16-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip default-ttl

ip default-ttl
Configures the Time To Live value (TTL) for IP packets. The TTL value is the maximum number of hops
an IP packet travels before being discarded.
ip default-ttl hops

Syntax Definitions

hops TTL value, in hops. Valid range is 1–255.

Defaults

parameter default
hops 64

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This value represents the default value inserted into the TTL field of the IP header for datagrams
originating from this switch whenever a TTL value is not supplied by the transport layer protocol.

Examples
-> ip default-ttl 30

Release History
Release 8.1.1; command introduced

Related Commands
show ip config Displays IP configuration parameters.

MIB Objects
IpDefaultTTL

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-15
ping IP Commands

ping
Tests whether an IP destination can be reached from the local switch. This command sends an ICMP echo
request to a destination and then waits for a reply. To ping a destination, enter the ping command and
enter either the IP address or hostname of the destination. The switch pings the destination using the
default frame count, packet size, interval, and timeout parameters (6 frames, 64 bytes, 1 second, and 5
seconds respectively). You can also customize any or all of these parameters as described below.
ping {ip_address | hostname} [source-interface ip_interface] [count count] [size packet_size] [interval
seconds] [timeout seconds] [data-pattern string] [dont-fragment] [tos tos_val]

Syntax Definitions

ip_address IPv4 address of the system to ping.

hostname DNS name of the system to ping.
count Number of frames to be transmitted.
packet_size Size of the data portion of the packet sent for this ping, in bytes. Valid
range is 1–65507.
interval seconds Polling interval. The switch polls the host at time intervals specified in
seconds.
timeout seconds Number of seconds the program waits for a response before timing out.
source-interface ip_interface IP address or interface name to use as the source IP for the ping packets.
data-pattern string The data pattern to be used in the data field of the ping packets.
dont-fragment Sets the don't-fragment bit in the IP packet.
tos tos_val Type of Service field in the IP header.

Defaults

parameter default
count 6
packet_size 64
interval seconds 1
timeout seconds 5
dont-fragment 0
tos tos_val 0
data-pattern string Repeating
sequence of
ASCII charac-
ters 0x4
onwards to 0xff

Platforms Supported
OmniSwitch 6860, 6860E

page 16-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ping

Usage Guidelines
If you change the default values, they are only applied to the current ping. The next time you use the ping
command, the default values are used unless you again enter different values.

Examples
-> ping 10.255.11.242

PING 10.255.11.242: 56 data bytes

64 bytes from 10.255.11.242: icmp_seq=0. time=0. ms
64 bytes from 10.255.11.242: icmp_seq=1. time=0. ms
64 bytes from 10.255.11.242: icmp_seq=2. time=0. ms
64 bytes from 10.255.11.242: icmp_seq=3. time=0. ms
64 bytes from 10.255.11.242: icmp_seq=4. time=0. ms
64 bytes from 10.255.11.242: icmp_seq=5. time=0. ms
----10.255.11.242 PING Statistics----
6 packets transmitted, 6 packets received, 0% packet loss
round-trip (ms) min/avg/max = 0/0/0

-> ping 10.0.0.1 source-interface mgmt

-> ping 10.0.0.1 tos 1
-> ping 10.0.0.1 timeout 10
-> ping 10.0.0.1 interval 10
-> ping 10.0.0.1 dont-fragment
-> ping 10.0.0.1 data-pattern AB

Release History
Release 8.1.1; command introduced

Related Commands
traceroute Finds the path taken by an IP packet from the local switch to a
specified destination.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-17
traceroute IP Commands

traceroute
Finds the path taken by an IP packet from the local switch to a specified destination. This command
displays the individual hops to the destination as well as some timing information.
traceroute {ip_address | hostname} [max-hop max_hop_count] [min-hop min_hop_count] [source-
interface ip_interface] [probes probe_count] [timeout seconds] [port port_number_value]

Syntax Definitions

ip_address IPv4 address of the host whose route you want to trace.
hostname DNS name of the host whose route you want to trace.
max_hop_count Maximum hop count for the trace. The valid range is 1–255.
min_hop_count Minimum hop count for the trace. The valid range is 1–30.
source-interface ip_interface Source IP interface to be used in the traceroute packets.
probes probe_count The number of packets (retry) sent for each hop-count. The valid range
is 1–10000.
timeout seconds The time to wait for the response of each probe packet.
port port_number_value The destination port number to be used in the probing packets.

Defaults

parameter default
max-hop max_hop_count 30
min-hop min_hop_count 1
source-interface ip_interface Outgoing IP
interface as per
route lookup
probes probe_count 3
timeout seconds 5
port port_number_value 33334

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
When using this command, you must enter the name of the destination as part of the command line (either
the IP address or host name).

page 16-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands traceroute

Examples
-> traceroute 128.251.17.224

traceroute to 128.251.17.224, 30 hops max, 40 byte packets

1 10.255.11.254 0 ms 0 ms 0 ms
2 172.23.0.251 0 ms 16.6667 ms 0 ms
3 128.251.14.253 0 ms 0 ms 0 ms
4 128.251.17.224 0 ms 0 ms 0 ms

-> traceroute 128.251.17.224 max-hop 3

traceroute to 128.251.17.224, 3 hops max, 40 byte packets
1 10.255.11.254 0 ms 0 ms 0 ms
2 172.23.0.251 16.6667 ms 0 ms 0 ms
3 128.251.14.253 0 ms 0 ms 0 ms
-> traceroute 10.0.0.1 source-interface mgmt
-> traceroute 10.0.0.1 min-hop 3
-> traceroute 10.0.0.1 probes 3
-> traceroute 10.0.0.1 timeout 10
-> traceroute 10.0.0.1 port-number 1025

Release History
Release 8.1.1; command introduced

Related Commands
show ip routes Displays the IP Forwarding table.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-19
ip directed-broadcast IP Commands

ip directed-broadcast
Enables or disables IP directed broadcasts routed through the switch. An IP directed broadcast is an IP
datagram that has all zeros or all 1s in the host portion of the destination address. The packet is sent to the
broadcast address of a subnet to which the sender is not directly attached.
ip directed-broadcast {enable | disable}

Syntax Definitions
N/A

Defaults
The default value is disable.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Directed broadcasts are used in denial-of-service “smurf” attacks. In a smurf attack, a continuous stream of
ping requests are sent from a falsified source address to a directed broadcast address. This results in a large
stream of replies, which can overload the host of the source address. By default, the switch drops directed
broadcasts. Directed broadcasts must not be enabled.

Examples
-> ip directed-broadcast enable

Release History
Release 8.1.1; command introduced

Related Commands
show ip interface Displays the status and configuration of IP interfaces.
show ip routes Displays the IP Forwarding table.
show ip config Displays IP configuration parameters.

MIB Objects
alaIpDirectedBroadcast

page 16-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip service

ip service
Enables (opens) or disables (closes) well-known or user-defined TCP/UDP service ports. Selectively
enabling or disabling these types of ports provides an additional method for protecting against
unauthorized switch access or Denial of Service (DoS) attacks.
[vrf vrf_name] ip service {all | service_name | port service_port} admin-state {enable | disable}

Syntax Definitions

vrf_name The name of an existing VRF instance in which services are to be

enabled or disabled.
all Configures access to all TCP/UDP ports.
service_name The name of the TCP/UDP service to enable or disable. (Refer to the
table in the “Usage Guidelines” section for a list of supported service
names.)
service_port A TCP/UDP service port number. Configures access by port number
rather than by service name. (Refer to the table in the “Usage
Guidelines” section for a list of well-known port numbers.) If a user-
defined port number is specified, the valid range is 20000–20999.
enable Enables access to the service.
disable Disables access to the service.

Defaults
All TCP/UDP ports are open by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Using this command to enable or disable HTTP also enables or disables HTTPS and vice versa. To
enable or disable these protocols individually use the ip service port command.
• This command only applies to TCP/UDP service ports opened by default. It does not affect ports that
are opened by applications, such as RIP, BGP, and so on.
• Use the all option with this command to configure access to all well-known TCP/UDP service ports.

• To designate which port to enable or disable, specify either the name of a service or the well-known
port number associated with that service. Specifying a name and a port number in a single command
line is not supported.
• When using service names, it is possible to specify more than one service in a single command line by
entering each service name separated by a space. See the “Example” section for more information.
• When specifying a service port number, the port keyword is required and that only one port number is
allowed in a single command.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-21
ip service IP Commands

• The following table lists the ip service command options for specifying TCP/UDP services and also
includes the well-known port number associated with each service:

service name port

ftp 21
ssh 22
telnet 23
http 80
https 443
ntp 123
snmp 161

• If a VRF is specified, the service is enabled or disabled in the specified VRF. By default, the services
are enabled in the ‘default’ VRF.

Examples
-> ip service all admin-state disable
-> ip service ftp admin-state enable
-> ip service port 20000 admin-state enable
-> vrf vrf1 ip service ftp admin-state enable

Release History
Release 8.1.1; command introduced

Related Commands
ip service port Configures a user-defined TCP/UDP port for the specified service.
show ip service Displays the IP service TCP/UDP port configuration and status.

MIB Objects
alaIpServiceTable
alaIpServiceType
alaIpServicePort
alaIpServiceStatus
alaIpPortServiceTable
alaIpPortServicePort
alaIpPortServiceStatus

page 16-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip service port

ip service port
Configures a user-defined TCP/UDP service port for the specified service.
ip service {service_name} port {default | service_port}

Syntax Definitions

service_name The name of the TCP/UDP service to enable or disable. (Refer to the
table in the “Usage Guidelines” section for a list of supported service
names.)
default Sets the port back to the well-known port for the specified service.
service_port A TCP/UDP service port number (Refer to the table in the “Usage
Guidelines” section for a list of supported service names.) Valid range is
the default service port number or 20000-20999.

Defaults
By default, the service uses the well-known TCP/UDP port number for that service.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the default parameter with this command to set the port for the specified service back to the well-
known default port for that service. For example, if the FTP port was previously changed to “20000”,
then the ip service ftp port default command would set the FTP port back to “21”.
• The following table lists the ip service port command options for specifying TCP/UDP services and
also includes the default well-known port number associated with each service:

service name port

ftp 21
ssh 22
telnet 23
http 80
https 443

• The NTP and SNMP services are not supported with the ip service port command.

• Use the ip service command to enable or disable the status for a well-known or user-defined TCP/UDP
service port.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-23
ip service port IP Commands

Examples
-> ip service ftp port 20000
-> ip service ftp port default
-> ip service telnet port 20003
-> ip service telnet port default

Release History
Release 8.1.1; command introduced

Related Commands
ip service Enables or disables well-known or user-defined service ports.
show ip service Displays the IP service TCP/UDP port configuration and status.

MIB Objects
alaIpServiceTable
alaIpServiceType
alaIpServicePort
alaIpServiceStatus

page 16-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip service source-ip

ip service source-ip
Configures a user-defined source IP address as the outgoing IP interface for the IP service.
[vrf vrf_name] ip service source-ip {Loopback0 | interface_name} [tftp] [telnet] [tacacs] [swlog] [ssh]
[snmp] [sflow] [radius] [ntp] [ldap] [ftp] [dns] [all]
[vrf vrf_name] no ip service source-ip {Loopback0 | interface_name} [tftp] [telnet] [tacacs] [swlog]
[ssh] [snmp] [sflow] [radius] [ntp] [ldap] [ftp] [dns] [all]

Syntax Definitions

vrf_name Name of the VRF.

Loopback0 Uses the Loopback0 interface as the source IP for the IP service.
interface_name Specifies the name of the interface.
tftp Configures the source IP address to be used by TFTP.
telnet Configures the source IP address to be used by TELNET.
tacacs Configures the source IP address to be used by TACACS.
swlog Configures the source IP address to be used by SWLOG.
ssh Configures the source IP address to be used by SSH.
snmp Configures the source IP address to be used by SNMP.
sflow Configures the source IP address to be used by sFlow.
radius Configures the source IP address to be used by RADIUS.
ntp Configures the source IP address to be used by NTP.
ldap Configures the source IP address to be used by the LDAP server.
ftp Configures the source IP address to be used by FTP.
dns Configures the source IP address to be used by DNS.
all Configures the source IP address to be used by all the applications.

Defaults
By default, the outgoing interface is taken as the source IP address for all the applications.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If for a particular application, specific source IP address is configured and the “all” option is also set,
the configured source IP address for the application is used as the outgoing interface.
• Use the no form of this command to revert to the default behavior.

• This feature is supported on non-default VRF.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-25
ip service source-ip IP Commands

Examples
-> ip service source-ip Loopback0 ntp
-> ip service source-ip ipVlan100 ftp
-> no ip service source-ip Loopback0 ntp

Release History
Release 8.2.1; command introduced

Related Commands
show ip service source-ip Displays the source IP interfaces configured for the applications.

MIB Objects
alaIpServiceSourceIPTable
alaIpServiceSourceIPAppIndex
alaIpServiceSourceIPName

page 16-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip redist

ip redist
Controls the conditions for redistributing IPv4 routes between different protocols.
[vrf vrf_name] ip redist {local | static | rip | ospf | isis | bgp | import} into {rip | ospf | isis | bgp} {all-
routes | route-map route_map_name} [admin-state {enable | disable}]
no ip redist {local | static | rip | ospf | isis | bgp | import} into {rip | ospf | isis | bgp} [all-routes | route-
map | route_map_name]

Syntax Definitions

vrf_name The name of an existing VRF instance.

local Redistributes local routes.
static Redistributes static routes.
import Redistributes routes to other routing protocols that are imported.
rip Specifies RIP as the source or destination (into) protocol.
ospf Specifies OSPF as the source or destination (into) protocol.
isis Specifies IS-IS as the source or destination (into) protocol.
bgp Specifies BGP as the source or destination (into) protocol.
all-routes Redistributes all routes. This option does not allocate route-map
resources.
route_map_name Name of an existing route map that controls the redistribution of routes
between the source and destination protocol.
enable Enables the administrative status of the redistribution configuration.
disable Disables the administrative status of the redistribution configuration.

Defaults
If a VRF name is not specified with this command, routes are redistributed within the context of the active
VRF instance.

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a route map redistribution configuration. If a route map
name is not specified, all route maps associated with the redistribution configuration are removed.
• The source and destination protocols must be loaded and enabled before redistribution occurs.

• If the metric calculated for the redistributed route is greater than 15 (RIP_UNREACHABLE) or greater
than the metric of an existing pure RIP route, the new route is not redistributed.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-27
ip redist IP Commands

• Use the ip route-map commands described in this chapter to create a route map. Refer to the
“Configuring IP” chapter in the OmniSwitch AOS Release 8 Network Configuration Guide for more
information about how to create a route map.

Examples
-> ip redist rip into bgp route-map rip-to-bgp1
-> ip redist rip into bgp route-map rip-to-bgp2
-> no ip redist rip into bgp route-map rip-to-bgp2
-> ip redist ospf into rip route-map ospf-to-rip
-> ip redist ospf into rip route-map ospf-to-rip disable
-> ip redist import into ospf route-map R1 status enable

Release History
Release 8.1.1; command introduced

Related Commands

show ip redist Displays the route map redistribution configuration.

ip route-map action Creates a route map for selecting or filtering routes for tasks such as
redistribution and VRF route leaking. It also sets the action of the route
map to permit or deny.
ip import Configures a route map to import routes from GRT to the destination
VRF.
show ip import Displays the import route configuration details.

MIB Objects
alaRouteMapRedistProtoTable
alaRouteMapRedistSrcProtoId
alaRouteMapRedistDestProtoId
alaRouteMapRedistRouteMapIndex
alaRouteMapRedistStatus
alaRouteMapRedistAddressType
alaRouteMapRedistRowStatus

page 16-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip access-list

ip access-list
Creates an access list for adding multiple IPv4 addresses to route maps.
ip access-list access_list_name
no ip access-list access_list_name

Syntax Definitions

access_list_name Name of the access list (up to 20 characters).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to delete the access list.

Examples
-> ip access-list access1
-> no ip access-list access1

Release History
Release 8.1.1; command introduced

Related Commands

ip access-list address Adds IPv4 addresses to the specified IPv4 access list.
show ip access-list Displays the details of the access list.

MIB Objects
alaRouteMapAccessListNameTable
alaRouteMapAccessListName
alaRouteMapAccessListNameIndex
alaRouteMapAccessListNameAddressType
alaRouteMapAccessListNameRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-29
ip access-list address IP Commands

ip access-list address
Adds multiple IPv4 addresses to the specified IPv4 access list.
ip access-list access_list_name address address/prefixLen [action {permit | deny}] [redist-control {all-
subnets | no-subnets | aggregate}]
no ip access-list access_list_name address address/prefixLen

Syntax Definitions

access_list_name Name of the access list (up to 20 characters).

address/prefixLen IP address/prefix length to be added to the access list.
permit Permits the IP address.
deny Denies the IP address.
all-subnets Permits or denies all the subnet routes that match the network portion of
the IP address as specified by the mask length.
no-subnets Permits or denies only those routes that exactly match the IP address
and the mask length.
aggregate Permits an aggregate route if there are one or more routes that match or
are subnets of this address.

Defaults

parameter default
permit | deny permit
all-subnets | no-subnets | all-subnets
aggregate

Usage Guidelines
• Use the no form of this command to delete the address from the access list.

• The access_list_name must exist before you add multiple addresses to the list.

• The action parameters (permit and deny) determine if a route that matches the redist-control
configuration for the IP address is allowed or denied.
• The redist-control parameters (all-subnets, no-subnets, and aggregate) defines the criteria used to
determine if a route matches an address in the access list.
• Configuring the combination of redist-control aggregate with action deny is not allowed.

• Use this command multiple times with the same access list name to add multiple addresses to the
existing access list.

Examples
-> ip access-list access1 address 10.0.0.0/8 action permit
-> ip access-list access1 address 11.1.0.0/16 action permit

page 16-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip access-list address

-> ip access-list access1 address 10.1.1.0/24 redist-control aggregate

-> no ip access-list access1 address 10.0.0.0/8

Release History
Release 8.1.1; command introduced

Related Commands

ip access-list Creates an access list for adding multiple IPv4 addresses to route maps.
show ip access-list Displays the contents of an IPv4 access list.

MIB Objects
alaRouteMapAccessListTable
alaRouteMapAccessListIndex
alaRouteMapAccessListAddress
alaRouteMapAccessListAddressType
alaRouteMapAccessListPrefixLength
alaRouteMapAccessListAction
alaRouteMapAccessListRedistControl
alaRouteMapAccessListRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-31
ip route-map action IP Commands

ip route-map action
Creates a route map for selecting or filtering routes for tasks such as redistribution and VRF route leaking.
It also sets the action of the route map to permit or deny.
ip route-map route_map_name [sequence-number number] action {permit | deny}
no ip route-map route_map_name [sequence-number number]

Syntax Definitions

route_map_name The name of the route map (up to 20 characters).

number A number that links together the route maps. The range is 1–100.
permit Selects a route.
deny Filters a route.

Defaults

parameter default
number 50
permit | deny permit

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the entire route map by specifying only the
route_map_name.
• Use the no form of this command to delete a specific sequence in the route map by specifying the
sequence-number.
• All route maps having the same name but different sequence numbers are linked together and
processed in order of increasing sequence number.
• Use this command to change the status of an existing route map to permit or deny.

Examples
-> ip route-map route1 sequence-number 10 action permit
-> no ip route-map route1

Release History
Release 8.1.1; command introduced

page 16-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-map action

Related Commands

show ip route-map Displays the configured IP route maps.

MIB Objects
alaRouteMapSequenceTable
alaRouteMapSequenceIndex
alaRouteMapSequenceNumber
alaRouteMapSequenceAction
alaRouteMapSequenceRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-33
ip route-map match ip address IP Commands

ip route-map match ip address

Matches the route with the specified IPv4 address or an address defined in the specified IPv4 access list.
ip route-map route_map_name [sequence-number number] match ip-address {access_list_name |
ip_address/prefixLen [redist-control {all-subnets | no-subnets | aggregate}] [permit | deny]
no ip route-map route_map_name [sequence-number number] match ip-address {access_list_name |
ip_address/prefixLen [redist-control {all-subnets | no-subnets | aggregate}] [permit | deny]

Syntax Definitions

route_map_name The name of the route map (up to 20 characters).

number A number that links together the route maps. The range is 1–100.
access_list_name The name of an IPv4 access list that contains IPv4 addresses to match.
ip_address/prefixLen The destination IP address along with the prefix length of the routes to
be selected.
all-subnets Selects all the subnet routes that match the network portion of the IP
address as specified by the mask length.
no-subnets Selects only those routes that exactly match the IP address and the mask
length.
aggregate Creates an aggregate route if there are one or more routes that match the
IP address.
permit Permits a route based on the IP address or prefix constrained by redist-
control.
deny Denies a route based on the IP address or prefix constrained by redist-
control.

Defaults

parameter default
number 50
permit | deny permit

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the match ip-address redist-control parameter in the route
map.
• Specify either the name of an existing IPv4 access list or an IPv4 address/prefix length with this
command.
• Configuring the combination of redist-control aggregate with deny is not allowed.

• Multiple addresses in the same route map sequence are matched using the longest prefix match.

page 16-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-map match ip address

• If the best matching address is type deny, then the route is not selected. If the best matching address is
type permit and the route map action is deny, the route is not selected.
• All route maps having the same name but different sequence numbers are linked together and
processed in order of increasing sequence number.
• The route_map_name, sequence-number, and access_list_name (if used) must exist before you
configure this match criteria.

Examples
-> ip route-map 3 match ip-address 10.1.1.1/8 redist-control no-subnets deny
-> no ip route-map 3 match ip-address 10.1.1.1 redist-control no-subnets deny
-> ip route-map route1 sequence-number 10 match ip-address list1
-> no ip route-map route1 sequence-number 10 match ip-address list1

Release History
Release 8.1.1; command introduced

Related Commands

ip route-map action Creates a route map for selecting or filtering routes for tasks such as
redistribution and VRF route leaking. It also sets the action of the route
map to permit or deny.
ip access-list Creates an access list for adding multiple IPv4 addresses to route maps.
ip access-list address Adds IPv4 addresses to the specified IPv4 access list.
show ip route-map Displays the configured IP route maps.

MIB Objects
alaRouteMapTable
alaRouteMapIndex
alaRouteMapSequence
alaRouteMapType
alaRouteMapValue
alaRouteMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-35
ip route-map match ipv6 address IP Commands

ip route-map match ipv6 address

Matches the route with the specified IPv6 address or an address defined in the specified IPv6 access list.
ip route-map route_map_name [sequence-number number] match ipv6-address {access_list_name |
ipv6_address/prefixLen [redist-control {all-subnets | no-subnets | aggregate}] [permit | deny]
no ip route-map route_map_name [sequence-number number] match ipv6-address ipv6_address/
prefixLen [redist-control {all-subnets | no-subnets | aggregate}] [permit | deny]

Syntax Definitions

route_map_name The name of the route map (up to 20 characters).

number A number that links together the route maps. The range is 1–100.
access_list_name The name of an IPv4 access list that contains IPv4 addresses to match.
ipv6_address/prefixLen The destination IPv6 address along with the prefix length of the routes
to be selected.
all-subnets Selects all the subnet routes that match the network portion of the IP
address as specified by the mask length.
no-subnets Selects only those routes that exactly match the IP address and the mask
length.
aggregate Creates an aggregate route if there are one or more routes that match the
IPv6 address.
permit Permits a route based on the IPv6 address or prefix constrained by
redist-control.
deny Denies a route based on the IPv6 address or prefix constrained by redist-
control.

Defaults

parameter default
number 50
permit | deny permit

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the match ipv6-address redist-control parameter in the
route map.
• Specify either the name of an existing IPv6 access list or an IPv6 address/prefix length with this
command.
• Configuring the combination of redist-control aggregate with deny is not allowed.

• Multiple addresses in the same route map sequence are matched using the longest prefix match.

page 16-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-map match ipv6 address

• If the best matching address is type deny, then the route is not selected. If the best matching address is
type permit and the route map action is deny, the route is not selected.
• All route maps having the same name but different sequence numbers are linked together and
processed in order of increasing sequence number.
• The route_map_name and sequence-number must exist before you configure this match criteria.

Examples
-> ip route-map 3 match ipv6-address 2001::1/64 redist-control no-subnets deny
-> no ip route-map 3 match ipv6-address 2001::1/64 redist-control no-subnets deny
-> ip route-map route1 sequence-number 10 match ipv6-address list1
-> no ip route-map route1 sequence-number 10 match ipv6-address list1

Release History
Release 8.1.1; command introduced

Related Commands

ip route-map action Creates a route map for selecting or filtering routes for tasks such as
redistribution and VRF route leaking. It also sets the action of the route
map to permit or deny.
ipv6 access-list Creates an access list for adding multiple IPv6 addresses to route maps.
ipv6 access-list address Adds IPv6 addresses to the specified IPv6 access list.
show ip route-map Displays the configured IP route maps.

MIB Objects
alaRouteMapTable
alaRouteMapIndex
alaRouteMapSequence
alaRouteMapType
alaRouteMapValue
alaRouteMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-37
ip route-map match ip-nexthop IP Commands

ip route-map match ip-nexthop

Matches any routes that have a next-hop router address permitted by the specified access list name or the
IP address specified in the route map.
ip route-map route_map_name [sequence-number number] match ip-nexthop {access_list_name |
ip_address/prefixLen [permit | deny]}
no ip route-map route_map_name [sequence-number number] match ip-nexthop {access_list_name |
ip_address/prefixLen [permit | deny]}

Syntax Definitions

route_map_name The name of the route map (up to 20 characters).

number A number that links together the route maps. The range is 1–100.
access_list_name The name of the access list that matches the route nexthop IP address.
ip_address/prefixLen The IP address along with the prefix length that matches any nexthop IP
address within the specified subnet.
permit Permits a route based on the IP nexthop.
deny Denies a route based on the IP nexthop.

Defaults

parameter default
number 50
permit | deny permit

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the match ip-nexthop parameter in the route map.

• If the best matching nexthop is type deny, then the route is not selected. If the best matching nexthop is
type permit and the route map action is deny, the route is not selected.
• All route maps having the same name but different sequence numbers are linked together and
processed in order of increasing sequence number.
• The route_map_name, sequence-number, and access_list_name must exist before you configure this
match criteria.

page 16-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-map match ip-nexthop

Examples
-> ip route-map route1 sequence-number 10 match ip-nexthop list1
-> no ip route-map route1 sequence-number 10 match ip-nexthop list1
-> ip route-map route1 sequence-number 10 match ip-nexthop 10.0.0.0/8
-> no ip route-map route1 sequence-number 10 match ip-nexthop 10.0.0.0/8

Release History
Release 8.1.1; command introduced

Related Commands

ip access-list Creates an access list for adding multiple IPv4 addresses to route maps.
ip route-map action Creates a route map for selecting or filtering routes for tasks such as
redistribution and VRF route leaking. It also sets the action of the route
map to permit or deny.
show ip route-map Displays the configured IP route maps.

MIB Objects
alaRouteMapTable
alaRouteMapIndex
alaRouteMapSequence
alaRouteMapType
alaRouteMapValue
alaRouteMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-39
ip route-map match ipv6-nexthop IP Commands

ip route-map match ipv6-nexthop

Matches any routes that have an IPv6 next-hop router address permitted by the specified access list name
or the IPv6 address specified in the route map.
ip route-map route_map_name [sequence-number number] match ipv6-nexthop {access_list_name |
ipv6_address/prefixLen [permit | deny]}
no ip route-map route_map_name [sequence-number number] match ipv6-nexthop {access_list_name |
ipv6_address/prefixLen [permit | deny]}

Syntax Definitions

route_map_name The name of the route map (up to 20 characters).

number A number that links together the route maps. The range is 1–100.
access_list_name The name of the access list that matches the route nexthop IPv6 address.
ipv6_address/prefixLen The IPv6 address along with the prefix length that matches any nexthop
IPv6 address within the specified subnet.
permit Permits a route based on the IPv6 nexthop.
deny Denies a route based on the IPv6 nexthop.

Defaults

parameter default
number 50
permit | deny permit

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the match ipv6-nexthop parameter in the route map.

• If the best matching nexthop is type deny, then the route is not selected. If the best matching nexthop is
type permit but the route map action is deny, the route is not selected.
• All route maps having the same name but different sequence numbers are linked together and
processed in order of increasing sequence number.
• The route_map_name, sequence-number, and access_list_name must exist before you configure this
match criteria.

page 16-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-map match ipv6-nexthop

Examples
-> ip route-map route1 sequence-number 10 match ipv6-nexthop list1
-> no ip route-map route1 sequence-number 10 match ipv6-nexthop list1
-> ip route-map route1 sequence-number 10 match ipv6-nexthop 2001::/64
-> no ip route-map route1 sequence-number 10 match ipv6-nexthop 2001::/64

Release History
Release 8.1.1; command introduced

Related Commands

ipv6 access-list Creates an access list for adding multiple IPv6 addresses to route maps.
ipv6 access-list address Adds IPv6 addresses to the specified IPv6 access list.
ip route-map action Creates a route map for selecting or filtering routes for tasks such as
redistribution and VRF route leaking. It also sets the action of the route
map to permit or deny.
show ip route-map Displays the configured IP route maps.

MIB Objects
alaRouteMapTable
alaRouteMapIndex
alaRouteMapSequence
alaRouteMapType
alaRouteMapValue
alaRouteMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-41
ip route-map match tag IP Commands

ip route-map match tag

Matches the tag value specified in the route map with the one that the routing protocol learned the route
on.
ip route-map route_map_name [sequence-number number] match tag tag-number
no ip route-map route_map_name [sequence-number number] match tag tag-number

Syntax Definitions

route_map_name The name of the route map (up to 20 characters).

number A number that links together the route maps. The range is 1–100.
tag-number The tag number.

Defaults

parameter default
number 50

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the match tag parameter in the route map.

• All route maps having the same name but different sequence numbers are linked together and
processed in order of increasing sequence number.
• The route_map_name and sequence-number must exist before you configure this match criteria.

Examples
-> ip route-map route1 sequence-number 10 match tag 4
-> no ip route-map route1 sequence-number 10 match tag 4

Release History
Release 8.1.1; command introduced

Related Commands

ip route-map action Creates a route map for selecting or filtering routes for tasks such as
redistribution and VRF route leaking. It also sets the action of the route
map to permit or deny.
show ip route-map Displays the configured IP route maps.

page 16-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-map match tag

MIB Objects
alaRouteMapTable
alaRouteMapIndex
alaRouteMapSequence
alaRouteMapType
alaRouteMapValue
alaRouteMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-43
ip route-map match ipv4-interface IP Commands

ip route-map match ipv4-interface

Matches the IPv4 interface name specified in the route map with the one that the routing protocol learned
the route on.
ip route-map route_map_name [sequence-number number] match ipv4-interface interface-name
no ip route-map route_map_name [sequence-number number] match ipv4-interface interface-name

Syntax Definitions

route_map_name The name of the route map (up to 20 characters).

number A number that links together the route maps. The range is 1–100.
interface-name Specifies the interface name of the outgoing interface of the route.

Defaults

parameter default
number 50

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the match ipv4-interface parameter in the route map.

• All route maps having the same name but different sequence numbers are linked together and
processed in order of increasing sequence number.
• The route_map_name and sequence-number must exist before you configure this match criteria.

Examples
-> ip route-map route1 sequence-number 10 match ipv4-interface int4
-> no ip route-map route1 sequence-number 10 match ipv4-interface int4

Release History
Release 8.1.1; command introduced

Related Commands

ip route-map action Creates a route map for selecting or filtering routes for tasks such as
redistribution and VRF route leaking. It also sets the action of the route
map to permit or deny.
show ip route-map Displays the configured IP route maps.

page 16-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-map match ipv4-interface

MIB Objects
alaRouteMapTable
alaRouteMapIndex
alaRouteMapSequence
alaRouteMapType
alaRouteMapValue
alaRouteMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-45
ip route-map match ipv6-interface IP Commands

ip route-map match ipv6-interface

Matches the IPv6 interface name specified in the route map with the one that the routing protocol learned
the route on.
ip route-map route_map_name [sequence-number number] match ipv6-interface interface-name
no ip route-map route_map_name [sequence-number number] match ipv6-interface interface-name

Syntax Definitions

route_map_name The name of the route map (up to 20 characters).

number A number that links together the route maps. The range is 1–100.
interface-name Specifies the interface name of the outgoing interface of the route.

Defaults

parameter default
number 50

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the match ipv6-interface parameter in the route map.

• All route maps having the same name but different sequence numbers are linked together and
processed in order of increasing sequence number.
• The route_map_name and sequence-number must exist before you configure this match criteria.

Examples
-> ip route-map route1 sequence-number 10 match ipv6-interface int6
-> no ip route-map route1 sequence-number 10 match ipv6-interface int6

Release History
Release 8.1.1; command introduced

Related Commands

ip route-map action Creates a route map for selecting or filtering routes for tasks such as
redistribution and VRF route leaking. It also sets the action of the route
map to permit or deny.
show ip route-map Displays the configured IP route maps.

page 16-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-map match ipv6-interface

MIB Objects
alaRouteMapTable
alaRouteMapIndex
alaRouteMapSequence
alaRouteMapType
alaRouteMapValue
alaRouteMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-47
ip route-map match metric IP Commands

ip route-map match metric

Matches the metric value specified in the route map with the actual metric value of the route.
ip route-map route_map_name [sequence-number number] match metric metric [deviation deviation]
no ip route-map route_map_name [sequence-number number] match metric metric [deviation
deviation]

Syntax Definitions

route_map_name The name of the route map (up to 20 characters).

number A number that links together the route maps. The range is 1–100.
metric The metric value that matches a specified metric.
deviation The deviation value. If deviation is included, the route metric can have
any value within the range (metric-deviation to metric+deviation).

Defaults

parameter default
number 50

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the match metric parameter in the route map.

• All route maps having the same name but different sequence numbers are linked together and
processed in order of increasing sequence number.
• The route_map_name and sequence-number must exist before you configure this match criteria.

Examples
-> ip route-map route1 sequence-number 10 match metric 4
-> no ip route-map route1 sequence-number 10 match metric 4

Release History
Release 8.1.1; command introduced

page 16-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-map match metric

Related Commands

ip route-map action Creates a route map for selecting or filtering routes for tasks such as
redistribution and VRF route leaking. It also sets the action of the route
map to permit or deny.
show ip route-map Displays the configured IP route maps.

MIB Objects
alaRouteMapTable
alaRouteMapIndex
alaRouteMapSequence
alaRouteMapType
alaRouteMapValue
alaRouteMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-49
ip route-map match route-type IP Commands

ip route-map match route-type

Matches the specified route type with actual route type of the route.
ip route-map route_map_name [sequence-number number] match route-type {internal | external
[type1 | type2] | level1 | level2}
no ip route-map route_map_name [sequence-number number] match route-type {internal | external
[type1 | type2] | level1 | level2}

Syntax Definitions

route_map_name The name of the route map (up to 20 characters).

number A number that links together the route maps. The range is 1–100.
internal Matches OSPF/BGP internal routes.
external Matches OSPF/BGP external routes.
type1 Matches OSPF external Type-1 routes, which gives the full metric
calculation for the complete path including internal as well as external
cost.
type2 Matches OSPF external Type-2 routes, which gives the external
redistribution metric only to the ASBR.
level1 Matches IS-IS Level-1 routes only.
level2 Matches IS-IS Level-2 routes only.

Defaults

parameter default
number 50

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the match route-type parameter in the route map.

• All route maps having the same name but different sequence numbers are linked together and
processed in order of increasing sequence number.
• The route_map_name and sequence-number must exist before you configure this match criteria.

Examples
-> ip route-map 111 sequence-number 50 match route-type internal
-> no ip route-map 111 sequence-number 50 match route-type internal

page 16-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-map match route-type

Release History
Release 8.1.1; command introduced

Related Commands

ip route-map action Creates a route map for selecting or filtering routes for tasks such as
redistribution and VRF route leaking. It also sets the action of the route
map to permit or deny.
show ip route-map Displays the configured IP route maps.

MIB Objects
alaRouteMapTable
alaRouteMapIndex
alaRouteMapSequence
alaRouteMapType
alaRouteMapValue
alaRouteMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-51
ip route-map match protocol IP Commands

ip route-map match protocol

Matches the protocol specified in the route map with the protocol of the route.
ip route-map route_map_name [sequence-number number] match protocol {local | static | rip | ospf |
isis | bgp}
no ip route-map route_map_name [sequence-number number] match protocol {local | static | rip | ospf
| isis | bgp}

Syntax Definitions

route_map_name The name of the route map (up to 20 characters).

number A number that links together the route maps. The range is 1–100.
local Matches a local interface route.
static Matches a static route.
rip Matches a RIP route.
ospf Matches an OSPF route.
isis Matches an IS-IS route.
bgp Matches a BGP route.

Defaults

parameter default
number 50

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the match protocol parameter in the route map.

• All route maps having the same name but different sequence numbers are linked together and
processed in order of increasing sequence number.
• The route_map_name and sequence-number must exist before you configure this match criteria.

Examples
-> ip route-map route1 sequence-number 10 match protocol local
-> no ip route-map route1 sequence-number 10 match protocol local

Release History
Release 8.1.1; command introduced

page 16-52 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-map match protocol

Related Commands

ip route-map action Creates a route map for selecting or filtering routes for tasks such as
redistribution and VRF route leaking. It also sets the action of the route
map to permit or deny.
show ip route-map Displays the configured IP route maps.

MIB Objects
alaRouteMapTable
alaRouteMapIndex
alaRouteMapSequence
alaRouteMapType
alaRouteMapValue
alaRouteMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-53
ip route-map set metric IP Commands

ip route-map set metric

Configures the metric value of the route being distributed.
ip route-map route_map_name [sequence-number number] set metric metric [effect {add | subtract |
replace | none}]
no ip route-map route_map_name [sequence-number number] set metric metric [effect {add | subtract
| replace | none}]

Syntax Definitions

route_map_name The name of the route map (up to 20 characters).

number A number that links together the route maps. The range is 1–100.
metric Configures the metric value of the route. A value of 0 is not allowed.
add Adds the configured metric value to the actual metric value.
subtract Subtracts the configured metric value from the actual metric value.
replace Replaces the actual metric value with the configured metric value.
none Uses the actual metric value of the route. The configured metric value is
ignored. Use any value except 0.

Defaults

parameter default
number 50

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the set metric parameter in the route map.

• All route maps having the same name but different sequence numbers are linked together and
processed in order of increasing sequence number.
• The route_map_name and sequence-number must exist before you configure this set criteria.

Examples
-> ip route-map 111 sequence-number 50 set metric 30 effect add
-> no ip route-map 111 sequence-number 50 set metric 30 effect add

Release History
Release 8.1.1; command introduced

page 16-54 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-map set metric

Related Commands

ip route-map action Creates a route map for selecting or filtering routes for tasks such as
redistribution and VRF route leaking. It also sets the action of the route
map to permit or deny.
show ip route-map Displays the configured IP route maps.

MIB Objects
alaRouteMapTable
alaRouteMapIndex
alaRouteMapSequence
alaRouteMapType
alaRouteMapValue
alaRouteMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-55
ip route-map set metric-type IP Commands

ip route-map set metric-type

Configures the metric type for the redistributed route.
ip route-map route_map_name [sequence-number number] set metric-type {internal | external [type1 |
type2]}
no ip route-map route_map_name [sequence-number number] set metric-type {internal | external
[type1 | type2]}

Syntax Definitions

route_map_name The name of the route map (up to 20 characters).

number A number that links together the route maps. The range is 1–100.
internal Sets the metric type to internal for routes redistributed into BGP.
external Sets the metric type to external for routes redistributed into BGP.
type1 Sets the metric type to external type1 for routes redistributed into OSPF,
which gives the full metric calculation for the complete path including
internal as well as external cost.
type2 Sets the metric type to external type2 for routes redistributed into OSPF,
which gives the external redistribution metric only to the ASBR.

Defaults

parameter default
number 50

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the set metric-type parameter in the route map.

• All route maps having the same name but different sequence numbers are linked together and
processed in order of increasing sequence number.
• The route_map_name and sequence-number must exist before you configure this set criteria.

Examples
-> ip route-map 111 sequence-number 50 set metric-type internal
-> no ip route-map 111 sequence-number 50 set metric-type internal

Release History
Release 8.1.1; command introduced

page 16-56 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-map set metric-type

Related Commands

ip route-map action Creates a route map for selecting or filtering routes for tasks such as
redistribution and VRF route leaking. It also sets the action of the route
map to permit or deny.
show ip route-map Displays the configured IP route maps.

MIB Objects
alaRouteMapTable
alaRouteMapIndex
alaRouteMapSequence
alaRouteMapType
alaRouteMapValue
alaRouteMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-57
ip route-map set tag IP Commands

ip route-map set tag

Configures the tag value of the selected routes.
ip route-map route_map_name [sequence-number number] set tag tag-number
no ip route-map route_map_name [sequence-number number] set tag tag-number

Syntax Definitions

route_map_name The name of the route map (up to 20 characters).

number A number that links together the route maps. The range is 1–100.
tag-number Configures the tag number.

Defaults

parameter default
number 50

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the set tag parameter in the route map.

• All route maps having the same name but different sequence numbers are linked together and
processed in order of increasing sequence number.
• The route_map_name and sequence-number must exist before you configure this set criteria.

Examples
-> ip route-map 111 sequence-number 50 set tag 23
-> no ip route-map 111 sequence-number 50 set tag 23

Release History
Release 8.1.1; command introduced

Related Commands

ip route-map action Creates a route map for selecting or filtering routes for tasks such as
redistribution and VRF route leaking. It also sets the action of the route
map to permit or deny.
show ip route-map Displays the configured IP route maps.

page 16-58 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-map set tag

MIB Objects
alaRouteMapTable
alaRouteMapIndex
alaRouteMapSequence
alaRouteMapType
alaRouteMapValue
alaRouteMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-59
ip route-map set community IP Commands

ip route-map set community

Configures the community name of the route being redistributed into BGP.
ip route-map route_map_name [sequence-number number] set community community_string
no ip route-map route_map_name [sequence-number number] set community community_string

Syntax Definitions

route_map_name The name of the route map (up to 20 characters).

number A number that links together the route maps. The range is 1–100.
community_string Defines a community for an aggregate route. Community names range
from 0 to 70 characters.

Defaults

parameter default
number 50

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the set community parameter in the route map.

• All route maps having the same name but different sequence numbers are linked together and
processed in order of increasing sequence number.
• The route_map_name and sequence-number must exist before you configure this set criteria.

Examples
-> ip route-map 111 sequence-number 50 set community 29
-> no ip route-map 111 sequence-number 50 set community 29

Release History
Release 8.1.1; command introduced

Related Commands

ip route-map action Creates a route map for selecting or filtering routes for tasks such as
redistribution and VRF route leaking. It also sets the action of the route
map to permit or deny.
show ip route-map Displays the configured IP route maps.

page 16-60 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-map set community

MIB Objects
alaRouteMapTable
alaRouteMapIndex
alaRouteMapSequence
alaRouteMapType
alaRouteMapValue
alaRouteMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-61
ip route-map set local-preference IP Commands

ip route-map set local-preference

Configures the local preference value for a route being distributed into BGP.
ip route-map route_map_name [sequence-number number] set local-preference value
no ip route-map route_map_name [sequence-number number] set local-preference value

Syntax Definitions

route_map_name The name of the route map (up to 20 characters).

number A number that links together the route maps. The range is 1–100.
value Configures the local-preference value for routes being redistributed in to
BGP. The range is 0–4294967295.

Defaults

parameter default
number 50

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the set local-preference parameter in the route map.

• All route maps having the same name but different sequence numbers are linked together and
processed in order of increasing sequence number.
• The route_map_name and sequence-number must exist before you configure this set criteria.

• The local preference attribute is used to set preference to an exit point from the local autonomous
system (AS).
• If there are multiple exit points from the AS, the local preference attribute is used to select the exit
point for a specific route.

Examples
-> ip route-map 111 sequence-number 50 set local-preference 4
-> no ip route-map 111 sequence-number 50 set local-preference 4

Release History
Release 8.1.1; command introduced

page 16-62 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-map set local-preference

Related Commands

ip route-map action Creates a route map for selecting or filtering routes for tasks such as
redistribution and VRF route leaking. It also sets the action of the route
map to permit or deny.
show ip route-map Displays the configured IP route maps.

MIB Objects
alaRouteMapTable
alaRouteMapIndex
alaRouteMapSequence
alaRouteMapType
alaRouteMapValue
alaRouteMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-63
ip route-map set level IP Commands

ip route-map set level

Configures the level of the selected ISIS route.
ip route-map route_map_name [sequence-number number] set level {level1 | level2 | level1-2}
no ip route-map route_map_name [sequence-number number] set level {level1 | level2 | level1-2}

Syntax Definitions

route_map_name The name of the route map (up to 20 characters).

number A number that links together the route maps. The range is 1–100.
level1 Matches IS-IS Level-1 routes only.
level2 Matches IS-IS Level-2 routes only.
level1-2 Matches IS-IS Level1-2 routes.

Defaults

parameter default
number 50

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the set level parameter in the route map.

• All route maps having the same name but different sequence numbers are linked together and
processed in order of increasing sequence number.
• The route_map_name and sequence-number must exist before you configure this set criteria.

Examples
-> ip route-map 111 sequence-number 50 set level level1
-> no ip route-map 111 sequence-number 50 set level level1

Release History
Release 8.1.1; command introduced

page 16-64 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-map set level

Related Commands

ip route-map action Creates a route map for selecting or filtering routes for tasks such as
redistribution and VRF route leaking. It also sets the action of the route
map to permit or deny.
show ip route-map Displays the configured IP route maps.

MIB Objects
alaRouteMapTable
alaRouteMapIndex
alaRouteMapSequence
alaRouteMapType
alaRouteMapValue
alaRouteMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-65
ip route-map set ip-nexthop IP Commands

ip route-map set ip-nexthop

Configures the IP address of the next hop in a route map.
ip route-map route_map_name [sequence-number number] set ip-nexthop ip_address
no ip route-map route_map_name [sequence-number number] set ip-nexthop ip_address

Syntax Definitions

route_map_name The name of the route map (up to 20 characters).

number A number that links together the route maps. The range is 1–100.
ip_address IP address of the next hop.

Defaults

parameter default
number 50

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the set ip-nexthop parameter in the route map.

• All route maps having the same name but different sequence numbers are linked together and
processed in order of increasing sequence number.
• The route_map_name and sequence-number must exist before you configure this set criteria.

Examples
-> ip route-map 222 sequence-number 50 set ip-nexthop 128.251.17.224
-> no ip route-map 222 sequence-number 50 set ip-nexthop 128.251.17.224

Release History
Release 8.1.1; command introduced

page 16-66 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-map set ip-nexthop

Related Commands

ip route-map action Creates a route map for selecting or filtering routes for tasks such as
redistribution and VRF route leaking. It also sets the action of the route
map to permit or deny.
show ip route-map Displays the configured IP route maps.

MIB Objects
alaIPRouteMapTable
alaRouteMapIndex
alaRouteMapSequence
alaRouteMapType
alaRouteMapValue
alaRouteMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-67
ip route-map set ipv6-nexthop IP Commands

ip route-map set ipv6-nexthop

Configures the IPv6 address of the next hop in a route map.
ip route-map route_map_name [sequence-number number] set ipv6-nexthop ipv6_address
no ip route-map route_map_name [sequence-number number] set ipv6-nexthop ipv6_address

Syntax Definitions

route_map_name The name of the route map (up to 20 characters).

number A number that links together the route maps. The range is 1–100.
ip6_address IPv6 address of the next hop.

Defaults

parameter default
number 50

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the set ipv6-nexthop parameter in the route map.

• All route maps having the same name but different sequence numbers are linked together and
processed in order of increasing sequence number.
• The route_map_name and sequence-number must exist before you configure this set criteria.

Examples
-> ip route-map 222 sequence-number 50 set ipv6-nexthop 2001::1
-> no ip route-map 222 sequence-number 50 set ipv6-nexthop 2001::1

Release History
Release 8.1.1; command introduced

page 16-68 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip route-map set ipv6-nexthop

Related Commands

ip route-map action Creates a route map for selecting or filtering routes for tasks such as
redistribution and VRF route leaking. It also sets the action of the route
map to permit or deny.
show ip route-map Displays the configured IP route maps.

MIB Objects
alaIPRouteMapTable
alaRouteMapIndex
alaRouteMapSequence
alaRouteMapType
alaRouteMapValue
alaRouteMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-69
vrf IP Commands

vrf
Configures and selects a virtual routing and forwarding (VRF) instance on the switch.
vrf [vrf_name | default] [profile {max | low}]
no vrf vrf_name

Syntax Definitions

vrf_name The alphanumeric name (1–20 characters) assigned to the VRF instance.
default Optional. Selects the default VRF instance.
max Creates a VRF with the maximum profile capabilities.
low Creates a VRF with the minimum (lowest) capabilities. Low profile
VRFs use less system resources.

Defaults
A default VRF instance exists in the switch configuration. All applications that are not VRF aware belong
to this instance.

Parameter Default
vrf_name | default default VRF instance
max | low max profile

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete a VRF instance. Deleting the default instance is not
allowed. In addition, any interfaces configured for a VRF instance are automatically removed when the
instance is deleted.
• To return to the default VRF instance from within the context of another instance, enter the vrf
command with or without the optional default parameter (for example, vrf or vrf default).
• Configuring a VRF instance name is case sensitive. In addition, if the name specified does not exist, a
VRF instance is automatically created. As a result, it is possible to create instances or delete a wrong
instance accidentally.
• If the name of an existing instance is specified with this command, VRF changes the command prompt
to reflect the specified instance name. All CLI commands entered at this point are applied within the
context of the active VRF instance.
• It is also possible to configure other instances from within the CLI context of the default VRF instance
by entering the vrf command followed by the instance name. For example, entering vrf IpOne ip
interface intf100 address 100.1.1.1/24 vlan 100 is applied to the IpOne instance even though IpOne is
not the active CLI context.

page 16-70 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands vrf

• The type of profile assigned to a VRF instance determines the routing protocols and capabilities
supported within that instance. For example, low profile VRFs only support IPv4 and VRRP with
routing capabilities restricted to static and imported routes. In addition, limiting low profiles to 9 routes
and 3 IP interfaces is highly recommended.
• Profiles are not configurable for the default VRF, which provides full routing capabilities.

• Changing the profile for an existing VRF instance is not allowed. To change the profile, first delete the
VRF then create it again with a different profile.

Examples
-> vrf IpOne
IpOne:: ->

IpOne:: -> vrf IpTwo

IpTwo:: ->

IpTwo:: -> vrf

->

IpTwo:: -> vrf default

->

-> vrf IpOne ip interface intf100 address 100.1.1.1/24 vlan 100

->

-> vrf IpThree profile low

IpThree::->

Release History
Release 8.1.1; command introduced

Related Commands

show vrf Displays the VRF instance configuration for the switch.
show vrf-profiles Displays the VRF profile resources for the switch.
ip export Exports VRF routes to the Global Routing Table (GRT).
ip import Imports VRF routes from the GRT.

MIB Objects
alaVirutalRouterNameTable
alaVirtualRouterName
alaVirtualRouterNameIndex
alaVirtualRouterNameRowStatus
alaVirtualRouterProfile

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-71
ip export IP Commands

ip export
Exports routes from the source VRF to the Global Routing Table (GRT) or to all VRF instances. All routes
are exported or a route map can be specified to filter exported routes
[vrf vrf_name] ip export {all-routes | route-map route_map_name | to-all-vrfs {all-routes | route-map
route_map_name}}
[vrf vrf_name] no ip export

Syntax Definitions

vrf_name The name of an existing VRF instance. Routes are exported from this
source VRF to the GRT.
all-routes Exports all routes from the source VRF to the GRT. This option does
not allocate route-map resources.
route_map_name The name of an existing route-map to use for filtering routes that are
exported from the source VRF to the GRT.
to-all-vrfs all-routes Exports all routes to all of the other VRF instances, except to VRFs that
already have an import configured for the source (export) VRF.
to-all-vrfs route_map_name The name of an existing route map to use for filtering routes that are
exported from the source VRF to all other VRF instances.

Defaults
• If a source VRF name is not specified with this command, routes are exported from within the context
of the active VRF instance to the GRT.
• If there are no VRF instances configured on the switch, the routes are exported from the default VRF to
the GRT.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable exporting of routes from the VRF to GRT.

• The route map name specified with this command must already exist in the switch configuration. See
the ip route-map commands in this guide and the “Configuring IP” chapter in the OmniSwitch AOS
Release 8 Network Configuration Guide for more information about how to create a route map.
• A route map created to filter exported VRF routes can contain any of the following match and set
options:
– Match options: ip-address, ip-next-hop, tag, protocol, ipv4-interface, metric, route-type
– Set options: tag, metric
• Only one route map per source VRF or ISID is allowed for filtering exported routes.

• Only those FDB (Forwarding Routing Database) routes that match the conditions of the route map are
exported to GRT.

page 16-72 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip export

• Modifying a route map that is assigned to a VRF or ISID through the ip import or ip export command
is not supported.

Examples
The following commands export routes from the current VRF routing table (or from the default VRF if
there are no other VRFs configured) to the GRT:
-> ip export route-map R1
-> ip export all-routes
-> ip export to-all-vrfs all-routes
-> ip export to-all-vrfs route-map R2
-> no ip export

The following commands export routes from the “vrf2” routing table to the GRT even though the
command line is operating within the context of the default VRF instance:
-> vrf vrf2 ip export route-map R1
-> vrf vrf2 ip export all-routes
-> vrf vrf2 ip export to-all-vrfs all-routes
-> vrf vrf2 ip export to-all-vrfs route-map R2
-> no vrf vrf2 ip export

The following commands first change the command line context to the “vrf1” instance so that all
subsequent commands export routes from “vrf1” without having to specify the VRF name with each
command:
-> vrf vrf1
vrf1::-> ip export route-map R1
vrf1::-> ip export all-routes
vrf1::-> ip export to-all-vrfs all-routes
vrf1::-> ip export to-all-vrfs route-map R2
vrf1::-> no ip export

Release History
Release 8.1.1; command introduced

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-73
ip export IP Commands

Related Commands
vrf Configures and selects a virtual routing and forwarding (VRF)
instance on the switch.
ip route-map action Creates a route map for selecting or filtering routes for tasks such
as redistribution and VRF route leaking. It also sets the action of
the route map to permit or deny.
ip route-map match protocol Matches the protocol specified in the route map with the protocol
of the route.
show ip export Displays the export route configuration details.
show ip global-route-table Displays the GRT for all the routes that are exported from the
VRFs.
show ip route-map Displays the configured IP route maps.

MIB Objects
alaIprmExportRouteMap
alaIprmExportToAllVrfsRouteMap

page 16-74 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip import

ip import
Imports VRF or Shortest Path Bridging (SPB) service instance identifier (ISID) routes from the GRT to
the destination VRF. All routes are imported or a route map can be specified to filter imported routes.
[vrf dest_vrf_name] ip import {vrf {src_vrf_name | default} | isid instance_id} {all-routes | route-map
route_map_name}
[vrf dest_vrf_name] no ip import {vrf {src_vrf_name | default} | isid instance_id}

Syntax Definitions

dest_vrf_name The name of the destination VRF instance into which routes are
imported from the GRT.
src_vrf_name The name of the source VRF instance for which routes are imported
from the GRT into the destination VRF instance.
default Default VRF. The routes are imported from the default VRF instance.
instance_id An existing ISID number that identifies a SPB service in a provider
backbone bridge (PBB) network. The routes for this ISID number are
imported from the GRT into the current or specified VRF instance.
all-routes Imports all routes from the source VRF instance. Imported routes are
not filtered.
route_map_name The name of an existing route map to use for filtering routes that are
imported from the GRT to the destination VRF. Imported routes are
filtered based on the options defined in the route map.

Defaults
If a destination VRF name is not specified with this command, routes are imported from the GRT into the
context of the active VRF instance.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the IP import routes configuration for the specified VRF
instance or ISID.
• The route map name specified with this command must already exist in the switch configuration. See
the ip route-map commands in this guide and the “Configuring IP” chapter in the OmniSwitch AOS
Release 8 Network Configuration Guide for more information about how to create a route map.
• A route map created to filter imported VRF or ISID routes can contain any of the following match and
set parameter options:
– Match options: ip-address, ip-next-hop, tag, metric
– Set options: tag
• Only one route map per source (imported) VRF or ISID is allowed.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-75
ip import IP Commands

• Modifying a route map that is assigned to a VRF or ISID through the ip import or ip export command
is not supported.
• Leaked routes are only for forwarding. If a local route is leaked, that interface is not accessible in the
importing VRF. Another switch will not be able to ping the interface in the import VRF.

Examples
-> ip import vrf V1 route-map R2
-> ip import vrf V2 all-routes
-> ip import isid 1500 route-map R1
-> ip import isid 2000 all-routes
-> no ip import vrf V1
-> no ip import isid 1500

Release History
Release 8.1.1; command introduced.

Related Commands
vrf Configures and selects a virtual routing and forwarding (VRF)
instance on the switch.
ip route-map action Creates a route map for selecting or filtering routes for tasks such
as redistribution and VRF route leaking. It also sets the action of
the route map to permit or deny.
ip route-map match protocol Matches the protocol specified in the route map with the protocol
of the route.
show ip import Displays the import route configuration details.
show ip global-route-table Displays the GRT for all the routes that are exported from the
VRFs.
show ip route-map Displays the configured IP route maps.

MIB Objects
alaIprmImportVrfTable
alaIprmImportVrfName
alaIprmImportVrfRouteMap
alaIprmImportVrfRowStatus
alaIprmImportIsidTable
alaIprmImportIsid
alaIprmImportIsidRouteMap
alaIprmImportIsidRowStatus

page 16-76 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip export

show ip export
Displays the export route configuration details.
[vrf vrf_name] show ip export

Syntax Definitions

vrf_name The name of an existing VRF instance.

Defaults
By default, the export route configuration for the active VRF instance is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If a VRF is specified, the export route configuration for that VRF is displayed.

Examples
-> show ip export
Export Route Map: leak-out

-> vrf vrf1 show ip export

Export Route Map: none (all-routes)

vrf2::-> show ip export

Export Route Map: none (all-routes) -> To All VRFs

Release History
Release 8.1.1; command introduced.

Related Commands
ip export Exports routes from the source VRF to the Global Routing Table
(GRT) or to all VRF instances.

MIB Objects
alaIprmExportRouteMap
alaIprmExportToAllVrfsRouteMap

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-77
show ip import IP Commands

show ip import
Displays the import route configuration details.
[vrf vrf_name] show ip import

Syntax Definitions

vrf_name The name of an existing VRF instance.

Defaults
By default, the import route configuration for the active VRF instance is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If a VRF is specified, the import route configuration for that VRF is displayed.

Examples
-> show ip import
Type Source RouteMap
-----+--------------------+-----------------------
vrf Customer1 leak-in
vrf Customer2 none (all-routes)
isid 1000 isid1000-filter

output definitions
Type The type of imported route (vrf or isid).
Source The name of the VRF instance or the Shortest Path Bridging service
instance identifier (ISID) from which routes are imported to the VRF.
RouteMap The name of the route map filter or none (all-routes).

Release History
Release 8.1.1; command introduced.

page 16-78 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip import

Related Commands
ip import Imports VRF or Shortest Path Bridging ISID routes from the GRT
to the destination VRF.

MIB Objects
alaIprmImportVrfTable
alaIprmImportVrfName
alaIprmImportVrfRouteMap
alaIprmImportVrfRowStatus
alaIprmImportIsidTable
alaIprmImportIsid
alaIprmImportIsidRouteMap
alaIprmImportIsidRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-79
show ip global-route-table IP Commands

show ip global-route-table
Displays the contents of the Global Routing Table (GRT) for all the routes that are exported from VRF
instances or from Shortest Path Bridging instance service identifiers (ISIDs). This command is only
available within the context of the default VRF instance.
show ip global-route-table [export-vrf vrf_name]

Syntax Definitions

vrf_name The name of an existing VRF instance.

Defaults
By default, exported routes are displayed for all VRF instances and ISIDs.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the export-vrf parameter to display exported routes for a specific VRF instance.

Examples
-> show ip global-route-table
Type Source Destination Gateway Metric Tag
-----+--------------------+------------------+---------------+----------+----------
vrf Customer1 10.0.0.0/8 12.1.1.2 1 100
vrf Customer2 11.0.0.0/8 12.1.1.3 2 0
isid 1000 12.0.0.0/8 12.1.1.4 1 2

output definitions
Type The type of exported route (vrf or isid).
Source The name of the VRF instance or the Shortest Path Bridging service
instance identifier (ISID) from which routes are exported to the GRT.
Destination The address of the route.
Gateway The next hop for the destination address.
Metric The metric of the exported route.
Tag The tag of the exported route.

Release History
Release 8.1.1; command introduced.

page 16-80 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip global-route-table

Related Commands
ip export Configures a route map to export routes from the source VRF to
Global Routing Table (GRT).
show ip export Displays the export route configuration details.

MIB Objects
alaGrtRouteTable
alaGrtRouteDistinguisher
alaGrtRouteDest
alaGrtRouteMaskLen
alaGrtRouteNextHop
alaGrtRouteMetric
alaGrtRouteTag
alaGrtRouteVrfName
alaGrtRouteIsid

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-81
arp IP Commands

arp
Adds a permanent entry to the ARP table. To forward packets, the switch dynamically builds an ARP
Table to match the IP address of a device with its physical (MAC) address. These entries age out of the
table when the timeout value is exceeded. This command is used to add a permanent entry to the table.
Permanent entries do not age out of the table.
arp ip_address mac_address [alias] [arp-name name] [interface interface_name] [port chassis/slot/port]
[linkagg agg_num]
no arp ip_address [alias]

Syntax Definitions

ip_address IP address of the device you are adding to the ARP table.
mac_address MAC address of the device in hexadecimal format (for example,
00.00.39.59.f1.0c).
alias Specifies that the switch will act as an alias (or proxy) for this IP
address. When the alias option is used, the switch responds to all ARP
requests for the specified IP address with its own MAC address.

You can also enable the proxy feature for an IP interface using the ip
interface command. When enabled, ARP requests return the MAC
address of the IP router interface and all traffic within the VLAN is
routed.
name The name to assign to this ARP entry.
interface interface_name Name of the interface to be used for ARP resolution.
chassis/slot/port The chassis ID, slot, and port number (3/1/1) for a specific port.
agg_num The link aggregate ID number.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete a permanent ARP entry.

• Configuring a permanent ARP entry with a multicast address is also supported. This is done by
specifying a multicast address for the ip_address parameter instead of a unicast address.
• Using the arp alias command is not related to proxy ARP as defined in RFC 925. Instead, arp alias is
similar to the Local Proxy ARP feature, except that it is used to configure the switch as a proxy for
only one IP address.
• As most hosts support the use of address resolution protocols to determine cache address information
(called dynamic address resolution), it is not required to specify permanent ARP cache entries.

page 16-82 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands arp

• Only the IP address is required when deleting an ARP entry from the table.

Examples
-> arp 171.11.1.1 00:05:02:c0:7f:11

Release History
Release 8.1.1; command introduced.

Related Commands
clear arp-cache Deletes all dynamic entries from the ARP table.
ip interface Enables or disables the Local Proxy ARP feature for an IP
interface. When enabled, all traffic within the VLAN is routed.
ARP requests return the MAC address of the IP router interface.
show arp Displays the ARP table.

MIB Objects
ipNetToMediaTable
ipNetToMediaIfIndex
ipNetToMediaNetAddress
ipNetToMediaPhyAddress
ipNetToMediaType
alaIpNetToMediaTable
alaIpNetToMediaPhyAddress
alaIpNetToMediaProxy

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-83
clear arp-cache IP Commands

clear arp-cache
Deletes all dynamic entries from the ARP table.
clear arp-cache

Syntax Definitions
N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command only clears dynamic entries. If permanent entries have been added to the table, they
must be removed using the no form of the ip service command.
• Dynamic entries remain in the ARP table until they time out. The switch uses the MAC Address table
timeout value as the ARP timeout value. Use the mac-learning aging-time command to set the
timeout value.

Examples
-> clear arp-cache

Release History
Release 8.1.1; command introduced

Related Commands
ip service Adds a permanent entry to the ARP table.
show arp Displays the ARP table.

MIB Objects
alaIpClearArpCache

page 16-84 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip dos arp-poison restricted-address

ip dos arp-poison restricted-address

Adds or deletes an ARP Poison restricted address.
ip dos arp-poison restricted-address ip_address
no ip dos arp-poison restricted-address ip_address

Syntax Definitions

ip_address 32-bit IP address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of the command to remove an already configured ARP Poison restricted address.

Examples
-> ip dos arp-poison restricted-address 192.168.1.1
-> no ip dos arp-poison restricted-address 192.168.1.1

Release History
Release 8.1.1; command introduced

Related Commands
ip service Adds a permanent entry to the ARP table.
show arp Displays the ARP table.

MIB Objects
alaDoSArpPoisonTable
alaDoSArpPoisonIpAddr
alaDosArpPoisonRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-85
arp filter IP Commands

arp filter
Configures an ARP filter that determines if ARP Request packets containing a specific IP address are
processed by the switch or discarded.
arp filter ip_address [mask ip_mask] [vlan_id] [sender | target] [allow | block]
no arp filter ip_address

Syntax Definitions

ip_address The IP address to use for filtering ARP packet IP addresses.

ip_mask An IP mask that identifies which part of the ARP packet IP address is
examined for filtering (for example, mask 255.0.0.0 filters on the first
octet of the ARP packet IP address).
vlan_id A VLAN ID that specifies that only ARP packets for a specific VLAN
are filtered.
sender The sender IP address in the ARP packet is used for ARP filtering.
target The target IP address in the ARP packet is used for ARP filtering.
allow ARP packets that meet filter criteria are processed.
block ARP packets that meet filter criteria are discarded.

Defaults

parameter default
vlan_id 0 (no VLAN)
ip_mask 255.255.255.255
sender | target target
allow | block block

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete an ARP filter.

• If there are no filters configured for the switch, all ARP Request packets received are processed.

• Up to 200 filters are allowed on each switch.

• If sender or target IP address in an ARP Request packet does not match any filter criteria, the packet is
processed by the switch.
• ARP filtering is used in conjunction with the Local Proxy ARP application; however, ARP filtering is
available for use on its own and/or with other applications.

page 16-86 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands arp filter

Examples
-> arp filter 171.11.1.1
-> arp filter 172.0.0.0 mask 255.0.0.0
-> arp filter 198.0.0.0 mask 255.0.0.0 sender
-> arp filter 198.172.16.1 vlan 200 allow
-> no arp filter 171.11.1.1

Release History
Release 8.1.1; command introduced

Related Commands
clear arp filter Clears all ARP filters from the filter database.
ip interface Enables or disables the Local Proxy ARP feature on an IP
interface. When enabled, all traffic within the VLAN is routed.
ARP requests return the MAC address of the IP router interface.
show arp filter Displays the ARP filter configuration.

MIB Objects
alaIpArpFilterTable
alaIpArpFilterIpAddr
alaIpArpFilterIpMask
alaIpArpFilterVlan
alaIpArpFilterMode
alaIpArpFilterType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-87
clear arp filter IP Commands

clear arp filter

Clears the ARP filter database of all entries.
clear arp-cache

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command clears all ARP filters configured on the switch. To remove an individual filter entry, use
the no form of the arp filter command.

Examples
-> clear arp filter

Release History
Release 8.1.1; command introduced

Related Commands
arp filter Configures an ARP filter to allow or block the processing of
specified ARP Request packets.
show arp filter Displays the ARP filter configuration.

MIB Objects
alaIpClearArpFilter

page 16-88 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands icmp type

icmp type
Enables or disables a specific type of ICMP message, and sets the minimum packet gap. The minimum
packet gap is the number of microseconds that must pass between ICMP messages of the same type.
icmp type type code code {{enable | disable} | min-pkt-gap gap}

Syntax Definitions

type The ICMP packet type. This is conjunction with the ICMP code that
determines the type of ICMP message being specified.
code The ICMP code type. This is conjunction with the ICMP type that deter-
mines the type of ICMP message being specified.
enable Enables the specified ICMP message.
disable Disables the specified ICMP message.
gap The number of microseconds required between ICMP messages of this
type.

Defaults

parameter default
enable | disable disabled
gap 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command allows the user to enable or disable all types of ICMP messages, and set the minimum
packet gap between messages of the specified type.
• While this command can be used to enable or disable all ICMP message, some of the more common
ICMP messages have their own CLI commands, as described in the pages below. The following ICMP
messages have specific commands to enable and disable:

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-89
icmp type IP Commands

ICMP Message Command

Network unreachable (type 0, code 3) icmp unreachable
Host unreachable (type 3, code 1) icmp unreachable
Protocol unreachable (type 3, code 2) icmp unreachable
Port unreachable (type 3, code 3) icmp unreachable
Echo reply (type 0, code 0) icmp echo
Echo request (type 8, code 0) icmp echo
Timestamp request (type 13, code 0) icmp timestamp
Timestamp reply (type 14, code 0) icmp timestamp
Address Mask request (type 17, code 0) icmp addr-mask
Address Mask reply (type 18, code 0) icmp addr-mask

• Enabling Host unreachable and Network unreachable messages are not recommended as it can cause
the switch instability due to high-CPU conditions depending upon the volume of traffic required by
these messages.

Examples
-> icmp type 4 code 0 enabled
-> icmp type 4 code 0 min-pkt-gap 40
-> icmp type 4 code 0 disable

Release History
Release 8.1.1; command introduced

Related Commands
icmp messages Enables or disables all ICMP messages.
show icmp control Allows the viewing of the ICMP control settings.

MIB Objects
alaIcmpCtrlTable
alaIcmpCtrlType
alaIcmpCtrlTable
alaIcmpCtrlCode
alaIcmpCtrlStatus
alaIcmpCtrlPktGap

page 16-90 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands icmp unreachable

icmp unreachable
Enables or disables ICMP messages pertaining to unreachable destinations, and sets the minimum packet
gap. The minimum packet gap is the number of microseconds that must pass between ICMP messages of
the same type.
icmp unreachable [net-unreachable | host-unreachable | protocol-unreachable | port-unreachable]
{{enable | disable} | min-pkt-gap gap}

Syntax Definitions

net-unreachable Sets the unreachable network ICMP message.

host-unreachable Sets the unreachable host ICMP message.
protocol-unreachable Sets the unreachable protocol ICMP message.
port-unreachable Sets the unreachable port ICMP message.
enable Enables the specified ICMP message.
disable Disables the specified ICMP message.
gap The number of microseconds required between ICMP messages of this
type.

Defaults

parameter default
enable | disable disabled
gap 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command enables ICMP messages relating to unreachable destinations. Unreachable networks,
hosts, protocols, and ports can all be specified.
• Enabling host-unreachable and net-unreachable messages are not recommended as it can cause the
switch instability due to high-CPU conditions depending upon the volume of traffic required by these
messages.
• The unreachable ICMP messages can also be enabled, disabled, and modified using the icmp type
command. See the icmp type command information on the type and code for the unreachable ICMP
messages.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-91
icmp unreachable IP Commands

Examples
-> icmp unreachable net-unreachable enable
-> icmp unreachable host-unreachable enable
-> icmp unreachable protocol-unreachable enable
-> icmp unreachable port-unreachable enable
-> icmp unreachable port-unreachable min-pkt-gap 50

Release History
Release 8.1.1; command introduced

Related Commands
show icmp control Allows the viewing of the ICMP control settings.

MIB Objects
alaIcmpCtrlTable
alaIcmpCtrlType
alaIcmpCtrlTable
alaIcmpCtrlCode
alaIcmpCtrlStatus
alaIcmpCtrlPktGap

page 16-92 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands icmp echo

icmp echo
Enables or disables ICMP echo messages, and sets the minimum packet gap. The minimum packet gap is
the number of microseconds that must pass between ICMP messages of the same type.
icmp echo [request | reply] {{enable | disable} | min-pkt-gap gap}

Syntax Definitions

request Specifies the echo request ICMP message.

reply Specifies the echo reply ICMP message.
enable Enables the specified ICMP message.
disable Disables the specified ICMP message.
gap The number of microseconds required between ICMP messages of this
type.

Defaults

parameter default
enable | disable enable
gap 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command sets the ICMP echo messages. An echo request is sent to a destination, and must be
responded to with an echo reply message that contains the original echo request.
• Using this command without specifying a request or reply enables, disables, or sets the minimum
packet gap for both types.
• The echo ICMP messages can also be enabled, disabled, and modified using the icmp type command.
See the icmp type command information on the type and code for the echo ICMP messages.

Examples
-> icmp echo reply enable
-> icmp echo enable
-> icmp echo request enable
-> icmp echo request min-pkt-gap 50

Release History
Release 8.1.1; command introduced

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-93
icmp echo IP Commands

Related Commands
show icmp control Allows the viewing of the ICMP control settings.

MIB Objects
alaIcmpCtrlTable
alaIcmpCtrlType
alaIcmpCtrlTable
alaIcmpCtrlCode
alaIcmpCtrlStatus
alaIcmpCtrlPktGap

page 16-94 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands icmp timestamp

icmp timestamp
Enables or disables ICMP timestamp messages, and sets the minimum packet gap. The minimum packet
gap is the number of microseconds that must pass between ICMP messages of the same type.
icmp timestamp [request | reply] {{enable | disable} | min-pkt-gap gap}

Syntax Definitions

request Specifies timestamp request messages.

reply Specifies timestamp reply messages.
enable Enables the specified ICMP message.
disable Disables the specified ICMP message.
gap The number of microseconds required between ICMP messages of this
type.

Defaults

parameter default
enable | disable enable
gap 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The data received (a timestamp) in the message is returned in the reply together with an additional
timestamp. The timestamp is 32 bits of milliseconds since midnight UT. The Originate timestamp is
the time the sender last touched the message before sending it, the Receive timestamp is the time the
echoer first touched it on receipt, and the Transmit timestamp is the time the echoer last touched the
message on sending it.
• Using this command without specifying a request or reply enables, disables, or sets the minimum
packet gap for both types.
• The timestamp ICMP messages can also be enabled, disabled, and modified using the icmp type
command. See the icmp type command information on the type and code for the timestamp ICMP
messages.

Examples
-> icmp timestamp reply enable
-> icmp timestamp enable
-> icmp timestamp request enable
-> icmp timestamp request min-pkt-gap 50

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-95
icmp timestamp IP Commands

Release History
Release 8.1.1; command introduced

Related Commands
show icmp control Allows the viewing of the ICMP control settings.

MIB Objects
alaIcmpCtrlTable
alaIcmpCtrlType
alaIcmpCtrlTable
alaIcmpCtrlCode
alaIcmpCtrlStatus
alaIcmpCtrlPktGap

page 16-96 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands icmp addr-mask

icmp addr-mask
Enables or disables ICMP address mask messages, and sets the minimum packet gap. The minimum
packet gap is the number of microseconds that must pass between ICMP messages of the same type.
icmp add-mask [request | reply] {{enable | disable} | min-pkt-gap gap}

Syntax Definitions

request Specifies request address mask messages.

reply Specifies reply address mask messages.
enable Enables the specified ICMP message.
disable Disables the specified ICMP message.
gap The number of microseconds required between ICMP messages of this
type.

Defaults

parameter default
enable | disable enable
gap 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• A gateway receiving an address mask request must return it with the address mask field set to the 32-
bit mask of the bits identifying the subnet and network, for the subnet on which the request was
received.
• Using this command without specifying a request or reply enables, disable, or set the minimum packet
gap for both types.
• The address mask ICMP messages can also be enabled, disabled, and modified using the icmp type
command. See the icmp type command information on the type and code for the address mask ICMP
messages.

Examples
-> icmp addr-mask reply enable
-> icmp addr-mask enable
-> icmp addr-mask request enable
-> icmp addr-mask request min-pkt-gap 50

Release History
Release 8.1.1; command introduced

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-97
icmp addr-mask IP Commands

Related Commands
show icmp control Allows the viewing of the ICMP control settings.

MIB Objects
alaIcmpCtrlTable
alaIcmpCtrlType
alaIcmpCtrlTable
alaIcmpCtrlCode
alaIcmpCtrlStatus
alaIcmpCtrlPktGap

page 16-98 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands icmp messages

icmp messages
Enables or disables all Internet Control Message Protocol (ICMP) messages.
icmp messages {enable | disable}

Syntax Definitions

enable Enables ICMP message.

disable Disables ICMP message.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> icmp messages enable
-> icmp messages disable

Release History
Release 8.1.1; command introduced

Related Commands
icmp type Enables or disables a specific type of ICMP message, and sets the
minimum packet gap.
show icmp control Allows the viewing of the ICMP control settings.

MIB Objects
alaIcmpCtrl
alaIcmpAllMsgStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-99
ip dos scan close-port-penalty IP Commands

ip dos scan close-port-penalty

Assigns a penalty value to be added to the Denial of Service penalty scan value when a TCP or UDP
packet is received on a closed port.
ip dos scan close-port-penalty penalty_value

Syntax Definitions

penalty_value A penalty value added to the penalty scan value. This value can be any
non-negative integer.

Defaults

parameter default
penalty_value 10

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command creates a point value that is added to the total port scan penalty value when a TCP or UDP
packet is received that is destined for a closed port.

Examples
-> ip dos scan close-port-penalty 25

Release History
Release 8.1.1; command introduced

Related Commands
ip dos scan threshold Sets the threshold for the port scan value, at which a DoS attack is
recorded.
ip dos trap Sets whether the switch generates SNMP DoS traps when an attack
is detected.

MIB Objects
alaDoSConfig
alaDoSPortScanClosePortPenalty

page 16-100 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip dos scan tcp open-port-penalty

ip dos scan tcp open-port-penalty

Assigns a penalty value to be added to the Denial of Service penalty scan value when a TCP packet is
received on an open port.
ip dos scan tcp open-port-penalty penalty_value

Syntax Definitions

penalty_value A penalty value added to the penalty scan value. This value can be any
non-negative integer.

Defaults

parameter default
penalty_value 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command creates a point value that is added to the total port scan penalty value when a TCP
packet is received that is destined for an open port.
• The switch does not distinguish between a legal TCP packet and a port scan packet.

Examples
-> ip dos scan tcp open-port-penalty 10

Release History
Release 8.1.1; command introduced

Related Commands
ip dos scan threshold Sets the threshold for the port scan value, at which a DoS attack is
recorded.
ip dos trap Sets whether the switch generates SNMP DoS traps when an attack
is detected.

MIB Objects
alaDoSConfig
alaDoSPortScanTcpOpenPortPenalty

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-101
ip dos scan udp open-port-penalty IP Commands

ip dos scan udp open-port-penalty

Assigns a penalty value to be added to the Denial of Service penalty scan value when a UDP packet is
received on an open port.
ip dos scan udp open-port-penalty penalty_value

Syntax Definitions

penalty_value A penalty value added to the penalty scan value. This value can be any
non-negative integer.

Defaults

parameter default
penalty_value 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command creates a point value that is added to the total port scan penalty value when a UDP
packet is received that is destined for an open port.
• The switch does not distinguish between a legal UDP packet and a port scan packet.

Examples
-> ip dos scan udp open-port-penalty 15

Release History
Release 8.1.1; command introduced

Related Commands
ip dos scan threshold Sets the threshold for the port scan value, at which a DoS attack is
recorded.
ip dos trap Sets whether the switch generates SNMP DoS traps when an attack
is detected.

MIB Objects
alaDoSConfig
alaDoSPortScanUdpOpenPortPenalty

page 16-102 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip dos scan threshold

ip dos scan threshold

Sets the threshold for the port scan value, at which a DoS attack is recorded.
ip dos scan threshold threshold_value

Syntax Definitions

threshold_value A numerical value representing the total acceptable penalty before a

DoS attack is noted. This value can be any non-negative integer.

Defaults

parameter default
threshold_value 1000

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the total port scan penalty value exceeds this value, a port scan attack is recorded.

• The penalty value is incremented by recording TCP or UDP packets that are bound for open or closed
ports. Such packets are given a penalty value, which are added. The commands for setting the packet
penalty value are the ip dos scan close-port-penalty, ip dos scan tcp open-port-penalty, and ip dos
scan udp open-port-penalty commands.

Examples
-> ip dos scan threshold 1200

Release History
Release 8.1.1; command introduced

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-103
ip dos scan threshold IP Commands

Related Commands
ip dos scan close-port-penalty Assigns a penalty value to be added to the Denial of Service
penalty scan value when a TCP or UDP packet is received on a
closed port.
ip dos scan tcp open-port- Assigns a penalty value to be added to the Denial of Service
penalty penalty scan value when a TCP packet is received on an open port.
ip dos scan udp open-port- Assigns a penalty value to be added to the Denial of Service
penalty penalty scan value when a UDP packet is received on an open port.
show ip dos config Displays the configuration parameters of the DoS scan for the
switch.

MIB Objects
alaDoSConfig
alaDoSPortScanThreshold

page 16-104 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip dos trap

ip dos trap
Sets whether or not the switch generates SNMP DoS traps when an attack is detected.
ip dos trap {enable | disable}

Syntax Definitions

enable Enables the generation of DoS traps.

disable Disables the generation of DoS traps.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command controls whether the switch generates an SNMP trap when a DoS attack is detected. It is
assumed a DoS attack has occurred when the port scan penalty threshold is exceeded. This value is set
using the ip dos scan threshold command.

Examples
-> ip dos trap enable
-> ip dos trap disable

Release History
Release 8.1.1; command introduced

Related Commands
ip dos scan threshold Sets the threshold for the port scan value, at which a DoS attack is
recorded.
show ip dos config Displays the configuration parameters of the DoS scan for the
switch.

MIB Objects
alaDoSConfig
alaDoSTrapCnt1

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-105
ip dos scan decay IP Commands

ip dos scan decay

Sets the decay speed of the port scan penalty value for the switch when calculating DoS attacks.
ip dos scan decay decay_value

Syntax Definitions

decay_value The decay value amount for reducing the port scan penalty. This value
can be any non-negative integer.

Defaults

parameter default
decay_value 2

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The port scan penalty value is reduced every minute by dividing by the amount set in using this command.
For example, if the decay value is set to 10, every minute the total port scan penalty value is divided by 10.

Examples
-> ip dos scan decay 10

Release History
Release 8.1.1; command introduced

Related Commands
ip dos scan threshold Sets the threshold for the port scan value, at which a DoS attack is
recorded.
show ip dos config Displays the configuration parameters of the DoS scan for the
switch.

MIB Objects
alaDoSConfig
alaDoSPortScanDecay

page 16-106 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands ip dos type

ip dos type
Enables or disables detection for the specified type of DoS attack.
ip dos type {port-scan | ping-of-death | land | loopback-src | invalid-ip | invalid-multicast | unicast-ip-
mcast-mac | ping-overload | arp-flood | arp-poison} admin-state {enable | disable}

Syntax Definitions

port-scan Detects port scans by monitoring TCP or UDP packets sent to open or
closed ports.
ping-of-death Detects the number of ICMP Ping-of-Death attacks (the switch receives
ping packets that exceed the largest IP datagram size of 65535 bytes).
land Detects the number of Land attacks (the switch receives spoofed packets
with the SYN flag set on any open port that is listening).
loopback-src Detects the number of loopback source attacks (the switch receives
packets with 127.0.0.0/8 as the IP source address).
invalid-ip Detects invalid IP packets (the switch receives packets with an invalid
source or destination IP address).
invalid-multicast Detects invalid Multicast packets (the switch receives packets with an
invalid multicast address).
unicast-ip-mcast-mac Detects a unicast IP and multicast MAC mismatch (the switch receives
IP packets with multicast/broadcast source mac-address, non-
matching destination IP and mac-address).
ping-overload Detects a ping overload attack (the switch is flooded with a large num-
ber of ICMP packets).
arp-flood Detects ARP flooding (the switch is flooded with a large number of
ARP requests).
arp-poison Detects ARP poisoning (the switch receives replies to an ARP request
generated by the switch for a user-specified restricted address).
enable Enables DoS attack detection.
disable Disables DoS attack detection.

Defaults
By default, detection is enabled for all the specified IP DoS attack types, except for ping overload.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When detection is enabled for ping overload, the attack is not detected until the number of ICMP
packets received exceeds 100 packets-per-second.
• ARP flooding is rate limited to 500 packets-per-second on the switch. As a result, ARP flooding is not
detected until the number of ARP requests exceeds 500 packets-per-second.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-107
ip dos type IP Commands

• When detection is enabled for unicast IP/multicast MAC mismatches (unicast-ip-mcast-mac), ping
overload attacks (ping-overload), or ARP flooding attacks (arp-flood), packets are not dropped when
the attack is detected.

Examples
-> ip dos type ping-overload admin-state enable
-> ip dos type land admin-state disable

Release History
Release 8.1.1; command introduced

Related Commands
show ip dos config Displays the DoS scan configuration for the switch.
show ip dos statistics Displays statistics for the detected DoS attacks.

MIB Objects
alaDoSTable
alaDoSType
alaDoSStatus

page 16-108 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip traffic

show ip traffic
Displays IP datagram traffic and errors.
show ip traffic

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The statistics show the cumulative totals since the last time the switch was powered on or since the last
reset of the switch was executed.
• Packets received on a port that is a member of the UserPorts group are dropped if they contain a source
IP network address that does not match the IP subnet for the port. This is done to block spoofed IP
traffic. If the UserPorts group function is active and spoofed traffic was detected and blocked, the
output display of this command includes statistics regarding the spoofed traffic.
• The presence of spoofing event statistics in the output display of this command indicates that an attack
was prevented, not that the switch is currently under attack.
• If statistics for spoofed traffic are not displayed, then a spoofing attempt has not occurred since the last
time this command was issued.

Examples
-> show ip traffic

IP statistics
Datagrams received
Total = 621883,
IP header error = 0,
Destination IP error = 51752,
Unknown protocol = 0,
Local discards = 0,
Delivered to users = 567330,
Reassemble needed = 0,
Reassembled = 0,
Reassemble failed = 0

Datagrams sent
Fowarded = 2801,
Generated = 578108,
Local discards = 0,
No route discards = 9,

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-109
show ip traffic IP Commands

Fragmented = 2801,
Fragment failed = 0,
Fragments generated = 0

output definitions
Total Total number of input datagrams received including the datagrams
received in the error.
IP header error Number of IP datagrams discarded due to errors in the IP header (for
example, bad checksums, version number mismatch, other format
errors, time-to-live exceeded, errors discarded in processing IP
options).
Destination IP error Number of IP datagrams discarded because the IP header destination
field contained an invalid address. This count includes invalid
addresses (for example, 0.0.0.0) and addresses of unsupported classes
(for example, Class E).
Unknown protocol Number of locally-addressed datagrams received successfully but
discarded because of an unknown or unsupported protocol.
Local discards Number of IP datagrams received that were discarded, even though
they had no errors to prevent transmission (for example, lack of buffer
space). This does not include any datagrams discarded while awaiting
reassembly. This value must be zero.
Delivered to users Total number of datagrams received that were successfully delivered to
IP user protocols (including ICMP).
Reassemble needed Number of IP fragments received that needed to be reassembled.
Reassembled Number of IP datagrams received that were successfully reassembled.
Reassemble failed Number of IP failures detected by the IP reassembly algorithm for all
reasons (for example, timed out, error). This is not necessarily a count
of discarded IP fragments since some algorithms (notably the algorithm
in RFC 815) can lose track of the number of fragments by combining
them as they are received.
Fragmented Number of successfully fragmented IP datagrams.
Fragment failed Number of packets received and discarded by IP that were not
fragmented. This situation can happen if a large packet has the “Don’t
Fragment” flag set.
Forwarded Number of IP datagrams forwarded by the switch.
Generated Total number of IP datagrams that local IP user protocols (including
ICMP) generated in response to requests for transmission. This does
not include any datagrams counted as “Forwarded”.
Local discards Number of output IP datagrams that were discarded, even though they
had no errors to prevent transmission (for example, lack of buffer
space). This number includes datagrams counted as “Forwarded” if the
packets are discarded for these reasons.
No route discards Number of IP datagrams received and discarded by IP because no route
could be found to transmit them to their destination. This includes any
packets counted as “Forwarded” if the packets are discarded for these
reasons. It also includes any datagrams that a host cannot route because
all of its default routers are down.

page 16-110 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip traffic

output definitions (continued)

Fragments generated The of IP datagram fragments generated as a result of fragmentation.
Routing entry discards Number of packets received and discarded by IP even though no
problems were encountered to prevent their transmission to their
destination (for example, discarded because of lack of buffer space).

Release History
Release 8.1.1; command introduced

Related Commands
show icmp statistics Displays ICMP statistics and errors.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-111
show ip interface IP Commands

show ip interface
Displays the configuration and status of IP interfaces.
show ip interface [if_name | emp | vlan vlan id]

Syntax Definitions

if_name The name associated with the IP interface.

emp Displays the configuration and status of the Ethernet Management Port
interface.
vlan_id VLAN ID (displays a list of IP interfaces associated with a VLAN).

Defaults
By default, all IP interfaces are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The basic show ip interface command displays information about all configured IP interfaces on the
switch.
• Use the optional vlan parameter to display a list of interfaces configured for the specified VLAN.

• Specify an optional interface name to display detailed information about an individual interface.

• Use the optional emp parameter to display detailed information about the EMP interface.

Examples
-> show ip interface
Total 13 interfaces
Name IP Address Subnet Mask Status Forward Device
--------------------+---------------+---------------+------+-------+--------
EMP 172.22.16.115 255.255.255.0 UP NO EMP
GMRULE 40.1.1.1 255.255.255.0 DOWN NO vlan 40
Loopback 127.0.0.1 255.0.0.0 UP NO Loopback
client 60.1.1.1 255.255.255.0 DOWN NO vlan 60
gbps 5.5.5.5 255.255.255.0 DOWN NO vlan 7
if222 30.1.5.1 255.0.0.0 UP YES vlan 222
ldap_client1 173.22.16.115 255.255.255.0 UP YES vlan 173
ldap_server1 174.22.16.115 255.255.255.0 UP YES vlan 174
radius_client3 110.1.1.101 255.255.255.0 UP YES vlan 30
vlan-2 0.0.0.0 0.0.0.0 DOWN NO unbound
gre-1 24.24.24.1 255.255.255.0 UP YES GRE tunnel
ipip-1 25.25.25.1 255.255.255.0 UP YES IPIP tunnel
vlan-23 23.23.23.1 255.255.255.0 UP YES vlan 23

page 16-112 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip interface

output definitions
Name Interface name. This is the name configured for the interface (for
example, Accounting). EMP refers to the Ethernet Management Port.
Loopback refers to a loopback interface configured for testing.
IP Address IP address of the interface. Configured through the ip interface
command.
Subnet Mask IP subnet mask for the interface IP address. Configured through the ip
interface command.
Status Interface status:
• UP—Interface is ready to pass packets.
• DOWN—Interface is down.
Forward Indicates whether the interface is actively forwarding packets (YES or
NO).
Device The type of device bound to the interface:
• unbound—No device is bound to the interface.
• vlan—The VLAN ID that is bound to the interface.
• EMP—The Ethernet Management Port is bound to the interface.
• Loopback—A loopback interface is configured for testing.
• GRE tunnel—GRE tunnel is configured for the interface.
• IPIP tunnel—IPIP tunnel is configured for the interface.
Configured through the ip interface command.

-> show ip interface Marketing

Interface Name = Marketing
SNMP Interface Index = 13600007,
IP Address = 172.16.105.10,
Subnet Mask = 255.255.0.0,
Broadcast Address = 172.16.255.255,
Device = vlan 200,
Encapsulation = eth2,
Forwarding = disabled,
Administrative State = enabled,
Operational State = down,
Operational State Reason = device-down,
Router MAC = 00:d0:95:6a:f4:5c,
Local Proxy ARP = disabled,
Maximum Transfer Unit = 1500,
Primary (config/actual) = no/yes

output definitions
SNMP Interface Index Interface index.
IP Address IP address associated with the interface. Configured through the ip
interface command.
Subnet Mask IP subnet mask for the interface. Configured through the ip interface
command.
Broadcast Address Broadcast address for the interface.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-113
show ip interface IP Commands

output definitions (continued)

Device The type of device bound to the interface:
• unbound—No device is bound to the interface.
• vlan—The VLAN ID that is bound to the interface.
• EMP—The Ethernet Management Port is bound to the interface.
• Loopback—A loopback interface is configured for testing.
• GRE tunnel—GRE tunnel is configured for the interface.
• IPIP tunnel—IPIP tunnel is configured for the interface.
Configured through the ip interface command.
The GRE tunnel and IPIP tunnel devices are supported only on the
OmniSwitch 10K switches.
Encapsulation Displays the IP router encapsulation (eth2 or snap) that the interface
uses when routing packets. Configured through the ip interface
command.
Forwarding Indicates whether IP forwarding is active for the interface (enabled or
disabled). Configured through the ip interface command.
Administrative State Administrative state of the IP interface (enabled or disabled), which is
independent of the state of the underlying device. Configured through
the ip interface command.
Operational State Indicates whether the interface is active (up or down).
Operation State Reason Indicates why the operational state of the interface is down:
• unbound—No device is bound to the interface.
• device-down—Device bound to the interface is down.
• admin-down—The admin state of the interface is down.
• no-such-device—Device does not exist.
• no-router-mac—No MAC address available for the interface.
• tunnel-src-invalid—The source IP address of the tunnel is invalid.
• tunnel-dst-unreachable—The destination IP address of the tunnel
is not reachable.
The tunnel-src-invalid and tunnel-dst-unreachable Operational State
reasons are supported only on the OmniSwitch 10K switches. These
two reasons are only applicable for the GRE tunnel and IPIP tunnel
device types.
Operational State Reason field is only included in the display output
when the operational state of the interface is down.
Router MAC Switch MAC address assigned to the interface. Each interface assigned
to the same VLAN shares the same switch MAC address.
Local Proxy ARP Indicates whether Local Proxy ARP is active for the interface (enabled
or disabled). Configured through the ip interface command.
Maximum Transfer Unit The Maximum Transmission Unit size set for the interface. Configured
through the ip interface command.
Primary (config/actual) Indicates if the interface is the configured and/or actual primary
interface for the device (VLAN, EMP, Loopback). If the actual status is
set to yes and the config status is set to no, the interface is the default
interface for the VLAN. Configured through the ip interface
command.

Release History
Release 8.1.1; command introduced

page 16-114 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip interface

Related Commands
ip interface Configures an IP interface to enable IP routing on a VLAN.
Without an IP interface, traffic is bridged within the VLAN or
across connections to the same VLAN on other switches.
ip interface tunnel Configures the end points for the GRE and IPIP tunnels.
show icmp statistics Displays ICMP statistics and errors.

MIB Objects
alaIpInterfaceTable
alaIpInterfaceName
alaIpInterfaceAddress
alaIpInterfaceMask
alaIpInterfaceAdminState
alaIpInterfaceDeviceType
alaIpInterfaceVlanID
alaIpInterfaceIpForward
alaIpInterfaceEncap
alaIpInterfaceLocalProxyArp
alaIpInterfacePrimCfg
alaIpInterfaceOperState
alaIpInterfaceOperReason
alaIpInterfaceRouterMac
alaIpInterfaceBcastAddr
alaIpInterfacePrimAct
alaIpInterfaceMtu
alaIpInterfaceTunnelSrc
alaIpInterfaceTunnelDst

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-115
show ip routes IP Commands

show ip routes
Displays the IP Forwarding table.
[vrf vrf_name] show ip routes [summary]

Syntax Definitions

vrf_name The alphanumeric name (1–20 characters) assigned to the VRF instance.
summary Displays a summary of routing protocols that appear in the IP
Forwarding table.

Defaults
By default, all routes are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The IP Forwarding table includes static routes as well as all routes learned through routing protocols
(for example, RIP, OSPF).
• Use the optional summary keyword to display a list of routing protocols and the number of routes for
each protocol that appear in the IP Forwarding table.
• The imported routes are also displayed under the protocol field as IMPORT in the show output.

Examples
-> show ip routes

+ = Equal cost multipath routes

Total 4 routes

Dest Address Gateway Addr Age Protocol

------------------+-----------------+---------+-----------
0.0.0.0/0 10.255.11.254 01:50:33 STATIC
10.255.11.0/24 10.255.11.225 01:50:33 LOCAL
127.0.0.1/32 127.0.0.1 01:51:47 LOCAL
212.109.138.0/24 212.109.138.138 00:33:07 LOCAL
12.0.0.0/8 12.0.0.1 00:20:00 IMPORT

-> show ip routes summary

Protocol Route Count

----------------+--------------
Local 3
Static 1
RIP 0
ISIS 0
OSPF 0

page 16-116 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip routes

BGP 0
Import 1
Other 0

TOTAL = 5

output definitions
Dest Addr Destination IP address/mask length.
Gateway Addr IP address of the gateway from which this address was learned.
Age Age of the entry. If the entry is less than a day old, it is displayed in
hh/mm/ss format. If it is more than a day old, it is displayed in dd/hh
format (for example, a route that is 2 days and 12 hours old is displayed
as 2d12h).
Protocol Protocol by which this IP address was learned (for example, RIP).
LOCAL indicates a local interface.
Route Count The number of routes that appear in the IP Forwarding table for each
protocol type listed.

Release History
Release 8.1.1; command introduced

Related Commands
ping Used to test whether an IP destination can be reached from the
local switch.
traceroute Used to find the path taken by an IP packet from the local switch to
a specified destination.
show ip routes Displays a list of all routes (static and dynamic) that exist in the IP
router database.

MIB Objects
ipCidrRouteTable
ipCidrRouteDest
ipCidrRouteMask
ipCidrRouteTos
ipCidrRouteNextHop
ipCidrRouteIfIndex
ipCidrRouteType
ipCidrRouteProto
ipCidrRouteAge
ipCidrRouteInfo
ipCidrRouteNextHopAS
ipCidrRouteMetric1
ipCidrRouteMetric2
ipCidrRouteMetric3
ipCidrRouteMetric4
ipCidrRouteMetric5
ipCidrRouteStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-117
show ip route-pref IP Commands

show ip route-pref
Displays the IPv4 routing preferences of a router.
[vrf vrf_name] show ip route-pref

Syntax Definitions

vrf_name The alphanumeric name (1–20 characters) assigned to the VRF instance.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The imported routes are also displayed under the protocol field as IMPORT in the show output.

Examples
-> show ip route-pref
Protocol Route Preference Value
------------+------------------------
Local 1
Static 2
OSPF 110
ISISL1 115
ISISL2 118
RIP 120
EBGP 190
IBGP 200
Import 210

Release History
Release 8.1.1; command introduced

Related Commands

ip route-pref Configures the route preference of a router.

MIB Objects
alaIprmRtPrefTable
alaIprmRtPrefEntryType
alaIprmRtPrefEntryValue

page 16-118 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip redist

show ip redist
Displays the IPv4 route map redistribution configuration.
[vrf vrf_name] show ipv6 redist [rip | ospf | isis | bgp]

Syntax Definitions

vrf_name The alphanumeric name (1–20 characters) assigned to the VRF instance.
rip Displays route map redistribution configurations that use RIP as the
destination (into) protocol.
ospf Displays route map redistribution configurations that specify OSPF as
the destination (into) protocol.
isis Displays route map redistribution configurations that specify ISIS as the
destination (into) protocol.
bgp Displays the route map redistribution configurations that specify BGP as
the destination (into) protocol at this time.

Defaults
By default, all route map redistribution configurations are shown.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Specify a destination protocol with this command to display only those configurations that redistribute
routes into the specified protocol.

Release History
Release 8.1.1; command introduced

Examples
-> show ip redist

Source Destination
Protocol Protocol Status Route Map
------------+------------+---------+--------------------
RIP OSPF Enabled ipv4rm
BGP RIP Enabled ipv4rm
IMPORT RIP Enabled ipv4rm

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-119
show ip redist IP Commands

-> show ip redist rip

Source Destination
Protocol Protocol Status Route Map
------------+------------+---------+--------------------
BGP RIP Enabled ipv4rm
IMPORT RIP Enabled ipv4rm

output definitions
Source Protocol The protocol from which the routes are learned.
Destination Protocol The protocol into which the source protocol routes are redistributed.
Status The administrative status (Enabled or Disabled) of the route map
redistribution configuration.
Route Map The name of the route map that is applied with this redistribution
configuration.

Related Commands

ip service source-ip Controls the conditions for redistributing different IPv6 routes
between protocols.

MIB Objects
alaRouteMapRedistProtoTable
alaRouteMapRedistSrcProtoId
alaRouteMapRedistDestProtoId
alaRouteMapRedistRouteMapIndex
alaRouteMapRedistStatus
alaRouteMapRedistAddressType
alaRouteMapRedistRowStatus

page 16-120 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip access-list

show ip access-list
Displays the details of the access list.
show ip access-list [access_list_name]

Syntax Definitions

access_list_name Name of the access list.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If the access_list_name is not specified in this command, all the access lists are displayed.

Examples
-> show ip access-list
Address / Redistribution
Name Prefix Length Effect Control
--------------------+------------------+-------+--------------
al_3 10.0.0.0/8 permit all-subnets
al_3 11.0.0.0/8 permit all-subnets
al_4 1.0.0.0/8 permit no-subnets
al_4 10.0.0.0/8 permit all-subnets

-> show ip access-list al_4

Address / Redistribution
Name Prefix Length Effect Control
--------------------+------------------+-------+--------------
al_4 1.0.0.0/8 permit no-subnets
al_4 10.0.0.0/8 permit all-subnets

output definitions
Name Name of the access list.
Address/Prefix Length IP address that belongs to the access list.
Effect Indicates whether the IP address is permitted or denied.
Redistribution Control Indicates the conditions specified for redistributing the matched routes.

Release History
Release 8.1.1; command introduced

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-121
show ip access-list IP Commands

Related Commands

ip access-list Creates an access list for adding multiple IPv4 addresses to route maps.
ip access-list address Adds multiple IPv4 addresses to the access list.

MIB objects
alaRouteMapAccessListIndex
alaRouteMapAccessListAddressType
alaRouteMapAccessListAddress
alaRouteMapAccessListPrefixLength
alaRouteMapAccessListAction
alaRouteMapAccessListRedistControl

page 16-122 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip route-map

show ip route-map
Displays the IP route maps configured on the switch.
show ip route-map [route_map_name]

Syntax Definitions

route_map_name The name of the specific route map.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If the route_map_name is not specified in this command, all the route maps are displayed.

Examples
-> show ip route-map
Route Maps: configured: 1 max: 200
Route Map: Route_map1 Sequence Number: 50 Action permit
match ip address 10.0.0.0/8 redist-control all-subnets permit
set metric 100 effect replace

Release History
Release 8.1.1; command introduced

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-123
show ip route-map IP Commands

Related Commands
ip route-map action Creates a route map for selecting or filtering routes for tasks such
as redistribution and VRF route leaking. It also sets the action of
the route map to permit or deny.
ip route-map match ip address Matches the route with the specified IPv4 address or with addresses
contained in an IPv4 access list specified by the access list name.
ip route-map match ipv6 Matches the route with the specified IPv6 address or with addresses
address contained in an IPv6 access list specified by the access list name
ip route-map match ip- Matches the routes that have a next-hop router address permitted
nexthop by the specified access list.
ip route-map match ipv6- Matches the routes that have an IPv6 next-hop router address
nexthop permitted by the specified access list
ip route-map match tag Permits or denies a route based on the specified next-hop IP
address.
ip route-map match tag Matches the tag value specified in the route map with the one that
the routing protocol learned the route on.
ip route-map match metric Matches the metric value specified in the route map with the one
that the routing protocol learned the route on.
ip route-map match route-type Matches the specified route type with the one that the routing
protocol learned the route on.

MIB Objects
alaRouteMapRedistProtoTable
alaRouteMapRedistRouteMapIndex
alaRouteMapTable
alaRouteMapIndex
alaRouteMapSequence
alaRouteMapType
alaRouteMapValue
alaRouteMapRowStatus

page 16-124 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip router database

show ip router database

Displays a list of all routes (static and dynamic) that exist in the IP router database. This database serves as
a central repository where routes are first processed and where duplicate routes are compared to determine
the best route for the Forwarding Routing Database. If a route does not appear in the IP router database
list, then the switch does not know about it. In the case of dynamically learned routes, this could indicate
that the route was never received by the switch.
[vrf vrf_name] show ip router database [protocol type | gateway ip_address | dest {ip_address/
prefixlen | ip_address}]

Syntax Definitions

vrf_name The alphanumeric name (1–20 characters) assigned to the VRF instance.
type Routing protocol type (local, static, OSPF, RIP, or BGP).
ip_address Destination IP address.
ip_address/prefixlen The destination IP address along with the prefix length of the routes pro-
cessed for redistribution.

Defaults
By default, all routes are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Command options are not mutually exclusive. You can use them on the same command line to narrow
and/or customize the output display of this command. For example, use the protocol and dest options
to display only those routes that are of a specific protocol type and have the specified destination
network.
• The IP forwarding table is derived from IP router database processing performed by the switch and
contains only unique routes that the switch currently uses. Use the show ip route command to view the
forwarding table.
• If an expected route does not appear in the IP forwarding table, use the show ip router database
command to see if the switch knows about the route and/or if a duplicate route with a higher
precedence was selected instead.
• The switch compares the protocol of duplicate routes to determine which one to use. Regardless of
whether a route has a higher priority metric value, protocol determines precedence. Local routes are
given the highest level of precedence followed by static, OSFP, RIP, then BGP routes. As a result, a
route that is known to the switch does not appear in the IP forwarding table if a duplicate route with a
higher protocol precedence exists.
• A list of inactive static routes is also included in the show ip router database output display. A route
becomes inactive if the interface for its gateway goes down. Inactive routes are unable to get to their
destination and further investigation is warranted to determine why their gateway is unavailable.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-125
show ip router database IP Commands

• Static routes that appear as inactive are not included in the main IP router database listing. If an
inactive route becomes active, however, it is removed from the inactive list and added to the active
route list.
• The imported routes are also displayed under the protocol field as IMPORT in the show output.

Examples

-> show ip router database

Legend: + indicates routes in-use

b indicates BFD-enabled static route
r indicates recursive static route, with following address in brackets
i indicates static interface route

Destination Gateway Interface Protocol Metric Tag Misc-Info

-------------------+--------------+-----------+--------+---------+------+---------
+ 20.0.0.0/8 20.0.0.1 ip20 LOCAL 1 0
+b 22.0.0.0/8 20.0.0.22 ip20 STATIC 4 0
22.0.0.0/8 20.0.0.9 ip20 RIP 22 0 (backup)
+r 33.0.0.0/8 20.0.0.9 ip20 STATIC 33 0 [22.0.0.33]
+i 44.0.0.0/8 20.0.0.1 ip20 STATIC 5 0
+ 127.0.0.1/32 127.0.0.1 Loopback LOCAL 1 0
+ 172.28.4.0/32 172.28.4.1 EMP LOCAL 1 0

Inactive Static Routes

Destination Gateway Metric Tag Misc-Info

---------------+--------------+---------------+-------+-----------
1.0.0.0/8 8.4.5.3 1 0

-> show ip router database dest 10.212.62.0/24 protocol ospf

Destination Gateway Interface Protocol Metric Tag Misc-Info

-----------------+--------------+-----------+----------+--------+--------+---------
10.212.62.0/24 10.212.60.27 I1 OSPF 2 0
10.212.62.0/24 10.212.61.27 I2 OSPF 2 0

Inactive Static Routes

Destination Gateway Metric Tag Misc-Info

----------------+--------------+--------+-------+-----------
1.0.0.0/8 8.4.5.3 1 0

output definitions
Destination Destination IP address. Also includes the mask prefix length notation
after the address to indicate the subnet mask value. For example, /24
indicates the destination IP address has a 24-bit mask (255.255.255.0).
Gateway IP address of the gateway from which this route was learned.
Interface The interface associated with the gateway.

page 16-126 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip router database

output definitions
Protocol Protocol by which this IP address was learned: LOCAL, STATIC,
OSPF, RIP, BGP).
Metric RIP metric or cost (hop count) for the route. Indicates a priority for the
route. The lower the metric value, the higher the priority.
Tag The tag associated with the route.
Misc-Info Any additional information about the route.

Release History
Release 8.1.1; command introduced

Related Commands
show ip routes Displays the IP Forwarding table.

MIB Objects
alaIprmRouteTable
alaIprmRouteDest
alaIprmRouteMask
alaIprmRouteTos
alaIprmRouteNextHop
alaIprmRouteProto
alaIprmRouteMetric
alaIprmRoutePriority

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-127
show ip emp-routes IP Commands

show ip emp-routes
Displays the IP routes associated with the Ethernet Management Port (EMP).
show ip emp-routes

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command displays the routes that are connected to the Ethernet Management Port (EMP).

• The EMP cannot handle routing protocols such as RIP or OSPF.

• The default route for the switch cannot be set up on the EMP.

Examples
-> show ip emp-routes
Dest Address Subnet Mask Gateway Addr Age Protocol
------------------+-----------------+-----------------+---------+-----------
127.0.0.1 255.255.255.255 127.0.0.1 2d 4h LOCAL
172.17.1.10 255.255.255.255 10.255.11.225 1d 5h LOCAL

output definitions
Dest Addr Destination IP address.
Subnet Mask Destination IP address IP subnet mask.
Gateway Addr IP address of the gateway from which this address was learned.
Age Age of the entry. If the entry is less than a day old, it is displayed in
hh/mm/ss format. If it is more than a day old, it is displayed in dd/hh
format (for example, a route that is 2 days and 12 hours old is displayed
as 2d12h).
Protocol Protocol by which this IP address was learned (for example, RIP).
NETMGT indicates a static route. LOCAL indicates a local interface.

Release History
Release 8.1.1; command introduced

page 16-128 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip emp-routes

Related Commands
ping Tests whether an IP destination can be reached from the local
switch.
traceroute Finds the path taken by an IP packet from the local switch to a
specified destination.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-129
show ip config IP Commands

show ip config
Displays IP configuration parameters.
show ip config

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip config
IP directed-broadcast = OFF,
IP default TTL = 64

output definitions
IP directed-broadcast Indicates whether the IP directed-broadcast feature is on or off.
IP default TTL IP default TTL interval.

Release History
Release 8.1.1; command introduced

Related Commands
ip directed-broadcast Enables or disables IP directed broadcasts routed through the
switch.
ip default-ttl Sets TTL value for IP packets.

MIB Objects
N/A

page 16-130 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip protocols

show ip protocols
Displays switch routing protocol information and status.
show ip protocols

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip protocols
IP Protocols
RIP status = Not Loaded,
OSPF status = Loaded,
ISIS status = Not Loaded,
BGP status = Loaded,
PIM status = Loaded,
DVMRP status = Not Loaded,
RIPng status = Not Loaded,
OSPF3 status = Loaded,

output definitions
RIP status Whether RIP is loaded or not.
OSPF status Whether OSPF is loaded or not.
BGP status Whether BGP is loaded or not.
DVMRP status Whether DVMRP is loaded or not.
PIMSM status Whether PIMSM is loaded or not.
RIPng status Whether RIP is loaded or not.
OSPF3 status Whether OSPFv3 is loaded or not.

Release History
Release 8.1.1; command introduced

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-131
show ip protocols IP Commands

Related Commands
ip router primary-address Configures the router primary IP address.
ip router router-id Configures the router ID for the router.

MIB Objects
alaIpRouteSumTable
alaIpRouteProtocol

page 16-132 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip router-id

show ip router-id
Displays the primary IP address and router ID of the switch, if configured.
show ip router-id

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip router-id
Router ID = 1.1.1.1,
Primary addr = 31.0.0.1

output definitions
Router ID The set routing ID. The router ID is how the router is identified in IP.
Primary addr The primary interface address the route uses.

Release History
Release 8.1.1; command introduced

Related Commands
ip router primary-address Configures the router primary IP address.
ip router router-id Configures the router ID for the router.

MIB Objects
alaIpRouteSumTable
alaIpRouteProtocol

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-133
show ip service IP Commands

show ip service
Displays the status of TCP/UDP service ports.
show ip service

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The display output from this command also includes the service port number.

Examples
-> show ip service
Name Port Status
----------------------+-------+---------
ftp 21 enabled
ssh 22 disabled
telnet 23 disabled
udp-relay 67 disabled
http 80 disabled
network-time 123 disabled
snmp 161 disabled
avlan-telnet 259 disabled
avlan-http 260 disabled
avlan-secure-http 261 disabled
secure_http 443 enabled
proprietary 1024 disabled
proprietary 1025 disabled

output definitions
Name Name of the TCP/UDP service.
Port The TCP/UDP well-known port number associated with the service.
Status The status of the well-known service port: enabled (port is closed) or
disabled (port is open).

Release History
Release 8.1.1; command introduced

page 16-134 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip service

Related Commands
ip service Enables (opens) or disables (closes) well-known TCP/UDP service
ports.

MIB Objects
alaIpServiceTable
alaIpServiceType
alaIpServicePort
alaIpServiceStatus
alaIpPortServiceTable
alaIpPortServicePort
alaIpPortServiceStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-135
show ip service source-ip IP Commands

show ip service source-ip

Displays the source IP interfaces configured for the applications.
[vrf vrf_name] show ip service source-ip

Syntax Definitions

vrf_name Name of the VRF.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip service source-ip
Legend: "-"denotes no explicit configuration.

Application Interface-name
------------------+----------------------
dns -
ftp ipVlan100
ldap Loopback0
ntp Loopback0
radius Loopback0
sflow -
snmp Loopback0
ssh ipVlan100
swlog -
tacacs -
telnet -
tftp ipVlan100

output definitions
Application Name of the TCP/UDP service.
Interface-name The source IP configured for the application.

Release History
Release 8.2.1; command introduced

page 16-136 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip service source-ip

Related Commands
ip service source-ip Configures a user-defined source IP address as the outgoing IP
interface for the IP service.

MIB Objects
alaIpServiceSourceIPTable
alaIPServiceSourceIpAppIndex
alaIPServiceSourceIpNane
alaIpServiceSourceIpRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-137
show ip dos arp-poison IP Commands

show ip dos arp-poison

Displays the number of attacks detected for configured ARP poison restricted-addresses.
show ip dos arp-poison

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip dos arp-poison
IP Address Attacks
-----------------------------------+------------
192.168.1.1 0
192.168.1.2 0
192.168.1.3 0

output definitions
IP Address The configured ARP Poison restricted-addresses.
Attacks detected The number of ARP Poison attacks detected for each address.

Release History
Release 8.1.1; command introduced

Related Commands
ip dos arp-poison restricted- Adds or deletes an ARP Poison restricted address.
address

MIB Objects
alaDoSArpPoisonTable
alaDoSArpPoisonIpAddr
alaDoSArpPoisonDetected

page 16-138 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show arp

show arp
Displays the ARP table. The ARP table contains a listing of IP addresses and their corresponding
translations to physical MAC addresses.
show arp [ip_address | mac_address]

Syntax Definitions

ip_address IP address of the entry you want to view.

mac_address MAC address of the entry you want to view.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the basic command (show arp) to view all of the entries in the table. Enter a specific IP address or
MAC address to view a specific entry.

Examples
-> show arp
Total 8 arp entries
Flags (P=Proxy, A=Authentication, V=VRRP, R=Remote, B=BFD, H=HAVLAN, I=Interface)

IP Addr Hardware Addr Type Flags Port Interface

-----------------+-------------------+----------+-------+--------+----------
10.255.11.59 00:50:04:b2:c9:ee DYNAMIC 3/20 vlan 1
10.255.11.48 00:50:04:b2:ca:11 DYNAMIC 3/20 vlan 1
10.255.11.201 00:10:83:03:e7:e4 DYNAMIC 3/20 vlan 1
10.255.11.14 00:10:5a:04:19:a7 DYNAMIC 3/20 vlan 1
10.255.11.64 00:b0:d0:62:fa:f1 DYNAMIC 3/20 vlan 1
10.255.11.25 00:b0:d0:42:80:24 DYNAMIC 3/20 vlan 1
10.255.11.26 00:b0:d0:42:82:59 DYNAMIC 3/20 vlan 1
20.0.0.22 e4:c2:33:00:21:12 STATIC I 1/20 ip20
10.255.11.254 00:20:da:db:00:47 DYNAMIC 3/20 vlan 1

output definitions
IP Address Device IP address.
Hardware Addr MAC address of the device that corresponds to the IP address.
Type Indicates whether the ARP cache entries are dynamic or static.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-139
show arp IP Commands

output definitions (continued)

Flags Indicates the type of entry:
• P = Proxy
• A = Authentication (AVLAN)
• V = VRRP
• R = Remote
• B = BFD
• H = HAVLAN
• I = Interface
Port The port on the switch attached to the device identified by the IP
address.
Interface The interface to which the entry belongs (for example, VLAN, EMP).

Release History
Release 8.1.1; command introduced

Related Commands
ip service Adds a permanent entry to the ARP table.
clear arp-cache Deletes all dynamic entries from the ARP table.

MIB Objects
ipNetToMediaTable
ipNetToMediaIfIndex
ipNetToMediaNetAddress
ipNetToMediaPhyAddress
ipNetToMediaType
ipNetToMediaAugTable
ipNetToMediaSlot
ipNetToMediaPort
alaIpNetToMediaTable
alaIpNetToMediaPhyAddress
alaIpNetToMediaProxy
alaIpNetToMediaVRRP
alaIpNetToMediaAuth

page 16-140 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show arp filter

show arp filter

Displays a list of ARP filters configured for the switch.
show arp filter [ip_address]

Syntax Definitions

ip_address IP address of the filter entry you want to view.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If an IP address is not specified with this command, a list of all ARP filters is displayed.

• Enter a specific IP address to view the configuration for an individual filter.

Examples
-> show arp filter
IP Addr IP Mask Vlan Type Mode
-----------------+-------------------+------+----------+-------
171.11.1.1 255.255.255.255 0 target block
172.0.0.0 255.0.0.0 0 target block
198.0.0.0 255.0.0.0 0 sender block
198.172.16.1 255.255.255.255 200 target allow

-> show arp filter 198.172.16.1

IP Addr IP Mask Vlan Type Mode
-----------------+-------------------+------+----------+-------
198.0.0.0 255.0.0.0 0 sender block
198.172.16.1 255.255.255.255 200 target allow

output definitions
IP Addr The ARP packet IP address to which the filter is applied.
IP Mask The IP mask that specifies which part of the IP address to which the
filter is applied.
Vlan A VLAN ID. The filter is applied only to ARP packets received on
ports associated with this VLAN.
Type Indicates which IP address in the ARP packet (sender or target) is
used to identify if a filter exists for that address.
Mode Indicates whether to block or allow a switch response to an ARP
packet that matches the filter.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-141
show arp filter IP Commands

Release History
Release 8.1.1; command introduced

Related Commands
arp filter Adds a permanent entry to the ARP table.
clear arp filter Deletes all dynamic entries from the ARP table.

MIB Objects
alaIpArpFilterTable
alaIpArpFilterIpAddr
alaIpArpFilterIpMask
alaIpArpFilterVlan
alaIpArpFilterMode
alaIpArpFilterType

page 16-142 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show icmp control

show icmp control

Allows the viewing of the ICMP control settings.
show icmp control

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use this command to view the status of the various ICMP messages. It is also useful to determine the type
and code of the less common ICMP messages.

Examples
-> show icmp control
Name Type Code Status min-pkt-gap(us)
-------------------------------------+------+------+---------+------------------
echo reply 0 0 enabled 0
network unreachable 3 0 enabled 0
host unreachable 3 1 enabled 0
protocal unreachable 3 2 enabled 0
port unreachable 3 3 enabled 0
frag needed but DF bit set 3 4 enabled 0
source route failed 3 5 enabled 0
destination network unknown 3 6 enabled 0
destination host unknown 3 7 enabled 0
source host isolated 3 8 enabled 0
dest network admin prohibited 3 9 enabled 0
host admin prohibited by filter 3 10 enabled 0
network unreachable for TOS 3 11 enabled 0
host unreachable for TOS 3 12 enabled 0
source quench 4 0 enabled 0
redirect for network 5 0 enabled 0
redirect for host 5 1 enabled 0
redirect for TOS and network 5 2 enabled 0
redirect for TOS and host 5 3 enabled 0
echo request 8 0 enabled 0
router advertisement 9 0 enabled 0
router solicitation 10 0 enabled 0
time exceeded during transmit 11 0 enabled 0
time exceeded during reassembly 11 1 enabled 0
ip header bad 12 0 enabled 0
required option missing 12 1 enabled 0
timestamp request 13 0 enabled 0

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-143
show icmp control IP Commands

timestamp reply 14 0 enabled 0

information request(obsolete) 15 0 enabled 0
information reply(obsolete) 16 0 enabled 0
address mask request 17 0 enabled 0
address mask reply 18 0 enabled 0

output definitions
Name The name of the ICMP message.
Type The ICMP message type. This along with the ICMP code specifies the
ICMP message.
Code The ICMP message code. This along with the ICMP type specifies the
ICMP message.
Status Whether this message is Enabled or Disabled.
min-pkt-gap The minimum packet gap, in microseconds, for this ICMP message.
The minimum packet gap is the amount of time that must pass between
ICMP messages of like types.

Release History
Release 8.1.1; command introduced

Related Commands
icmp type Enables or disables a specific type of ICMP message, and sets the
minimum packet gap.
icmp unreachable Enables or disables ICMP messages pertaining to unreachable
destinations, and sets the minimum packet gap.
icmp echo Enables or disables ICMP echo messages, and sets the minimum
packet gap.
icmp timestamp Enables or disables ICMP timestamp messages, and sets the
minimum packet gap.
icmp addr-mask Enables or disables ICMP address mask messages, and sets the
minimum packet gap.
icmp messages Enables or disables all ICMP messages.

MIB Objects
N/A

page 16-144 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show icmp statistics

show icmp statistics

Displays Internet Control Message Protocol (ICMP) statistics and errors. ICMP is a network layer
protocol within the IP protocol suite that provides message packets to report errors and other IP packet
processing information back to the source. ICMP generates several kinds of useful messages, including
Destination Unreachable, Echo Request and Reply, Redirect, Time Exceeded, and Router Advertisement
and Solicitation. If an ICMP message cannot be delivered, no second one is generated. This is to avoid an
endless flood of ICMP messages.
show icmp [statistics]

Syntax Definitions

statistics Optional syntax.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the ICMP Table to monitor and troubleshoot the switch.

Examples
-> show icmp
Messages Received Sent
-------------------------+-----------+------------
Total 2105 2105
Error 0 0
Destination unreachable 0 0
Time exceeded 0 0
Parameter problem 0 0
Source quench 0 0
Redirect 0 0
Echo request 2105 0
Echo reply 0 2105
Time stamp request 0 0
Time stamp reply 0 0
Address mask request 0 0
Address mask reply 0 0

output definitions
Total Total number of ICMP messages the switch received or attempted to
send. This counter also includes all the messages that were counted as
errors.
Error Number of ICMP messages the switch sent/received but was unable to
process because of ICMP-specific errors (for example, bad ICMP
checksums, bad length).

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-145
show icmp statistics IP Commands

output definitions (continued)

Destination unreachable Number of “destination unreachable” messages that were sent/received
by the switch.
Time exceeded Number of “time exceeded” messages that were sent/received by the
switch. These messages occur when a packet is dropped because the
TTL counter reaches zero. When a large number of these messages
occur, it is a symptom that packets are looping, that congestion is
severe, or that the TTL counter value is set too low. These messages
also occur when all the fragments trying to be reassembled do not
arrive before the reassembly timer expires.
Parameter problem Number of messages sent/received which indicate that an illegal value
has been detected in a header field. These messages can indicate a
problem in the sending IP software of the host or gateway.
Source quench Number of messages sent/received that tell a host that it is sending too
many packets. A host must attempt to reduce its transmissions upon
receiving these messages.
Redirect Number of ICMP redirect messages sent/received by the switch.
Echo request Number of ICMP echo messages sent/received by the switch to see if a
destination is active and unreachable.
Echo reply Number of echo reply messages received by the switch.
Time stamp request Number of time stamp request messages sent/received by the switch.
Time stamp reply Number of time stamp reply messages sent/received by the switch.
Address mask request Number of address mask request messages that were sent/received by
the switch in an attempt to determine the subnet mask for the network.
Address mask reply Number of address mask reply messages that were sent/received by the
switch.

Release History
Release 8.1.1; command introduced

Related Commands
show udp statistics Displays UDP errors and statistics.

MIB Objects
N/A

page 16-146 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show tcp statistics

show tcp statistics

Displays TCP statistics.
show tcp statistics

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show tcp statistics
Total segments received = 235080,
Error segments received = 0,
Total segments sent = 363218,
Segments retransmitted = 38,
Reset segments sent = 97,
Connections initiated = 57185,
Connections accepted = 412,
Connections established = 1,
Attempt fails = 24393,
Established resets = 221

output definitions
Total segments received Total number of segments received, including the segments received in
the error. This count includes segments received on currently
established connections.
Error segments received Total number of segments received in error (for example, bad TCP
checksums).
Total segments sent Total number of segments sent, including those on current connections
but excluding those containing only retransmitted octets.
Segments retransmitted Number of TCP segments transmitted containing one or more
previously transmitted octets.
Reset segments sent Number of TCP segments containing the reset flag.
Connections initiated Number of connections attempted.
Connections accepted Number of connections allowed.
Connections established Number of successful connections.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-147
show tcp statistics IP Commands

output definitions (continued)

Attempt fails Number of times attempted TCP connections have failed.
Established resets Number of times TCP connections have been reset from the
"Established" or "Close Wait" state to the “Closed” state.

Release History
Release 8.1.1; command introduced

Related Commands
show icmp statistics Displays ICMP statistics and errors.
show tcp ports Displays the TCP connection table.

MIB Objects
N/A

page 16-148 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show tcp ports

show tcp ports

Displays the TCP connection table.
show tcp ports

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use this table to check the current available TCP connections.

Examples
-> show tcp ports
Local Address Local Port Remote Address Remote Port State
------------------+------------+-----------------+--------------+-------------
0.0.0.0 21 0.0.0.0 0 LISTEN
0.0.0.0 23 0.0.0.0 0 LISTEN
0.0.0.0 80 0.0.0.0 0 LISTEN
0.0.0.0 260 0.0.0.0 0 LISTEN
0.0.0.0 261 0.0.0.0 0 LISTEN
0.0.0.0 443 0.0.0.0 0 LISTEN
0.0.0.0 6778 0.0.0.0 0 LISTEN
10.255.11.223 23 128.251.16.224 1867 ESTABLISHED
10.255.11.223 2509 10.255.11.33 389 TIME-WAIT
10.255.11.223 2510 10.255.11.25 389 TIME-WAIT
10.255.11.223 2513 10.255.11.33 389 TIME-WAIT
10.255.11.223 2514 10.255.11.25 389 TIME-WAIT
10.255.11.223 2517 10.255.11.33 389 TIME-WAIT
10.255.11.223 2518 10.255.11.25 389 TIME-WAIT
10.255.11.223 2521 10.255.11.33 389 TIME-WAIT
10.255.11.223 2522 10.255.11.25 389 TIME-WAIT
10.255.11.223 2525 10.255.11.33 389 TIME-WAIT
10.255.11.223 2526 10.255.11.25 389 TIME-WAIT
10.255.11.223 2529 10.255.11.33 389 TIME-WAIT
10.255.11.223 2530 10.255.11.25 389 TIME-WAIT

output definitions
Local Address Local IP address for this TCP connection. If a connection is in the
LISTEN state it accepts connections for any IP interface associated
with the node. The IP address 0.0.0.0 is used.
Local Port Local port number for this TCP connection. The range is 0–65535.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-149
show tcp ports IP Commands

output definitions (continued)

Remote Address Remote IP address for this TCP connection.
Remote Port Remote port number for this TCP connection. The range is 0–65535.
State State of the TCP connection, as defined in RFC 793. A connection
progresses through a series of states during its lifetime:
• Listen—Waiting for a connection request from any remote TCP
and port.
• Syn Sent—Waiting for a matching connection request after having
sent a connection request.
• Syn Received—Waiting for a confirming connection request
acknowledgment after having both received and sent a connection
request.
• Established—Open connection. Data received can be delivered to
the user. This is the normal state for the data transfer phase of the
connection.
• Fin Wait 1—Waiting for a connection termination request from the
remote TCP, or an acknowledgment of the connection termination
request previously sent.
• Fin Wait 2—Waiting for a connection termination request from the
remote TCP.
• Close Wait—Waiting for a connection termination request from the
local user.
• Closing—Waiting for a connection termination request
acknowledgment from the remote TCP.
• Last Ack—Waiting for an acknowledgment of the connection
termination request previously sent to the remote TCP (which
includes an acknowledgment of its connection termination request).
• Time Wait—Waiting for enough time to pass to be sure the remote
TCP received the acknowledgment of its connection termination
request.
• Closed—No connection state.

Release History
Release 8.1.1; command introduced

Related Commands
show ip interface Displays the status and configuration of IP interfaces.
show tcp statistics Displays TCP statistics.

MIB Objects
N/A

page 16-150 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show udp statistics

show udp statistics

Displays UDP errors and statistics.
show udp statistics

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays cumulative statistics since the last time the switch was powered on or since the
last reset of the switch.

Examples
-> show udp statistics
Total datagrams received = 214937,
Error datagrams received = 0,
No port datagrams received = 32891,
Total datagrams sent = 211884

output definitions
Total datagrams received Total number of UDP datagrams delivered to UDP applications.
Error datagrams received Number of UDP datagrams that could not be delivered for any reason.
No port datagrams received Number of UDP datagrams that could not be delivered for reasons
other than lack of application at the destination.
Total datagrams sent Total number of UDP datagrams sent from this switch.

Release History
Release 8.1.1; command introduced

Related Commands
show udp ports Displays the UDP Listener table.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-151
show udp ports IP Commands

show udp ports

Displays the UDP Listener table. The table shows the local IP addresses and the local port number for each
UDP listener.
show udp ports

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• An IP address of zero (0.0.0.0) indicates that it is listening on all interfaces.
• This table contains information about the UDP end-points on which a local application is currently
accepting datagrams.

Examples
-> show udp port
Local Address Local Port
------------------+--------------
0.0.0.0 67
0.0.0.0 161
0.0.0.0 520

output definitions
Local Address Local IP address for this UDP connection.
Local Port Local port number for this UDP connection.

Release History
Release 8.1.1; command introduced

Related Commands
show udp statistics Displays UDP errors and statistics.

MIB Objects
N/A

page 16-152 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip dos config

show ip dos config

Displays the DoS scan configuration for the switch.
show ip dos config

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command allows the user to view the configuration parameters of the DoS scan. The scan keeps a
record of the penalties incurred by certain types of packets on TCP and UDP ports. When the set penalty
threshold is reached, it is assumed a DoS attack is in progress, and a trap is generated to inform the system
administrator.

Examples
-> show ip dos config

Dos type Status

-------------------------------------------+-----------------
port scan ENABLED
ping of death ENABLED
loopback-src ENABLED
invalid-ip ENABLED
invalid-multicast ENABLED
unicast dest-ip/multicast-mac ENABLED
ping overload DISABLED
arp flood ENABLED
arp poison

DoS trap generation = ENABLED,

DoS port scan threshold = 1000,
DoS port scan decay = 2,
DoS port scan close port penalty = 10,
DoS port scan TCP open port penalty = 0,
DoS port scan UDP open port penalty = 0,
Dos MAximum Ping Rate = 100
Dos Maximum ARP Request Rate = 500

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-153
show ip dos config IP Commands

output definitions
DoS Type The type of DoS attack.
Status Whether or not detection for this type of DoS attack is enabled.
Configured through the ip dos type command.
DoS trap generation Displays the status of DoS trap generation. It is either ENABLED or
DISABLED. This is set using the ip dos trap command.
DoS port scan threshold The penalty threshold setting. When enough packets have increased the
penalty number to this setting, a trap is generated to warn the
administrator that a DoS attack is in progress. This is set using the ip
dos scan threshold command.
DoS port scan decay The decay value for the switch. The penalty value of the switch is
decreased by this number every minute. This is set using the ip dos
scan decay command.
DoS port scan close port pen- The penalty value for packets received on closed UDP and TCP ports.
alty The penalty number for the switch is increased by this amount every
time a packet is received on a closed UDP or TCP port. This is set using
the ip dos scan close-port-penalty command.
DoS port scan TCP open port The penalty value for packets received on open TCP ports. The penalty
penalty number for the switch is increased by this amount every time a packet
is received on an open TCP port. This is set using the ip dos scan tcp
open-port-penalty command.
DoS port scan UDP open port The penalty value for packets received on open UDP ports. The penalty
penalty number for the switch is increased by this amount every time a packet
is received on an open UDP port. This is set using the ip dos scan udp
open-port-penalty command.

Release History
Release 8.1.1; command introduced

Related Commands
show ip dos statistics Displays the statistics for detected DoS attacks on the switch.

MIB Objects
alaDosTable
alaDoSType
alaDoSStatus
alaDoSConfig
alaDoSPortScanClosePortPenalty
alaDoSPortScanUdpOpenPortPenalty
alaDoSPortScanTotalPenalty
alaDoSPortScanThreshold
alaDoSPortScanDecay
alaDoSTrapCntl
alaDoSARPRate
alaDoSPingRate

page 16-154 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show ip dos statistics

show ip dos statistics

Displays the statistics for detected DoS attacks on the switch.
show ip dos statistics

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command displays the number of attacks the switch has detected for several types of DoS attacks.

• If an attack is detected and reported, it does not necessarily mean that an attack occurred. The switch
assumes a DoS attack is underway anytime the penalty threshold is exceeded. It is possible for this
threshold to be exceeded when no attack is in progress.
• Statistics for the “unicast dest-ip/multicast-mac” DoS type are not reported for the multicast MAC
address attack. In this case, the packet is dropped at a lower level so IP never sees the attack. IP only
collects and reports statistics for IP attacks.

Examples
-> show ip dos statistics

DoS type Attacks detected

----------------------------------+--------------------------
port scan 0
ping of death 0
land 0
loopback-src 0
invalid-ip 0
invalid-multicast 0
unicast dest-ip/multicast-mac 52
ping overload 0
arp flood 0
arp poison 0

output definitions
DoS type The type of DoS attack.
Attacks detected The number of attacks detected for each DoS type.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-155
show ip dos statistics IP Commands

Release History
Release 8.1.1; command introduced

Related Commands
ip dos type Enables or disables detection for a specific type of DoS attack.
show ip dos config Displays the DoS scan configuration for the switch.

MIB Objects
alaDoSTable
alaDoSType
alaDoSDetected

page 16-156 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show vrf

show vrf
Displays the Multiple VRF instance configuration for the switch.
show vrf [vrf_name | default]

Syntax Definitions

vrf_name The name of an existing VRF instance.

default Selects the default VRF instance.

Defaults
By default, a list of all VRF instances is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the vrf_name parameter to display route-map resource information for a specific VRF instance.

• Use the default parameter to display route-map resource information for the default VRF instance.

• The type of profile (low or max) assigned to a VRF determines the routing capabilities and the amount
of route-map resources available for that specific VRF instance.

Examples
-> show vrf
Virtual Routers Profile Protocols
--------------------+-------+-------------------
default default BGP PIM VRRP
customer1 max RIP OSPF
customer2 max RIP OSPF
customer3 low

Total Number of Virtual Routers: 4

output definitions
Virtual Routers The name of the VRF instance.
Profile The type of profile applied to this instance (low or max).
Protocols The protocols loaded within the context of this instance.

-> show vrf customer1

Legend: in use/max
route-maps : 3/30,
sequences : 5/60,
tlvs : 8/100,
access-lists : 0/20,
address blocks : 0/40,
match interfaces : 3/100

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-157
show vrf IP Commands

-> show vrf customer3

Legend: in use/max
route-maps : 0/10,
sequences : 0/20,
tlvs : 0/20,
access-lists : 0/10,
address blocks : 0/10,
match interfaces : 0/10

-> show vrf default

Legend: in use/max
route-maps : 0/200,
sequences : 0/400,
tlvs : 0/1000,
access-lists : 0/200,
address blocks : 0/500,
match interfaces : 0/2000

output definitions
route-maps The number of route maps used and the maximum allowed.
sequences The number of route map sequences used and the maximum allowed.
tlvs The number of TLV blocks used and the maximum allowed. The TLV
blocks contain the route-map match and set clauses.
access-lists The number of route-map access lists used and the maximum allowed.
address blocks The number of address blocks used and the maximum allowed. The
address blocks hold access list addresses.
match interfaces The number of route-map interfaces used in match clauses and the
maximum allowed.

Release History
Release 8.1.1; command introduced.

Related Commands
vrf Configures a Multiple VRF instance for the switch.
show vrf-profiles Displays a summary of VRF profile usage and route map
resources.
show ip protocols Displays switch routing protocol information and status.

page 16-158 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show vrf

MIB Objects
alaVrConfigTable
alaVrConfigIndex
alaVrConfigRipStatus
alaVrConfigOspfStatus
alaVrConfigIsisStatus
alaVrConfigBgpStatus
alaVrConfigPimStatus
alaVrConfigDvmrpStatus
alaVrConfigRipngStatus
alaVrConfigOspf3Status
alaVrConfigMplsLdpStatus
alaVrConfigVrrpStatus
alaVirutalRouterNameTable
alaVirtualRouterName
alaVirtualRouterNameIndex
alaVirtualRouterNameRowStatus
alaVirtualRouterProfile
alaVirtualRouterMaxRouteMaps
alaVirtualRouterMaxSequences
alaVirtualRouterMaxTlvs
alaVirtualRouterMaxAccessLists
alaVirtualRouterMaxAddressBlocks
alaVirtualRouterMaxMatchInterfaces

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-159
show vrf-profiles IP Commands

show vrf-profiles
Displays the current VRF profile usage and the maximum route-map resources allowed for each profile
type (default, low, and max).
show vrf-profiles

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command also provides an estimate of the number of low profile VRFs that can be created.

Examples
-> show vrf-profiles
EST: Estimated number of low profile VRFs that can be created
RM: Maximum route-maps
SEQ: Maximum sequences
TLV: Maximum TLVs (used to hold match and set clauses)
AL: Maximum access-lists
AB: Maximum address blocks (used to hold addresses)
ITF: Maximum route-map interfaces used in match clauses

Profile Inuse EST RM SEQ TLV AL AB ITF

----------------+-----+----+----+----+----+----+----+----
default 1 - 200 400 1000 200 500 2000
low 2 329 10 20 20 10 10 10
max 3 - 30 60 100 20 40 100

Release History
Release 8.1.1; command introduced.

page 16-160 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Commands show vrf-profiles

Related Commands
vrf Configures and selects a VRF instance on the switch.
show vrf Displays the VRF configuration for the switch.

MIB Objects
alaVirtualRouterProfileTable
alaVirtualRouterProfileName
alaVirtualRouterProfileMaxRouteMaps
alaVirtualRouterProfileMaxSequences
alaVirtualRouterProfileMaxTlvs
alaVirtualRouterProfileMaxAccessLists
alaVirtualRouterProfileMaxAddressBlocks
alaVirtualRouterProfileMaxMatchInterfaces

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 16-161
show vrf-profiles IP Commands

page 16-162 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 17 IPv6 Commands

This chapter details Internet Protocol Version 6 (IPv6) commands for the switch (including RIPng
commands). IPv6 (documented in RFC 2460) is designed as a successor to IPv4. The changes from IPv4
to IPv6 fall primarily into the following categories:
Expanded Routing and Addressing Capabilities - IPv6 increases the IP address size from 32 bits to 128
bits, to support more levels of addressing hierarchy and a much greater number of addressable nodes, and
simpler auto-configuration of addresses. The scalability of multicast routing is improved by adding a
“scope” field to multicast addresses.
Header Format Simplification - Some IPv4 header fields were dropped or made optional, to reduce the
common-case processing cost of packet handling and to keep the bandwidth cost of the IPv6 header as low
as possible despite the increased size of the addresses. Even though the IPv6 addresses are four times
longer than the IPv4 addresses, the IPv6 header is only twice the size of the IPv4 header.
Anycast Addressing - A new type of address called a "anycast address" is defined, to identify sets of
nodes where a packet sent to an anycast address is delivered to one of the nodes. The use of anycast
addresses in the IPv6 source route allows nodes to control the path on which their traffic flows.
Improved Support for Options - Changes in the way IP header options are encoded allows for more
efficient forwarding, less stringent limits on the length of options, and greater flexibility for introducing
new options in the future.
Authentication and Privacy Capabilities - IPv6 includes the definition of extensions which provide
support for authentication, data integrity, and confidentiality. This is included as a basic element of IPv6
and will be included in all implementations.
MIB information for the IPv6 and RIPng commands is as follows:
Filename: Ipv6.mib
Module: Ipv6-MIB
Filename: AlcatelIND1Ipv6.mib
Module: alcatelIND1IPv6MIB
Filename: AlcatelIND1Iprmv6.mib
Module: alcatelIND1IprmV6MIB
Filename: AlcatelIND1Ripng.mib
Module: alcatelIND1RipngMIB

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-1
 IPv6 Commands

A summary of the IPv6 commands is listed here:

IPv6 ipv6 interface

ipv6 address
ipv6 address global-id
ipv6 address local-unicast
ipv6 dad-check
ipv6 hop-limit
ipv6 pmtu-lifetime
ipv6 neighbor stale-lifetime
ipv6 neighbor
ipv6 neighbor limit
ipv6 neighbor vrf-limit
ipv6 ra-filter
ipv6 static-route
ipv6 route-pref
ipv6 virtual-source-mac
traceroute6
show ipv6 icmp statistics
show ipv6 interface
show ipv6 ra-filter
show ipv6 neighbors
clear ipv6 neighbors
show ipv6 prefixes
show ipv6 routes
show ipv6 route-pref
show ipv6 router database
show ipv6 tcp listeners
show ipv6 tcp connections
show ipv6 tunnel configured
show ipv6 tunnel 6to4
show ipv6 information
IPv6 Route Map ipv6 redist
Redistribution ipv6 access-list
ipv6 access-list address
show ipv6 redist
show ipv6 access-list
IPv6 RIP ipv6 load rip
ipv6 rip admin-state
ipv6 rip invalid-timer
ipv6 rip garbage-timer
ipv6 rip holddown-timer
ipv6 rip jitter
ipv6 rip route-tag
ipv6 rip update-interval
ipv6 rip triggered-sends
ipv6 rip interface
ipv6 rip interface metric
ipv6 rip interface recv-status
ipv6 rip interface send-status
ipv6 rip interface horizon
show ipv6 rip
show ipv6 rip interface
show ipv6 rip peer
show ipv6 rip routes
IPv6 DHCP ipv6 dhcp relay admin-state
ipv6 dhcp relay interface admin-state
ipv6 dhcp relay destination
show ipv6 dhcp relay

page 17-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 interface

ipv6 interface
Configures an IPv6 interface on a VLAN or IPv6 tunnel.
ipv6 interface if_name [vlan vid | tunnel {tid | 6to4}] admin-state [enable | disable]
[base-reachable-time time]
[ra-send {yes | no}]
[ra-max-interval interval]
[ra-managed-config-flag {true | false}]
[ra-other-config-flag {true | false}]
[ra-reachable-time time]
[ra-retrans-timer time]
[ra-default-lifetime time | no ra-default-lifetime]
[ra-min-interval interval | no ra-min-interval]
[ra-clock-skew time]
[ra-send-mtu] {yes | no}
[mtu size]
[retrans-timer time]
[dad-transmits count]
[ra-hop-limit count]
[[no] local-proxy-nd] [neighbor-limit count | no neighbor-limit]
[retrans-backoff backoff] [retrans-max max]
no ipv6 interface if_name

Syntax Definitions

if_name IPv6 interface name.

vlan Identifies a VLAN interface.
vid VLAN ID number.
tunnel Identifies a configured tunnel interface.
tid Tunnel ID number.
6to4 Identifies the 6to4 tunnel interface.
base-reachable-time time Base value used to compute the reachable time for neighbors reached
through this interface.
ra-send Specifies whether the router advertisements are sent on this interface.
ra-max-interval interval Maximum time, in seconds, allowed between the transmission of
unsolicited multicast router advertisements in this interface. The range
is 4 - 1,800.
ra-managed-config-flag Value to be placed in the managed address configuration flag field in
router advertisements sent on this interface.
ra-other-config-flag Value to be placed in the other stateful configuration flag in router
advertisements sent on this interface.
ra-reachable-time time Value, in milliseconds, to be placed in the reachable time field in router
advertisements sent on this interface. The range is 0 - 3,600,000. The
special value of zero indicates that this time is unspecified by the router.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-3
ipv6 interface IPv6 Commands

ra-retrans-timer time Value, in milliseconds, to be placed in the retransmit timer field in

router advertisements sent on this interface. The value zero indicates
that the time is unspecified by the router.
mtu size The maximum transmission unit for a tunnel interface. Use the vlan
command’s mtu-ip to set for a VLAN.
retrans-timer time The amount of time, in milliseconds, between retransmission of a
neighbor solicitation during neighbor discovery.
dad-transmits count The number of neighbor solicitations to send during Duplicate Address
Detection.
ra-hop-limit count The value placed in the current hop limit field of router advertisements
sent on this interface.
ra-default-lifetime time Value, in seconds, to be placed in the router lifetime field in router
advertisements sent on this interface. The time must be zero or between
the value of “ra-max-interval” and 9,000 seconds. A value of zero
indicates that the router is not to be used as a default router. The “no ra-
default-lifetime” option will calculate the value using the formula (3 *
ra-max-interval).
ra-min-interval interval Value, in seconds, allowed between the transmission of unsolicited
multicast router advertisements on this interface. The interval must be a
minimum of 3 and not more than 75 times the value of ra-max-
interval.The “no ra-min-interval” option will calculate the value using
the formula (.33 * ra-max-interval).
ra-clock-skew time Value, in seconds. The router advertisement clock skew allows the link
propagation delays and poorly synchronized clocks on routers
participating in router discover over this interface. The timer differences
that fall within the clock skew value are treated as valid times.
enable | disable Administratively enable or disable the interface.
ra-send-mtu Specifies whether the MTU option is included in the router
advertisements sent on the interface.
[no] local-proxy-nd Enable or disable Local Proxy Neighbor Discovery (LPND) on the
interface. The default value is no.
neighbor-limit count Sets the neighbor cache limit for the interface.
no neighbor-limit Removes the limit set for neighbor cache. The default value is no.
retrans-backoff backoff Sets the Neighbor Unreachability Detection (NUD) exponential back-
off base value. The configurable values are 1, 2 or 3. The default value
is 1. This allows the exponentially increase of the interval between
retransmissions of the Neighbor Solicitation (NS), providing a longer
interval over which the neighbor can respond.
retrans-max max Sets the maximum number of neighbor solicitations to be sent during
ND and NUD. The range is from 1 to 10 with a default value of 3. This
allows the number of neighbor solicitations sent for neighbor discovery
to be increased.

page 17-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 interface

Defaults

parameter default
ra-send yes
ra-max-interval 600
ra-managed-config-flag false
ra-reachable-time 0
ra-retrans-timer 0
ra-default-lifetime calculated
ra-min-interval calculated
ra-send-mtu no
ra-clock-skew 600
base-reachable-time 360
retrans-timer 1000
dad-transmits 1
ra-other-config-flag false
ra-hop-limit 64
local-proxy-nd no
neighbor-limit no
retrans-backoff 1
retrans-max 3

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete an interface.

• When you create an IPv6 interface, it is enabled by default.

• All IPv6 VLAN and tunnel interfaces must have a name.

• When creating an IPv6 interface you must specify a VLAN ID or Tunnel ID. When modifying or
deleting an interface, you do not need to specify one of these options unless the name assigned to the
interface is being changed. If it is present with a different value from when the interface was created,
the command will be in error.
• A default 6to4 tunnel named “tunnel_6to4” is automatically created. It can only be enabled/disabled or
it configuration modified, it cannot be deleted.
• A 6to4 interface cannot send advertisements (ra-send).

• To enable IPv6 routing you must first create a VLAN, then create an IPv6 interface on the VLAN. See
Chapter 5, “VLAN Management Commands,” for information on creating VLANs.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-5
ipv6 interface IPv6 Commands

• To route IPv6 traffic over an IPv4 network, you must create an IPv6 tunnel using the ipv6 interface
command.
• Use the no option to disable the Local Proxy Neighbor Discovery on the interface.

Examples
-> ipv6 interface Test vlan 1
-> ipv6 interface Test_Tunnel tunnel 2

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 interface Displays IPv6 Interface Table.

show ipv6 tunnel configured Displays IPv6 Configured Tunnel.
show ipv6 tunnel 6to4 Displays IPv6 6to4 tunnel information.
show ipv6 information Displays IPv6 information.

MIB Objects
IPv6Ifindex
alaIPv6InterfaceTable
alaIPv6InterfaceName
alaIPv6InterfaceMtu
alaIPv6InterfaceSendRouterAdvertisements
alaIPv6InterfaceMaxRtrAdvInterval
alaIPv6InterfaceAdvManagedFlag
alaIPv6InterfaceAdvOtherConfigFlag
alaIPv6InterfaceAdvRetransTimer
alaIPv6InterfaceAdvDefaultLifetime
alaIPv6InterfaceAdminStatus
alaIPv6InterfaceAdvReachableTime
alaIPv6InterfaceBaseReachableTime
alaIPv6InterfaceAdvSendMtu
alaIPv6InterfaceRowStatus
alaIPv6InterfaceLPND
alaIPv6InterfaceNeighborLimit
alaIPv6InterfaceRetransBackoff
alaIPv6InterfaceRetransMax

page 17-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 interface tunnel source destination

ipv6 interface tunnel source destination

Configures the source and destination IPv4 addresses for a configured tunnel.
ipv6 interface if_name tunnel {[source ipv4_source] [destination ipv4_destination]}

Syntax Definitions

if_name Name assigned to the tunnel interface.

ipv4_source Source IPv4 address for the configured tunnel.
ipv4_destination Destination IPv4 address for the configured tunnel.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the ipv6 interface command to create an IPv6 tunnel interface.

• A configured tunnel interface cannot be enabled until both its v4 source and destination addresses have
been specified.

Examples
-> ipv6 interface Test tunnel 2 source 192.0.2.1 destination 198.51.100.1

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 interface Creates an IPv6 tunnel interface.

show ipv6 tunnel configured Displays IPv6 tunnel information.

MIB Objects
IPv6IfIndex
alaIPv6ConfigTunnelv4Source
alaIPv6ConfigTunnelv4Dest
alaIPv6ConfigTunnelRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-7
ipv6 address IPv6 Commands

ipv6 address
Configures an IPv6 address for an IPv6 interface on a VLAN, configured tunnel, or a 6to4 tunnel. There
are different formats for this command depending on the address type.
ipv6 address ipv6_address /prefix_length [anycast] {if_name | loopback}
no ipv6 address ipv6_address [anycast] {if_name | loopback}
ipv6 address ipv6_prefix eui-64 {if_name | loopback}
no ipv6 address ipv6_prefix eui-64 {if_name | loopback}

Syntax Definitions

ipv6_address IPv6 address.

prefix_length The number of bits that are significant in the IPv6 address (mask).
(3..128).
anycast Indicates the address is an anycast address.
eui-64 Append an EUI-64 identifier to the prefix.
if_name Name assigned to the interface.
loopback Configures the loopback interface.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete an address.

• You can assign multiple IPv6 addresses to an IPv6 interface.

• No default value for prefix length.

• The “eui” form of the command is used to add or remove an IPv6 address for a VLAN or configured
tunnel using an EUI-64 interface ID in the low order 64 bits of the address.

page 17-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 address

Examples
-> ipv6 address 2001:DB8:4132:86::19A/64 Test_Lab
-> ipv6 address 2002:C633:6489::35/64 Test_6to4

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 interface Displays IPv6 Interface Table.

MIB Objects
IPv6IfIndex
alaIPv6InterfaceAddressTable
alaIPv6InterfaceAddress
alaIPv6InterfaceAddressAnycastFlag
alaIPv6InterfaceEUI64AddressPrefixLength
alaIPv6InterfaceEUI64AddressrowStatus

For EUI-64 Addresses:

alaIPv6InterfaceEUI64AddresssTable
alaIPv6InterfaceEUI64Address
alaIPv6InterfaceEUI64AddressPrefixLength
alaIPv6InterfaceEUI64AddressRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-9
ipv6 address global-id IPv6 Commands

ipv6 address global-id

Automatically generates or allows a new global ID to be entered.
ipv6 address global-id {generate | globalID}

Syntax Definitions

generate Automatically generates the global ID.

globalID A 5-byte global ID value specified in the form hh:hhhh:hhhh.

Defaults
By default, the IPv6 global ID is set to all zeros.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Global ID needs to be automatically generated or configured explicitly.

• A 40-bit global identifier is used to make the local IPv6 address prefixes globally unique.

• The global ID will be generated the first time a local unicast address is added through the ipv6 address
local-unicast command or when the ipv6 address global-id command is executed.

Examples
-> ipv6 address global-id generate
-> ipv6 address global-id 32:57a3:8fed

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 address local- Creates a IPv6 local unicast address using the configured global ID.
unicast
ipv6 bgp unicast Enables or disables unicast IPv6 updates for the BGP routing process.
show ip bgp Displays the current global settings for the local BGP speaker.

MIB Objects
alaIPv6GlobalID

page 17-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 address local-unicast

ipv6 address local-unicast

Creates a IPv6 local unicast address using the configured global ID.
ipv6 address local-unicast [global-id globalID] [subnet-id subnetID] {interface-id interfaceID | eui-64}
[prefix-length prefixLength] {if-name | loopback}
[no] ipv6 address local-unicast [global-id globalID] [subnet-id subnetID] {interface-id interfaceID |
eui-64} [prefix-length prefixLength] {if-name | loopback}

Syntax Definitions

globalID A 5-byte global ID value specified in the form hh:hhhh:hhhh.

subnetID A 2-byte Subnet ID specified in the form 0xhhhh. The valid range is
0x0000-0xffff or 0-65535.
interfaceID An interface identifier specified in the form hhhh:hhhh:hhhh:hhhh.
eui-64 Automatically-generated EUI-64 value to be used for interface identfier.
prefixLength The number of bits that are significant in the IPv6 address (mask). The
valid range is 0-128; however, the default value should rarely be
overridden.
if-name The name assigned to the interface.
loopback The loopback for the loopback interface.

Defaults

parameter default
prefixLength 64

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the local unicast address. However, addresses are normally
deleted using the ipv6 address command.
• If the global ID value is not explicitly specified, the default global ID set by the ipv6 address global-
id command is used.
• If the global ID value is explicitly configured using the ipv6 address local-unicast command, the
address’ global ID will not be changed if the ipv6 address global-id command is executed.
• The use of a double-colon abbreviation for the interface identifier similar to that used for full IPv6
addresses is allowed.

Examples
-> ipv6 address local-unicast global-id 0073:110:255 subnet-id 23 interface-id
215:60ff:fe7a:adc0 prefix-length 64 loopback

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-11
ipv6 address local-unicast IPv6 Commands

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 address global-id Automatically generates or allows a new global ID to be entered.

show ipv6 information Displays IPv6 information.

MIB Objects
alaIPv6LocalUnicastGlobalID
alaIPv6LocalUnicastSubnetID
alaIPv6LocalUnicastInterfaceID
alaIPv6LocalUnicastEUI64
alaIPv6LocalUnicastPrefixLength

page 17-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 dad-check

ipv6 dad-check
Runs a Duplicate Address Detection (DAD) check on an address that was marked as duplicated.
ipv6 dad-check ipv6_address if_name

Syntax Definitions

ipv6_address IPv6 address.

ip_name Name assigned to the interface.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The switch performs DAD check when an interface is attached and its VLAN first enters the active state.
Use this command to rerun a DAD check on an address that was marked as duplicated.

Examples
-> ipv6 dad-check 2001:db8::1/32 Test_Lab

Release History
Release 8.1.1; command introduced.

Related Commands
N/A

MIB Objects
alaIPv6InterfaceAddressTable
alaIPv6InterfaceAddressDADStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-13
ipv6 hop-limit IPv6 Commands

ipv6 hop-limit
Configures the value placed in the hop limit field in the header of all IPv6 packets that are originated by
the switch. It also configures the value placed in the hop limit field in router advertisements.
ipv6 hop-limit value
no ipv6 hop-limit

Syntax Definitions

value Hop limit value. The range is 0 - 255.

Defaults

parameter default
value 64

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to return the hop limit to its default value.

• Inputting the value 0 (zero) will result in the default (64) hop-limit.

Examples
-> ipv6 hop-limit 64

Release History
Release 8.1.1; command introduced.

Related Commands
show ipv6 information Displays IPv6 information.

MIB Objects
ipv6MibObjects
Ipv6DefaultHopLimit

page 17-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 pmtu-lifetime

ipv6 pmtu-lifetime
Configures the minimum lifetime for entries in the path MTU Table.
ipv6 pmtu-lifetime time

Syntax Definitions

time Minimum path MTU entry lifetime, in minutes. Valid range is 10–1440.

Defaults

parameter default
time 10

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ipv6 pmtu-lifetime 30

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 ra-filter Displays the IPv6 path MTU Table.

show ipv6 information Displays IPv6 information.

MIB Objects
alaIPv6ConfigTable
alaIPv6PMTUMinLifetime

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-15
ipv6 neighbor stale-lifetime IPv6 Commands

ipv6 neighbor stale-lifetime

Configures the minimum lifetime for neighbors in the unconfirmed state.
ipv6 neighbor stale-lifetime stale-lifetime

Syntax Definitions

stale-lifetime Minimum lifetime for neighbor entries in the stale state (5–2800).

Defaults

parameter default
stale-lifetime 10

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ipv6 neighbor stale-lifetime 1400

Release History
Release 8.1.1; command introduced.

Related Commands
show ipv6 neighbors Displays IPv6 Neighbor Table.
show ipv6 information Displays IPv6 information.

MIB Objects
IPv6IfIndex
alaIPv6NeighborTable
alaIPv6NeighborStaleLifetime

page 17-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 neighbor

ipv6 neighbor
Configures a static entry in IPv6 Neighbor Table.
ipv6 neighbor ipv6_address hardware_address {if_name} {port chassis/slot/port | linkagg add_num}
no ipv6 neighbor ipv6_address {if_name}

Syntax Definitions

ipv6_address IPv6 address that corresponds to the hardware address.

hardware_address MAC address in hex format (e.g., 00:00:39:59:F1:0C).
if_name Name assigned to the interface on which the neighbor resides.
chassis/slot/port The chassis ID, slot, and port number (3/1/1) for a specific port.
agg_num A link aggregate ID number.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to remove an entry from IPv6 Neighbor Table.

Examples
-> ipv6 neighbor 4132:86::203 00:d0:c0:86:12:07 Test port 1/1/1

Release History
Release 8.1.1; command introduced.

Related Commands
show ipv6 neighbors Displays IPv6 Neighbor Table.

MIB Objects
IPv6IfIndex
alaIPv6NeighborTable
alaIPv6NeighborNetAddress
alaIPv6NeighborPhysAddress
alaIPv6NeighborSlot
alaIPv6NeighborPort
alaIPv6NeighborRowStatus
alaIPv6NeighborStaleLifetime

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-17
ipv6 neighbor limit IPv6 Commands

ipv6 neighbor limit

Configures the system-wide maximum limit for the number of neighbor entries in the cache.
ipv6 neighbor limit count
no ipv6 neighbor limit

Syntax Definitions

count The system-wide maximum limit for the number of neighbor entries in
the cache. The valid range is from 200 to no limit. The default value is
none.

Defaults
The default value is none.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to remove the cache limit.

Examples
-> ipv6 neighbor limit 200

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 interface Creates an IPv6 tunnel interface.

show ipv6 information Displays IPv6 information.

MIB Objects
alaIPv6NeighborTable
alaIPv6NeighborLimit

page 17-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 neighbor vrf-limit

ipv6 neighbor vrf-limit

Configures the maximum limit for the number of neighbor entries in a VRF's cache.
ipv6 neighbor vrf-limit count
no ipv6 neighbor vrf-limit

Syntax Definitions

count The maximum limit for the number of VRF neighbor entries in the
cache. The valid range is from 200 to no limit.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to remove the cache limit.

Examples
-> ipv6 neighbor vrf-limit 200

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 interface Creates an IPv6 tunnel interface.

show ipv6 information Displays IPv6 information.

MIB Objects
alaIPv6NeighborTable
alaIPv6NeighborVRFLimit

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-19
ipv6 ra-filter IPv6 Commands

ipv6 ra-filter
Configures the Router Advertisement (RA) filtering on IPv6 VLAN interfaces. When RA filtering is
enabled on an interface, RAs received on any port or linkagg will be discarded. If one or more trusted
ports or linkaggs are configured, RAs received on them will be accepted and sent on to any connected
IPv6 nodes.
ipv6 ra-filter if-name [trusted-port {chassis/slot/port | linkagg agg_num}]
no ipv6 ra-filter if-name [trusted-port {chassis/slot/port | linkagg agg_num}]

Syntax Definitions

if-name Specify the name of the interface on which RA filtering is being

configured.
chassis/slot/port The chassis ID, slot, and port number (3/1/1) for a trusted port.
agg_num A trusted link aggregate ID number.

Defaults
By default all ports and linkaggs are untrusted.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to remove a trusted port or linkagg.

Examples
-> ipv6 ra-filter vlan-23
-> ipv6 ra-filter vlan-23 trusted-port 1/1/22

The following command returns port 1/1/22 to the untrusted state:

-> no ipv6 ra-filter vlan-23 trusted-port 1/1/22

The following command disables RA filtering on the IPv6 interface “vlan-23”:

-> no ipv6 ra-filter vlan-23

Release History
Release 8.1.1; command introduced.

page 17-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 ra-filter

Related Commands

ipv6 interface Creates an IPv6 tunnel interface.

show ipv6 information Displays IPv6 information.
show ipv6 interface Displays IPv6 Interface Table.
show ipv6 ra-filter Displays the RA filter configuration for an IPv6 interface.

MIB Objects
IPv6IfIndex
alaIPv6InterfaceRAFilter
alaIPv6RAFilterTrustedChassis
alaIPv6RAFilterTrustedSlot
alaIPv6RAFilterTrustedPort
alaIPv6RAFilterTrustedRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-21
ipv6 prefix IPv6 Commands

ipv6 prefix
Configures an IPv6 prefix on an interface. Used for configuring prefixes for router advertisements.
ipv6 prefix ipv6_address /prefix_length if_name
[valid-lifetime time]
[preferred-lifetime time]
[on-link-flag {true | false}
[autonomous-flag {true | false}] if_name
no ipv6 prefix ipv6_address /prefix_length if_name

Syntax Definitions

ipv6_address IPv6 address of the interface.

prefix_length The number of bits that are significant in the IPv6 address (mask).
(1...127).
valid-lifetime time Length of time, in seconds, that this prefix will remain valid, i.e. time
until deprecation. A value of 4,294,967,295 represents infinity.
preferred-lifetime time Length of time, in seconds, that this prefix will remain preferred, i.e.
time until deprecation. A value of 4,294,967,295 represents infinity.
on-link-flag On-link configuration flag. When “true” this prefix can be used for on-
link determination.
autonomous-flag Autonomous address configuration flag. When “true”, indicates that this
prefix can be used for autonomous address configuration (i.e., can be
used to form a local interface address).
if_name Name assigned to the interface.

Defaults

parameter default
valid-lifetime time 2,592,000
preferred-lifetime time 604,800
on-link-flag true
autonomous-flag true

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to delete a prefix.

Examples
-> ipv6 prefix 4132:86::/64 Test

page 17-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 prefix

Release History
Release 8.1.1; command introduced.

Related Commands
show ipv6 prefixes Displays IPv6 prefixes used in router advertisements.

MIB Objects
IPv6IfIndex
alaIPv6InterfacePrefixTable
alaIP6vInterfacePrefix
alaIP6vInterfacePrefixLength
alaIP6vInterfacePrefixValidLifetime
alaIP6vInterfacePrefixPreferredLifetime
alaIP6vInterfacePrefixonLinkFlag
alaIP6vInterfacePrefixAutonomousFlag
alaIP6vInterfacePrefixRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-23
ipv6 static-route IPv6 Commands

ipv6 static-route
Creates/deletes an IPv6 static route. Static routes are user-defined; they carry a higher priority than routes
created by dynamic routing protocols. That is, static routes always have priority over dynamic routes,
regardless of the metric value.
ipv6 static-route ipv6_prefix/prefix_length gateway ipv6_address [if_name] [metric metric]
no ipv6 static-route ipv6_prefix/prefix_length gateway ipv6_address [if_name]

Syntax Definitions

ipv6_prefix IPv6 network that is the destination of this static route.

prefix_length The number of bits (0...128) that are significant in the iPv6 address
(mask).
gateway ipv6_address IPv6 address of the next hop used to reach the destination IPv6 address.
if_name If the next hop is a link-local address, the name of the interface used to
reach it.
metric Metric or cost (hop count) for the static route. You can set a priority for
the static route by assigning a metric value. The lower the metric value,
the higher the priority. Valid range is 1–15.

Defaults

parameter default
metric 1

Platforms Supported

OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to remove a static route.

Examples
-> ipv6 static-route 212:95:5::/64 gateway fe80::2d0:95ff:fe6a:f458 v6if-137 metric 3

Release History
Release 8.1.1; command introduced.

page 17-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 static-route

Related Commands
show ipv6 routes Displays IPv6 Forwarding Table.
show ipv6 router database Displays a list of all routes (static and dynamic) that exist in the
IPv6 router database.

MIB Objects
alaIprmv6StaticRouteTable
alaIprmv6StaticRouteDest
alaIprmv6StaticRoutePrefixLength
alaIprmv6StaticRouteNextHop
alaIprmv6StaticRouteIfIndex
alaIprmv6StaticRouteMetric
alaIprmv6StaticRouteRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-25
ipv6 route-pref IPv6 Commands

ipv6 route-pref
Configures the route preference of a router.
ipv6 route-pref {static | ospf | rip | ebgp | ibgp} value

Syntax Definitions

static Configures the route preference of static routes.

ospf Configures the route preference of OSPF3 routes.
rip Configures the route preference of RIPng routes.
ebgp Configures the route preference of external BGP routes.
ibgp Configures the route preference of internal BGP routes.
value Route preference value.

Defaults

parameter default
static value 2
ospf value 110
rip value 120
ebgp value 190
ibgp value 200

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Route preference of local routes cannot be changed.

• The valid route preference range is 1–255.

• The IPv6 version of BGP is not supported in the current release.

Examples
-> ipv6 route-pref ospf 20
-> ipv6 route-pref rip 60

Release History
Release 8.1.1; command introduced.

page 17-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 route-pref

Related Commands

show ipv6 route-pref Displays the configured route preference of a router.

MIB Objects
alaIprmRtPrefTable
alaIprmRtPrefLocal
alaIprmRtPrefStatic
alaIprmRtPrefOspf
alaIprmRtPrefRip
alaIprmRtPrefEbgp
alaIprmRtPrefIbgp

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-27
ipv6 virtual-source-mac IPv6 Commands

ipv6 virtual-source-mac
Configures the source MAC to be used for packets being sent from a VRRP instance.
ipv6 virtual-source-mac {on | off }

Syntax Definitions

on The switch will use the VRRP virtual MAC address for all packets.
off The switch will use the physical MAC address for all packets except
VRRP advertisements.

Defaults

parameter default
virtual-source-mac off

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use this command to change which MAC address the switch will use as the source MAC when send-
ing packets from a VRRP instance.
• This command has no affect on VRRP advertisements, the VRRP virtual MAC will always be used.

Examples
-> ipv6 virtual-source-mac on
-> ipv6 virtual-source-mac off

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 route-pref Displays the configured route preference of a router.

MIB Objects
N/A

page 17-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ping6

ping6
Tests whether an IPv6 destination can be reached from the local switch. This command sends an ICMPv6
echo request to a destination and then waits for a reply. To ping a destination, enter the ping6 command
and enter either the destination’s IPv6 address or hostname. The switch will ping the destination using the
default frame count, packet size, and interval (6 frames, 64 bytes, and 1 second respectively). You can also
customize any or all of these parameters as described below.
ping6 {ipv6_address | hostname} [if_name] [count count] [size data_size] [interval seconds]

Syntax Definitions

ipv6_prefix IP address of the system to ping.

hostname DNS name of the system to ping.
if_name If the target is a link-local address, the name of the interface used to
reach it.
count Number of packets to be transmitted.
size Size of the data portion of the packet sent for this ping, in bytes.
seconds Interval, in seconds, at which ping packets are transmitted.

Defaults

parameter default
count 6
size 8
interval seconds 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If you change the default values, they will only apply to the current ping. The next time you use the
ping command, the default values will be used unless you again enter different values.
• When the next hop address is a local link address, the name of the interface used to reach the
destination must be specified.

Examples
-> ping6 2001:db8:302::44
-> ping6 fe80::2d0:95ff:fe6a:f458 vlanif-23

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-29
ping6 IPv6 Commands

Related Commands
traceroute6 Finds the path taken by an IPv6 packet from the local switch to a
specified destination.

MIB Objects
N/A

page 17-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands traceroute6

traceroute6
Finds the path taken by an IPv6 packet from the local switch to a specified destination. This command
displays the individual hops to the destination as well as some timing information.
traceroute6 {ipv6_address | hostname} [if_name] [max-hop hop_count] [dest-port port_number]
[probe-count probe] [size size] [host-names {yes|no}]

Syntax Definitions

ipv6_address Destination IPv6 address. IPv6 address of the host whose route you
want to trace.
hostname DNS name of the host whose route you want to trace.
if_name If the target is a link-local address, the name of the interface used to
reach it.
hop_count Maximum hop count for the trace.
port Specific UDP port destination. By default, the destination port is chosen
by traceroute6.
size The initial size for the probe packets. During the trace the packet size
will be adjusted downward as path MTU information is received. The
default and maximum value is 24,000 bytes with a minimum of 1,280
bytes.
host-names Specify whether each hop should be shown as an IPv6 address or the
host name corresponding to the address.
probe Number of probes to be sent to a single hop.

Defaults

parameter default
hop_count 32
probe 3
host-names no

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When using this command, you must enter the name of the destination as part of the command line
(either the IPv6 address or hostname).
• Use the optional max-hop parameter to set a maximum hop count to the destination. If the trace
reaches this maximum hop count without reaching the destination, the trace stops.

Examples
-> traceroute6 41EA:103::65C3

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-31
traceroute6 IPv6 Commands

Release History
Release 8.1.1; command introduced.

Related Commands
ipv6 virtual-source-mac Tests whether an IPv6 destination can be reached from the local
switch.

MIB Objects
N/A

page 17-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 icmp statistics

show ipv6 icmp statistics

Displays IPv6 ICMP statistics.
show ipv6 icmp statistics [if_name]

Syntax Definitions

if_name Destination IPv6 address. IPv6 address of the host whose route you
want to trace.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the ICMP table to monitor and troubleshoot the switch.

Examples
-> show ipv6 icmp statistics
Message Current Previous Change
------------------------------+----------+----------+----------
Received Total 857 0 857
Errors 0 0 0
Destination Unreachable 0 0 0
Packet Too Big 0 0 0
Time Exceeded 0 0 0
Parameter Problems 0 0 0
Echo Requests 0 0 0
Echo Replies 0 0 0
Group Membership Queries 0 0 0
Group Membership Responses 0 0 0
Group Membership Reductions 0 0 0
Router Solicitations 9 0 9
Router Advertisements 847 0 847
Neighbor Solicitations 1 0 1
Neighbor Advertisements 0 0 0
Redirects 0 0 0
Administratively Prohibited 0 0 0
Sent Total 18 0 18
Errors 0 0 0
Destination Unreachable 0 0 0
Packet Too Big 0 0 0
Time Exceeded 0 0 0
Parameter Problems 0 0 0
Echo Requests 0 0 0
Echo Replies 0 0 0
Group Membership Queries 0 0 0
Group Membership Responses 11 0 11

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-33
show ipv6 icmp statistics IPv6 Commands

Group Membership Reductions 0 0 0

Router Solicitations 3 0 3
Router Advertisements 0 0 0
Neighbor Solicitations 4 0 4
Neighbor Advertisements 0 0 0
Redirects 0 0 0
Administratively Prohibited 0 0 0

output definitions
Total Total number of ICMPv6 messages the switch received or attempted
to send.
Errors Number of ICMPv6 messages the switch sent or received but was
unable to process because of ICMPv6-specific errors (bad checksums,
bad length, etc.).
Destination Unreachable Number of Destination Unreachable messages that were sent or
received by the switch.
Packet Too Big Number of Packet Too Big messages sent or received by the switch.
Administratively Prohibited Number of Destination Unreachable/Communication
Administratively Prohibited messages sent or received by the switch.
Time Exceeded Number of Time Exceeded messages sent or received by the switch.
Parameter Problems Number of Parameter Problem messages sent or received by the
switch.
Echo Requests Number of Echo Request messages sent or received by the switch.
Echo Replies Number of Echo Reply messages sent or received by the switch.
Group Membership Queries Number of Group Membership Queries sent or received by the switch.
Group Membership Responses Number of Group Membership Responses sent or received by the
switch.
Group Membership Reductions Number of Group Membership Reductions sent or received by the
switch.
Router Solicitations Number of Router Solicitations sent or received by the switch.
Router Advertisements Number of Router Advertisements sent or received by the switch.
Neighbor Solicitations Number of Neighbor Solicitations sent or received by the switch.
Neighbor Advertisements Number of Neighbor Advertisements sent or received by the switch.
Redirects Number of Redirect messages sent or received by the switch.

Release History
Release 8.1.1; command introduced.

Related Commands
show ipv6 traffic Displays IPv6 traffic statistics.

page 17-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 icmp statistics

MIB Objects
ipv6IfIcmpTable
ipv6IfIcmpInMsgs
ipv6IfIcmpInErrors
ipv6IfIcmpInDestUnreachs
ipv6IfIcmpInAdminProhibs
ipv6IfIcmpInTimeExcds
ipv6IfIcmpInParmProblems
ipv6IfIcmpInPktTooBigs
ipv6IfIcmpInEchos
ipv6IfIcmpInEchoReplies
ipv6IfIcmpInRouterSolicits
ipv6IfIcmpInRouterAdvertisements
ipv6IfIcmpInNeighborSolicits
ipv6IfIcmpInNeighborAdvertisements
ipv6IfIcmpInRedirects
ipv6IfIcmpInGroupMembQueries
ipv6IfIcmpInGroupMembResponses
ipv6IfIcmpInGroupMembReductions
ipv6IfIcmpOutMsgs
ipv6IfIcmpOutErrors
ipv6IfIcmpOutDestUnreachs
ipv6IfIcmpOutAdminProhibs
ipv6IfIcmpOutTimeExcds
ipv6IfIcmpOutParmProblems
ipv6IfIcmpOutPktTooBigs
ipv6IfIcmpOutEchos
ipv6IfIcmpOutEchoReplies
ipv6IfIcmpOutRouterSolicits
ipv6IfIcmpOutRouterAdvertisements
ipv6IfIcmpOutNeighborSolicits
ipv6IfIcmpOutNeighborAdvertisements
ipv6IfIcmpOutRedirects
ipv6IfIcmpOutGroupMembQueries
ipv6IfIcmpOutGroupMembResponses
ipv6IfIcmpOutGroupMembReductions

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-35
show ipv6 interface IPv6 Commands

show ipv6 interface

Displays IPv6 Interface Table.
show ipv6 interface [if_name | loopback]

Syntax Definitions

if_name Interface name. Limits the display to a specific interface.

loopback Limits display to loopback interfaces.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If you do not specify an interface name, all IPv6 interfaces are displayed.

• Specify an interface name (e.g., VLAN 12) to obtain a more detailed information about a specific
interface.

Examples
-> show ipv6 interface

Name IPv6 Address/Prefix Length Status Device

--------------------+----------------------------------------+---------+--------
smbif-5 fe80::2d0:95ff:fe12:f470/64 Active VLAN 955
212:95:5::35/64
212:95:5::/64
v6if-to-eagle fe80::2d0:95ff:fe12:f470/64 Disabled VLAN 1002
195:35::35/64
195:35::/64
tunnel_6to4 2002:d423:2323::35/64 Active 6to4 Tunnel
2002:d423:2323::/64
v6if-tunnel-137 fe80::2d0:95ff:fe12:f470/64 Disabled Tunnel 2
137:35:35::35/64
137:35:35::/64 Active loopback
loopback ::1/128 Active Loopback

output definitions
Name Interface name. This is usually the VLAN on which the interface is
configured.
IPv6 Address/Prefix Length IPv6 address and prefix length assigned to the interface. If an interface
has more than one IPv6 address assigned to it, each address is shown on
a separate line.
Status Interface status (e.g., Active/Inactive).
Device The device on which the interface is configured (e.g., VLAN 955).

page 17-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 interface

-> show ipv6 interface tunnel_6to4

tunnel_6to4
IPv6 interface index = 16777216(0x
Administrative status = Disabled
Operational status = Inactive
Link-local address(es):
Global unicast address(es):
Anycast address(es):
VRRP address(es):
Joined group addresses:
ff02::1
Maximum Transfer Unit (MTU) = 1280
Neighbor reachable time (sec) = 465
Base reachable time (sec) = 360
Retransmit timer (ms) = 1000
Retransmit backoff = 1
Retransmit max = 3
DAD transmits = 1
Send Router Advertisements = No
Maximum RA interval (sec) = 600
Minimum RA interval (sec) = 198
RA managed config flag = False
RA other config flag = False
RA reachable time (ms) = 0
RA retransmit timer (ms) = 0
RA default lifetime (sec) = 1800
RA hop limit = 64
RA send MTU option = No
RA clock skew (sec) = 600
RA filtering = Disabled
Neighbor cache limit = 100
Local Proxy ND = Disabled

output definitions
IPv6 interface index IPv6IfIndex value that should be used in SNMP requests pertaining to
this interface.
Administrative status Administrative status of this interface (Enabled/Disabled).
Operational status Indicates whether the physical interface is connected to a device
(Active/Inactive).
Link-local address Link-local address assigned to the interface.
Global unicast address(es) Global unicast address(es) assigned to the interface.
Anycast address(es) The anycast addresses assigned to the interface.
VRRP address(es) Addresses assigned to the interface because a VRRP virtual router is
active. If (accept) is present, the switch will accept packets destined to
the address. If not present, any such packets will be discarded.
Joined group address(es) Addresses of the multicast groups that this interface has joined.
Maximum Transfer Unit Interface MTU value.
Neighbor reachable time (sec) The amount of time that a neighbor reached through this interface will
remain in the reachable state.
Base reachable time (sec) The base reachable time used to calculate the current neighbor
reachable time.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-37
show ipv6 interface IPv6 Commands

output definitions (continued)

Retransmit timer (ms) The interval at which neighbor solicitations will be retransmitted
during the neighbor discovery process.
Retransmit backoff The NUD exponential backoff base value.
Retransmit max The maximum number of neighbor solicitations to be sent during ND/
NUD.
DAD transmits The number of neighbor solicitations that will be sent as part of the
Duplicate Address Detection process.
Send Router Advertisements Indicates if the router sends periodic router advertisements and
responds to router solicitations on the interface.
Maximum RA interval (sec) Maximum time between the transmission of unsolicited router
advertisements over the interface.
Minimum RA interval (sec) Minimum time between the transmission of unsolicited router
advertisements over the interface (0.33 * Maximum RA Interval).
RA managed config flag True/False value in the managed address configuration flag field in
router advertisements.
RA other config flag The True/False value in the other stateful configuration flag field in
router advertisements sent over this interface.
RA reachable time (ms) Value placed in the reachable time field in the router advertisements
sent over this interface.
RA retransmit timer (ms) Value placed in the retransmit timer field in router advertisements sent
over this interface.
RA default lifetime (sec) The value placed in the router lifetime field in the router advertisements
sent over this interface.
RA hop limit The value placed in the current hop limit field in the router
advertisements sent over this interface.
RA Send MTU option Specifies whether the MTU option is included in the router
advertisements sent over this interface.
RA clock skew (sec) The clock skew allowed for router advertisements on this interface.
RA filtering Specifies if RA filtering is enabled or disabled on the interface.
Neighbor cache limit The interface's neighbor cache limit. “none” if value not set.
Local Proxy ND Specifies if Local Proxy Neighbor Discovery is enabled or disabled on
the interface.

Release History
Release 8.1.1; command introduced.

page 17-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 interface

Related Commands
ipv6 address Configures an IPv6 address on a VLAN, configured tunnel, or a
6to4 tunnel.
ipv6 interface Configures an IPv6 interface on a VLAN.
ipv6 interface tunnel source Configures the Router Advertisement (RA) filtering on IPv6
destination VLAN interfaces. When RA filtering is enabled, by default it is
enabled on all the ports and linkaggs and any RAs received on
them will be discarded. The command also allows to configure the
trusted ports and linkaggs to receive RAs.

MIB Objects
ipv6InterfaceTable
ipv6AdminStatus
ipv6IfOperStatus
ipv6PhysicalAddress
ipv6InterfaceAddress
ipv6AddrAddress
ipv6AddrAddressPfxLength
ipv6Address
ipv6AddressPrefix
alaIPv6InterfaceTable
alaIPv6InterfaceName
alaIPv6InterfaceAddress
alaIPv6InterfaceAddressPrefixLength
alaIPv6InterfaceAddressVRRPFlag
alaIPv6MulticastGroupAddress
alaIPv6InterfaceMtu
alaIPv6InterfaceReachableTime
alaIPv6InterfaceBaseReachableTime
alaIPv6InterfaceRetransTimer
alaIPv6InterfaceRetransBackoff
alaIPv6InterfaceRetransMax
alaIPv6InterfaceDADTransmits
alaIPv6InterfaceSendRouterAdvertisements
alaIPv6InterfaceMaxRtrAdvInterval
alaIPv6InterfaceMinRtrAdvInterval
alaIPv6InterfaceAdvManagedFlag
alaIPv6InterfaceAdvOtherConfigFlag
alaIPv6InterfaceAdvReachableTime
alaIPv6InterfaceAdvRetransTimer
alaIPv6InterfaceClockSkew
alaIPv6InterfaceAdvHopLimit
alaIPv6InterfaceAdvSendMtu
alaIPv6InterfaceAdvDefaultLifetime
alaIPv6InterfaceRAFilter
alaIPv6InterfaceNeighborLimit

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-39
show ipv6 ra-filter IPv6 Commands

show ipv6 ra-filter

Displays the RA filter configuration for an IPv6 interface.
show ipv6 ra-filter if-name

Syntax Definitions

if_name IPV6 interface name.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 ra-filter vlan-23

RA Filtering: Enabled
Trusted ports:
1/1/22
linkagg 7

output definitions
RA Filtering Indicates if RA filtering is enabled or disabled on the interface.
Trusted ports Shows the RA filtering trusted ports on the interface. “none” will be
displayed if there are no trusted ports.
Ports are displayed as chassis/slot/port (chassis will only be present
when running in a virtual chassis configuration). Linkaggs are
displayed as linkagg id.

Release History
Release 8.1.1; command introduced.

page 17-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 ra-filter

Related Commands

ipv6 interface tunnel source Configures the Router Advertisement (RA) filtering on IPv6 VLAN
destination interfaces. When RA filtering is enabled, by default it is enabled on
all the ports and linkaggs and any RAs received on them will be
discarded. The command also allows to configure the trusted ports
and linkaggs to receive RAs.

MIB Objects
IPv6IfIndex
alaIPv6RAFilterTrustedChassis
alaIPv6RAFilterTrustedSlot
alaIPv6RAFilterTrustedPort

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-41
show ipv6 pmtu table IPv6 Commands

show ipv6 pmtu table

Displays the IPv6 Path MTU Table.
show ipv6 pmtu table

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 pmtu table

1-PMTU Entry
PMTU entry minimum lifetime = 10m
Destination Address MTU Expires
--------------------------------------------------------+--------+-------
fe80::02d0:c0ff:fe86:1207 1280 1h 0m

output definitions
Destination Address IPv6 address of the path's destination.
MTU Path’s MTU.
Expires Minimum remaining lifetime for the entry.

Release History
Release 8.1.1; command introduced.

page 17-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 pmtu table

Related Commands

ipv6 pmtu-lifetime Configures the minimum lifetime for entries in the path MTU
Table.

MIB Objects
alaIPv6ConfigTable
alaIPv6PMTUDest
alaIPv6PMTUexpire

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-43
show ipv6 neighbors IPv6 Commands

show ipv6 neighbors

Displays IPv6 Neighbor Table.
show ipv6 neighbors [ipv6_prefix/prefix_length | if_name | hw hardware_address | static]

Syntax Definitions

ipv6_prefix/prefix_length IPv6 prefix. Restricts the display to those neighbors starting with the
specified prefix.
if_name Interface name. Restricts the display to those neighbors reached through
the specified interface.
hardware_address MAC address. Restricts the display to the specified MAC address.
static Restricts display to statically configured neighbors.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If you do not specify an option (e.g., if_name), all IPv6 neighbors are displayed.

Examples
-> show ipv6 neighbors
Total 2 neighbors

IPv6 Address Hardware Address Reachability Lifetime Port Interface

-----------------+-----------------+------------+-----------+-------+-------------
2001:db8:39::11 0a:3f:1e:ac:7b:38 Unconfirmed 39s 1/1/ 1 vlan-41
fe80::83f:1eff:feac:7b38 0a:3f:1e:ac:7b:38 Confirmed 8m 21s 1/1/ 1 vlan-41

output definitions
IPv6 Address The neighbor’s IPv6 address.
Hardware Address The MAC address corresponding to the IPv6 address.
Reachability The neighbor’s reachability:
• Incomplete
• Confirmed
• Unconfirmed
Lifetime The time the entry will remain in its current state.
Port The port used to reach the neighbor.
Interface The neighbor’s interface name (e.g., vlan_1)

page 17-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 neighbors

Release History
Release 8.1.1; command introduced.

Related Commands
ipv6 neighbor Configures a static entry in the IPv6 Neighbor Table.

MIB Objects
ipv6IfIndex
alaIPv6NeighborTable
alaIPv6NeighborNetAddress
alaIPv6NeighborPhysAddress
alaIPv6NeighborSlot
alaIPv6NeighborPort
alaIPv6NeighborType
alaIPv6NeighborState

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-45
clear ipv6 neighbors IPv6 Commands

clear ipv6 neighbors

Removes all entries, except static entries, from IPv6 Neighbor Table.
clear ipv6 neighbors

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This commands only clears dynamic entries. If static entries have been added to the table, they must be
removed using the no form of the ipv6 neighbor command.

Examples
-> clear ipv6 neighbors

Release History
Release 8.1.1; command introduced.

Related Commands
ipv6 neighbor Configures a static entry in IPv6 Neighbor Table.
show ipv6 neighbors Displays IPv6 Neighbor Table.

MIB Objects
alaIPv6NeighborTable
alaIPv6ClearNeighbors

page 17-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 prefixes

show ipv6 prefixes

Displays IPv6 prefixes used in router advertisements.
show ipv6 prefixes

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 prefixes

Legend: Flags: A = Autonomous Address Configuration, L = OnLink

Valid Preferred
Name IPv6 Address/Prefix Length Lifetime Lifetime Flags Source
--------------+----------------------------+----------+----------+-------+---------
vlan 955 212:95:5::/64 2592000 604800 LA dynamic
vlan 1002 195:35::/64 2592000 604800 LA dynamic
6to4tunnel 2002:d423:2323::/64 2592000 604800 LA dynamic
tunnel 2 137:35:35::/64 2592000 604800 LA dynamic

output definitions
Name The interface name. This is usually the VLAN on which the interface is
configured.
IPv6 Address/Prefix Length The IPv6 prefix and prefix length for a Router Advertisement Prefix
Option.
Valid Lifetime Length of time, in seconds, that this prefix will remain valid (i.e., time
until deprecation). A value of 4,294,967,295 represents infinity.
Preferred Lifetime Length of time, in seconds, that this prefix will remain preferred (i.e.
time until deprecation). A value of 4,294,967,295 represents infinity.
Flags L - Prefix can be used for onlink determination.
A - Prefix can be used for autonomous address configuration (i.e., can
be used to form a local interface address).
Source config - Prefix has been configured by management.
dynamic - Router Advertisements are using interface prefixes.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-47
show ipv6 prefixes IPv6 Commands

Release History
Release 8.1.1; command introduced.

Related Commands
ipv6 neighbor limit Configures an IPv6 prefix on an interface. Used for configuring
prefixes for router advertisements.

MIB Objects
IPv6AddrPrefixTable
IPv6AddressPrefixEntry
IPv6AddressPrefixLength
IPv6AddressPrefixLinkFlag
IPv6AddressPrefixAdvvalidLifetime
IPv6AddressPrefixAdvPreferredLifetime
alaIPv6InterfacePrefixTable
alaIPv6InterfacePrefix
alaIPv6InterfacePrefixLength
alaIPv6InterfacePrefixValidLifetime
alaIPv6InterfacePrefixPreferredLifetime
alaIPv6InterfacePrefixOnLinkFlag
alaIPv6InterfacePrefixsource

page 17-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 routes

show ipv6 routes

Displays IPv6 Forwarding Table.
show ipv6 routes [ipv6_prefix/prefix_length | static]

Syntax Definitions

ipv6_prefix/prefix_length IPv6 prefix. Restricts the display to those routes starting with the
specified prefix.
static Restricts display to statically configured routes.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If you do not specify an option (e.g., “static”), all IPv6 interfaces are displayed.

Examples
-> show ipv6 routes

Legend:Flags:U = Up, G = Gateway, H = Host, S = Static, C = Cloneable, D = Dynamic,

M = Modified, R = Unreachable, X = Externally resolved, B = Discard,
L = Link-layer, 1 = Protocol specific, 2 = Protocol specific

Destination Prefix Gateway Address Interface Age Protocol Flags

-------------------+----------------+--------+-----------------+------------+---------+-----
::/0 2002:d468:8a89::137 v6if-6to4-137 18h 47m 26s Static UGS
137:35:35::/64 fe80::2d0:95ff:fe12:f470 v6if-tunnel-137 18h 51m 55s Local UC
195:35::/64 fe80::2d0:95ff:fe12:f470 v6if-to-eagle 18h 51m 55s Local UC
212:95:5::/64 fe80::2d0:95ff:fe12:f470 smbif-5 18h 51m 55s Local UC
2002::/16 2002:d423:2323::35 v6if-6to4-137 18h 51m 55s Other U

output definitions
Destination Prefix IPv6 destination address and prefix.
Gateway Address IPv6 address of the gateway used to reach the destination network.
Interface The device the interface is using (e.g., VLAN 6to4tunnel); or loopback.
Age Age of the entry. Entries less than 1 day old are displayed in hh:mm:ss
format. Entries more than 1 day old are displayed in dd:hh format.
Protocol Protocol by which the route was learned.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-49
show ipv6 routes IPv6 Commands

Release History
Release 8.1.1; command introduced.

Related Commands
ipv6 static-route Configures a static entry in the IPv6 route.

MIB Objects
IPv6RouteTable
IPv6Routes
IPv6RoutesPrefix
IPV6RoutesStatic
alaIPv6StaticRouteTable
alaIPv6StaticRouteEntry

page 17-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 route-pref

show ipv6 route-pref

Displays the IPv6 routing preference of the router.
show ipv6 route-pref

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The IPv6 version of BGP is not supported in the current release.

Examples
> show ipv6 route-pref
Protocol Route Preference Value
------------+------------------------
Local 1
Static 2
OSPF 110
ISISL1 115
ISISL2 118
RIP 120
EBGP 190
IBGP 200

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 route-pref Configures the IPv6 route preference of a router.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-51
show ipv6 router database IPv6 Commands

show ipv6 router database

Displays a list of all routes (static and dynamic) that exist in the IPv6 router database. This database serves
as a central repository where routes are first processed for redistribution and where duplicate routes are
compared to determine the best route to use. If a route does not appear in the IPv6 router database list, then
the switch does not know about it. In the case of dynamically learned routes, this could indicate that the
route was never received by the switch.
show ipv6 router database [protocol type | gateway ipv6_address | dest ipv6_prefix/prefix_length]

Syntax Definitions

type Routing protocol type (local, static, OSPF, RIP, or BGP).

gateway ipv6_address IPv6 address of the next hop used to reach the destination IPv6 address.
ipv6_prefix IPv6 network that is the destination of this static route.
prefix_length The number of bits that are significant in the iPv6 address (mask).
(0...128).

Defaults
By default, all routes are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The IPv6 forwarding table is derived from IPv6 router database processing performed by the switch
and contains only unique routes that the switch currently uses. Use the show ipv6 routes command to
view the forwarding table.
• If an expected route does not appear in the IPv6 forwarding table, use the show ipv6 router database
command to see if the switch knows about the route and/or if a duplicate route with a higher
precedence was selected instead.
• The switch compares the protocol of duplicate routes to determine which one to use. Regardless of
whether or not a route has a higher priority metric value, protocol determines precedence. Local routes
are given the highest level of precedence followed by static, OSFP, RIP, then BGP routes. As a result, a
route that is known to the switch may not appear in the IP forwarding table if a duplicate route with a
higher protocol precedence exists.
• A list of inactive static routes is also included in the show ipv6 router database output display. A
route becomes inactive if the interface for its gateway goes down. Inactive routes are unable to get to
their destination and further investigation is warranted to determine why their gateway is unavailable.
• Routes that appear as inactive are not included in the main IP router database listing. If an inactive
route becomes active, however, it is removed from the inactive list and added to the active route list.

page 17-52 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 router database

Examples

-> show ipv6 router database

Legend: + indicates routes in use

Total IPRM IPv6 routes: 5

Destination/Prefix Gateway Address Interface Protocol Metric

-------------------+-------------------------+-----------------+---------+-------
::/0 2002:d468:8a89::137 v6if-6to4-137 Static 1
137:35:35::/64 fe80::2d0:95ff:fe12:f470 v6if-tunnel-137 OSPF 2
195:35::/64 fe80::2d0:95ff:fe12:f470 v6if-to-eagle OSPF 2
212:95:5::/64 fe80::2d0:95ff:fe12:f470 smbif-5 Local 1
2002::/16 2002:d423:2323::35 v6if-6to4-137 Local 1

Inactive Static Routes:

VLAN Destination/Prefix Gateway Address Metric

-----+-------------------+-------------------------+-------
1510 212:95:5::/64 fe80::2d0:95ff:fe6a:f458 1

output definitions
Destination/Prefix IPv6 destination address and prefix.
Gateway Address IPv6 address of the gateway used to reach the destination network.
Interface The device the interface is using (e.g., VLAN 6to4tunnel); or loopback.
Protocol Protocol by which this IPv6 address was learned: LOCAL, STATIC,
OSPF, RIP, BGP).
Metric RIP metric or cost (hop count) for the route. Indicates a priority for the
route. The lower the metric value, the higher the priority.
VLAN The VLAN on which the route was learned, not forwarded. Note that
N/A appears in this field for static routes as they are not learned on a
VLAN.

Release History
Release 8.1.1; command introduced.

Related Commands
show ipv6 routes Displays the IPv6 Forwarding Table.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-53
show ipv6 tcp connections IPv6 Commands

show ipv6 tcp connections

Displays the TCP connections over the IPV6 table.
show ipv6 tcp connections

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 tcp connections

Local Address Port Remote Address Port State

---------------------------+-----+----------------------------+-----+------
2001:0000:0200::23 23 2001:0000:0400::143 1867 established
2001:0000:0200::23 8734 2001:0000:0200::19 8735 timeWait

output definitions
Local Address The local IPV6 address for the TCP connection .
Port The local port number of the TCP connection.
Remote Address The remote IPV6 address for the TCP connection.
Port The remote port number of the TCP connection.
State The state of the TCP connection.

Release History
Release 8.1.1; command introduced.

page 17-54 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 tcp connections

Related Commands

show ipv6 tcp listeners Displays the TCP connections over the IPV6 listeners (endpoints
awaiting a connection request).

MIB Objects
alaRipngInterfaceTable
alaRipngInterfaceStatus
alaRipngRouteTag
alaRipngInvalidTimer
alaRipngGarbageTimer
alaRipngHolddownTimer
alaRipngJitter
alaRipngTriggeredSends

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-55
show ipv6 tcp listeners IPv6 Commands

show ipv6 tcp listeners

Displays the TCP connections over the IPV6 listeners (endpoints awaiting a connection request).
show ipv6 tcp listeners

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 tcp listeners

Local Address Port

---------------------------------------------+-----
::0 21
::0 23
::0 80

output definitions
Local Address The local IPV6 address for this TCP listener. A value of ::0 indicates
that the listener will accept a connection request sent to any of the
switch's addresses.
Port The local port number on which the listener is awaiting connection
requests.

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 tcp connections Displays the TCP connections over the IPV6 table.

page 17-56 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 tcp listeners

MIB Objects
alaRipngInterfaceTable
alaRipngInterfaceStatus
alaRipngRouteTag
laRipngInvalidTimer
alaRipngGarbageTimer
alaRipngHolddownTimer
alaRipngJitter
alaRipngTriggeredSends

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-57
show ipv6 traffic IPv6 Commands

show ipv6 traffic

Displays IPv6 traffic statistics.
show ipv6 traffic [if_name]

Syntax Definitions

if_name Interface name. Restricts the display to the specified interface instead of
global statistics.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The statistics show the cumulative totals since the last time the switch was powered on, the last reset of the
switch was executed or the traffic statistics were cleared using the command.

Examples
-> show ipv6 traffic
Message Current Previous Change
------------------------+----------+----------+----------
Packets received
Total 66193 0 66193
Header errors 0 0 0
Too big 0 0 0
No route 0 0 0
Address errors 0 0 0
Unknown protocol 0 0 0
Truncated packets 0 0 0
Local discards 0 0 0
Delivered to users 969 0 969
Reassembly needed 0 0 0
Reassembly failed 0 0 0
Multicast packets 66191 0 66191
Packets sent
Forwarded 0 0 0
Generated 23 0 23
Local discards 5 0 5
Fragmented 0 0 0
Fragmentation failed 0 0 0
Fragments generated 0 0 0
Multicast packets 34 0 34

page 17-58 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 traffic

output definitions
Total Total number of input packets received, including those received in
error.
Header errors Number of input packets discarded due to errors in their IPv6 headers
(e.g., version number mismatch, other format errors, hop count
exceeded, and errors discovered in processing their IPv6 options).
Too big Number of input packets that could not be forwarded because their size
exceeded the link MTU of the outgoing interface.
No route Number of input packets discarded because no route could be found to
transmit them to their destination.
Address errors Number of input packets discarded because the IPv6 address in their
IPv6 header's destination field was not a valid address to be received at
this entity. This count includes invalid addresses (e.g., ::0) and
unsupported addresses (e.g., addresses with unallocated prefixes).
Unknown protocol Number of locally-addressed packets received successfully but
discarded because of an unknown or unsupported protocol.
Truncated packets Number of input packets discarded because the packet frame did not
carry enough data.
Local discards Number of input IPv6 packets for which no problems were encountered
to prevent their continued processing, but which were discarded (e.g.,
for lack of buffer space). Note that this counter does not include any
packets discarded while awaiting re-assembly.
Delivered to users Total number of packets successfully delivered to IPv6 user protocols
(including ICMP).
Reassembly needed Number of IPv6 fragments received that needed to be reassembled.
Reassembly failed Number of failures detected by the IPv6 reassembly algorithm (for
whatever reason: timed out, errors, etc.).
Multicast packets Number of multicast packets received.
Forwarded Number of output packets that this entity received and forwarded to
their final destinations.
Generated Total number of IPv6 packets that local IPv6 user-protocols (including
ICMP) supplied to IPv6 in requests for transmission. Note that this
counter does not include any packets counted by the Forwarded
statistic.
Local discards Number of output IPv6 packets for which no problem was encountered
to prevent their transmission to their destination, but were discarded
(e.g., for lack of buffer space). Note that this counter would include
packets counted by the Forwarded statistic if any such packets met this
(discretionary) discard criterion.
Fragmented Number of IPv6 packets successfully fragmented.
Fragmentation failed Number of IPv6 packets discarded because they needed to be
fragmented but could not be.
Fragments generated Number of output packet fragments generated as a result of
fragmentation.
Multicast packets Number of multicast packets transmitted.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-59
show ipv6 traffic IPv6 Commands

Related Commands
show ipv6 icmp statistics Displays IPv6 ICMP statistics.

MIB Objects
ipv6IfStatsTable
ipv6IfStatsInReceives
ipv6IfStatsInHdrErrors
ipv6IfStatsInTooBigErrors
ipv6IfStatsInNoRoutes
ipv6IfStatsInAddrErrors
ipv6IfStatsInUnknownProtos
ipv6IfStatsInTruncatedPkts
ipv6IfStatsInDiscards
ipv6IfStatsInDelivers
ipv6IfStatsOutForwDatagrams
ipv6IfStatsOutRequests
ipv6IfStatsOutDiscards
ipv6IfStatsOutFragOKs
ipv6IfStatsOutFragFails
ipv6IfStatsOutFragCreates
ipv6IfStatsReasmReqds
ipv6IfStatsReasmOKs
ipv6IfStatsReasmFails
ipv6IfStatsInMcastPkts
ipv6IfStatsOutMcastPkts

page 17-60 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 tunnel configured

show ipv6 tunnel configured

Displays IPv6 tunnel information and whether the 6to4 tunnel is enabled.
show ipv6 tunnel configured

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 tunnel configured

IPv6 6to4 tunnel: Enabled

Configured Tunnels:
Tunnel IPv6 Address/Prefix Length Source IPv4 Destination IPv4
-------------------+-----------------------------+---------------+-----------------
1 2001:0000:0200::101/48 192.16.10.101 192.28.5.254
23 2001:0000:0200::102/48 192.15.10.102 10.27.105.25
v6if-tunnel-137 fe80::2d0:95ff:fe12:f470/64 212.35.35.35 212.104.138.137

output definitions
IPv6 6to4 tunnel Indicates whether 6to4 tunneling is enabled or disabled on the switch.
Tunnel Tunnel ID.
IPv6 Address/Prefix Length IPv6 address associated with the tunnel.
Source IPv4 Source IPv4 address for the tunnel.
Destination IPv4 Destination IPv4 address for the tunnel.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-61
show ipv6 tunnel configured IPv6 Commands

Related Commands
ipv6 interface Configures an IPv6 interface on a VLAN or IPv6 tunnel.

MIB Objects
alaIPv6ConfigTunnelTable
alaIPv6Tunnel6to4
alaIPv6ConfigTunnelv4Source
alaIPv6ConfigTunnelv4Dest

page 17-62 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 tunnel 6to4

show ipv6 tunnel 6to4

Displays IPv6 tunnel information and whether the 6to4 tunnel is enabled.
show ipv6 tunnel 6to4

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 tunnel 6to4
tunnel_6to4
Status = Disabled
IPv6 Address(es):
Local IPv4 Address(es):

output definitions
Name Indicates whether 6to4 tunneling is enabled or disabled on the switch.
Status Tunnel ID.
IPv6 Address(es) IPv6 address associated with the tunnel.
Local IPv4 Addresses(es) Source IPv4 address for the tunnel.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-63
show ipv6 tunnel 6to4 IPv6 Commands

Related Commands
ipv6 interface Configures an IPv6 interface on a VLAN or IPv6 tunnel.

MIB Objects
alaIPv6ConfigTunnelTable
alaIPv6Tunnel6to4
alaIPv6ConfigTunnelv4Source
alaIPv6ConfigTunnelv4Dest

page 17-64 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 udp ports

show ipv6 udp ports

Displays UDP Over IPv6 Listener Table. This table contains information about UDP/IPv6 endpoints.
show ipv6 udp ports

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Only endpoints utilizing IPv6 addresses are displayed in this table.

Examples
-> show ipv6 udp ports

Local Address Port Interface

---------------------------------------------+-----+--------------------
:: 521

output definitions
Local Address Local IPv6 address for this UDP listener. If a UDP listener accepts
packets for any IPv6 address associated with the switch, the value is ::0.
Port Local Port number for the UDP connection.
Interface Name of the interface the listener is using or “unknown.”

Release History
Release 8.1.1; command introduced.

Related Commands
show ipv6 routes Displays TCP Over IPv6 Connection Table.

MIB Objects
IPv6UdpTable
IPv6UdpEntry
IPv6UdpLocalAddress
IPv6UdpLocalPort
IPv6UdpIfIndex

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-65
show ipv6 information IPv6 Commands

show ipv6 information

Displays IPv6 information.
show ipv6 information

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 information
Default hop limit = 64
Path MTU entry minimum lifetime (min) = 10
Neighbor stale lifetime (min) = 10
Local Unicast Global ID = 70:3302:a472
Use VRRP virtual source MAC = Off
Neighbor cache limit = 8000
VRF neighbor cache limit = 8000

output definitions
Default hop limit The value placed in the hop limit field in router advertisements.
Path MTU entry minimum Minimum lifetime for entries in the path MTU.
lifetime
Neighbor stale lifetime Minimum lifetime for neighbor entries in the stale state.
Local Unicast Global ID The default global ID value used in unique local unicast
addresses.“none” if a global ID has not been configured.
VRRP virtual source MAC If On, when a packet's source address is a VRRP virtual IPv6 address,
the corresponding VRRP virtual MAC will be used as the source MAC
address. If Off, the interface's real MAC will be used as the source
MAC address.
Neighbor cache limit The system-wide neighbor cache limit. “none” if the value is not set.
VRF neighbor cache limit The neighbor cache limit in use for the VRF in which the command
was executed. the value will be “none” if not set.

page 17-66 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 information

Release History
Release 8.1.1; command introduced.

Related Commands
ipv6 neighbor Configures a static entry in the IPv6 Neighbor Table.
ipv6 interface tunnel source Configures the system-wide maximum limit for the number of
destination neighbor entries in the cache. Setting the limit avoids the memory
exhaustion denial of service attack.
ipv6 interface tunnel source Configures the maximum limit for the number of VRF's neighbor
destination entries in the cache. Setting the VRF limit ensures that any VRF
does not exhaust all the space in the neighbor cache.
ipv6 interface tunnel source Configures the Router Advertisement (RA) filtering on IPv6
destination VLAN interfaces. When RA filtering is enabled, by default it is
enabled on all the ports and linkaggs and any RAs received on
them will be discarded. The command also allows to configure the
trusted ports and linkaggs to receive RAs.

MIB Objects
ipv6MibObjects
Ipv6DefaultHopLimit
alaIPv6ConfigTable
alaIPv6PMTUMinLifetime
alaIPv6NeighborTable
alaIPv6NeighborStaleLifetime
alaIPv6NeighborLimit
alaIPv6NeighborVRFLimitDefault
alaIPv6NeighborInterfaceLimitDefault
alaIPv6NeighborVRFLimit

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-67
ipv6 redist IPv6 Commands

ipv6 redist
Controls the conditions for redistributing IPv6 routes between different protocols.
ipv6 redist {local | static | rip | ospf | isis | bgp} into {rip | ospf | isis | bgp} {all-routes | route-map
route_map_name} [admin-state {enable | disable}]
no ipv6 redist {local | static | ospf | isis | bgp} into {rip | ospf | isis | bgp} [all-routes | route-map
route_map_name]

Syntax Definitions

local Redistributes local IPv6 routes.

static Redistributes static IPv6 routes.
rip Specifies RIP as the source or destination (into) protocol.
ospf Specifies OSPF as the source or destination (into) protocol.
bgp This parameter is currently not supported.
isis This parameter is currently not supported.
all-routes Redistributes all routes. This option does not allocate route-map
resources.
route_map_name Name of an existing route map that will control the redistribution of
routes between the source and destination protocol.
enable Enables the administrative status of the redistribution configuration.
disable Disables the administrative status of the redistribution configuration.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a route map redistribution configuration. Note that if a
route map name is not specified, all route maps associated with the redistribution configuration are
removed.
• The source and destination protocols must be loaded and enabled before redistribution occurs.

• The IPv6 version of BGP is not supported in the current release.

• Use the ip route-map commands described in the “IP Commands” chapter of this guide to create a
route map. Refer to the “Configuring IP” chapter in the OmniSwitch AOS Release 8 Network Configu-
ration Guide for more information about how to create a route map.

page 17-68 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 redist

Examples
-> ipv6 redist rip into ospf route-map rip-to-ospf1
-> ipv6 redist rip into ospf route-map rip-to-ospf2
-> no ipv6 redist rip into ospf route-map rip-to-ospf2
-> ipv6 redist local into rip route-map local-to-rip
-> ipv6 redist local into rip route-map local-to-rip disable

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 redist Displays the route map redistribution configuration.

MIB Objects
alaRouteMapRedistProtoTable
alaRouteMapRedistSrcProtoId
alaRouteMapRedistDestProtoId
alaRouteMapRedistRouteMapIndex
alaRouteMapRedistStatus
alaRouteMapRedistAddressType
alaRouteMapRedistRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-69
ipv6 access-list IPv6 Commands

ipv6 access-list
Creates an IPv6 access list that is used to specify multiple IPv6 addresses for a route map configuration.
ipv6 access-list access-list-name
no ipv6 access-list access-list-name

Syntax Definitions

access-list-name Name of the IPv6 access list (up to 20 characters).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to delete the access list.

Examples
-> ipv6 access-list access1
-> no ipv6 access-list access1

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 access-list address Adds IPv6 addresses to an existing IPv6 access list.
show ipv6 access-list Displays the contents of an IPv6 access list.

MIB Objects
alaRouteMapAccessListNameTable
alaRouteMapAccessListName
alaRouteMapAccessListNameIndex
alaRouteMapAccessListNameAddressType
alaRouteMapAccessListNameRowStatus

page 17-70 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 access-list address

ipv6 access-list address

Adds IPv6 addresses to the specified IPv6 access list.
ipv6 access-list access-list-name address address/prefixLen [action {permit | deny}] [redist-control
{all-subnets | no-subnets | aggregate}]
no ipv6 access-list access-list-name address address/prefixLen

Syntax Definitions

access-list-name Name of the IPv6 access list (up to 20 characters).

address/prefixLen IPv6 address along with the prefix length to be added to the access list.
permit Permits the IPv6 address for redistribution.
deny Denies the IPv6 address for redistribution.
all-subnets Redistributes or denies all the subnet routes that match the network
portion of the IP address as specified by the mask length.
no-subnets Redistributes or denies only those routes that exactly match the IP
address and the mask length.
aggregate Redistributes an aggregate route if there are one or more routes that
match or are subnets of this address.

Defaults

parameter default
permit | deny permit
all-subnets | no-subnets | all-subnets
aggregate

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the address from the access list.

• The access-list-name should exist before you add multiple IPv6 addresses to the IPv6 access list.

• The action parameters (permit and deny) determine if a route that matches the redist-control
configuration for the IP address is allowed or denied redistribution.
• The redist-control parameters (all-subnets, no-subnets, and aggregate) defines the criteria used to
determine if a route matches an address in the access list.
• Note that configuring the combination of redist-control aggregate with action deny is not allowed.

• Use this command multiple times with the same access list name to add multiple addresses to the
existing IPv6 access list.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-71
ipv6 access-list address IPv6 Commands

Examples
-> ipv6 access-list access1 address 2001::1/64 action permit
-> ipv6 access-list access1 address 2001::1/64 redist-control aggregate
-> no ipv6 access-list access1 address 2001::1/64

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 access-list Creates an IPv6 access list that is used to specify multiple IPv6
addresses for a route map configuration.
show ipv6 access-list Displays the contents of an IPv6 access list.

MIB Objects
alaRouteMapAccessListTable
alaRouteMapAccessListIndex
alaRouteMapAccessListAddress
alaRouteMapAccessListAddressType
alaRouteMapAccessListPrefixLength
alaRouteMapAccessListAction
alaRouteMapAccessListRedistControl
alaRouteMapAccessListRowStatus

page 17-72 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 redist

show ipv6 redist

Displays the IPv6 route map redistribution configuration.
show ipv6 redist [rip | ospf | bgp]

Syntax Definitions

rip Displays the route map redistribution configurations that specify RIP as
the destination (into) protocol.
ospf Displays the route map redistribution configurations that specify OSPF
as the destination (into) protocol.
bgp This parameter is not supported.

Defaults
By default all route map redistribution configurations are shown.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Specify a destination protocol with this command to display only those configurations that redistribute
routes into the specified protocol.
• The IPv6 version of BGP is not supported in the current release.

Release History
Release 8.1.1; command introduced.

Examples
-> show ipv6 redist

Source Destination
Protocol Protocol Status Route Map
------------+------------+---------+--------------------
localIPv6 RIPng Enabled ipv6rm
RIPng OSPFv3 Enabled ipv6rm

-> show ipv6 redist ospf

Source Destination
Protocol Protocol Status Route Map
------------+------------+---------+--------------------
RIPng OSPFv3 Enabled ipv6rm

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-73
show ipv6 redist IPv6 Commands

output definitions
Source Protocol The protocol from which the routes are learned.
Destination Protocol The protocol into which the source protocol routes are redistributed.
Status The administrative status (Enabled or Disabled) of the route map
redistribution configuration.
Route Map The name of the route map that is applied with this redistribution
configuration.

Related Commands

ipv6 redist Controls the conditions for redistributing IPv6 routes between
different protocols.

MIB Objects
alaRouteMapRedistProtoTable
alaRouteMapRedistSrcProtoId
alaRouteMapRedistDestProtoId
alaRouteMapRedistRouteMapIndex
alaRouteMapRedistStatus
alaRouteMapRedistAddressType
alaRouteMapRedistRowStatus

page 17-74 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 access-list

show ipv6 access-list

Displays the contents of the specified IPv6 access list.
show ip access-list [access-list-name]

Syntax Definitions

access-list-name Name of the IPv6 access list.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If the access-list-name is not specified in this command, all the access lists will be displayed.

Examples
-> show ipv6 access-list
Address / Redistribution
Name Prefix Length Effect Control
--------------------+------------------+-------+--------------
al_3 128::/64 permit all-subnets
al_4 124::/64 permit no-subnets

-> show ipv6 access-list 4

Address / Redistribution
Name Prefix Length Effect Control
--------------------+------------------+-------+--------------
al_4 124::/64 permit no-subnets

output definitions
Name Name of the IPv6 access list.
Address/Prefix Length IPv6 address that belongs to the access list.
Effect Indicates whether the IPv6 address is permitted or denied for
redistribution.
Redistribution Control Indicates the conditions specified for redistributing the matched routes.

Release History
Release 8.1.1; command introduced

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-75
show ipv6 access-list IPv6 Commands

Related Commands

ipv6 access-list Creates an IPv6 access list for adding multiple IPv6 addresses to route
maps.
ipv6 access-list address Adds multiple IPv6 addresses to the IPv6 access list.

MIB objects
alaRouteMapAccessListIndex
alaRouteMapAccessListAddressType
alaRouteMapAccessListAddress
alaRouteMapAccessListPrefixLength
alaRouteMapAccessListAction
alaRouteMapAccessListRedistControl

page 17-76 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 load rip

ipv6 load rip

Loads RIPng into memory. When the switch is initially configured, you must load RIPng into memory to
enable RIPng routing.
ipv6 load rip

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the ipv6 rip admin-state command to enable RIPng on the switch.

Examples
-> ipv6 load rip

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 rip admin-state Enables/disables RIPng routing on the switch.

show ipv6 rip Displays RIPng status and general configuration parameters.

MIB Objects
alaDrcTmConfig
alaDrcTmIPRipngStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-77
ipv6 rip admin-state IPv6 Commands

ipv6 rip admin-state

Enables or disables RIPng on the switch.
ipv6 rip admin-state {enable | disable}

Syntax Definitions

N/A

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
RIPng must be loaded on the switch (ipv6 load rip) to enable RIP on the switch.

Examples
-> ipv6 rip admin-state enable

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 load rip Loads RIPng into memory.

show ipv6 rip Displays RIPng status and general configuration parameters.

MIB Objects
alaProtocolripng
alaRipngProtoStatus

page 17-78 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 rip invalid-timer

ipv6 rip invalid-timer

Configures the amount of time a route remains active in RIB before being moved to the "Garbage" state.
ipv6 rip invalid-timer seconds

Syntax Definitions

seconds Time, in seconds, that a route will remain in an “Active” state. Valid
range is 1 - 300.

Defaults

parameter default
seconds 180

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This timer is reset each time a routing update is received.

Examples
-> ipv6 rip invalid-timer 300

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 rip garbage-timer Configures the RIPng garbage timer value.

ipv6 rip holddown-timer Configures the amount of time a route is placed in a holddown state.

MIB Objects
alaProtocolripng
alaRipngInvalidTimer

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-79
ipv6 rip garbage-timer IPv6 Commands

ipv6 rip garbage-timer

Configures the RIPng garbage timer value. When a route in the RIB exceeds the configured Invalid Timer
Value, the route is moved to a “Garbage” state in the the RIB. The garbage timer is the length of time a
route will stay in this state before it is flushed from the RIB.
ipv6 rip garbage-timer seconds

Syntax Definitions

seconds Time, in seconds, that a route will remain in the RIPng Routing Table
before it is flushed from the RIB. Valid range is 0 - 180.

Defaults

parameter default
seconds 120

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the ipv6 rip invalid-timer command to set the Invalid Timer Value.

Examples
-> ipv6 rip garbage-timer 180

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 rip invalid-timer Configures the amount of time a route remains active in RIB before
being moved to the "Garbage" state.
ipv6 rip holddown-timer Configures the amount of time a route is placed in a holddown state.

MIB Objects
alaProtocolripng
alaRipngGarbageTimer

page 17-80 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 rip holddown-timer

ipv6 rip holddown-timer

Configures the amount of time a route is placed in a holddown state. Whenever a route is seen from the
same gateway with a higher metric than the route in RIB, the route goes into holddown. This excludes
route updates with an INFINITY metric.
ipv6 rip holddown-timer seconds

Syntax Definitions

seconds Time, in seconds, that a route will remain in a holddown state. Valid
range is 0 - 120.

Defaults

parameter default
seconds 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
While in holddown, the route continues being announced as usual and used in RIB. This interval is used to
control route flap dampening.

Examples
-> ipv6 rip holddown-timer 60

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 rip invalid-timer Configures the amount of time a route remains active in RIB before
being moved to the "Garbage" state.
ipv6 rip garbage-timer Configures the RIPng garbage timer value.

MIB Objects
alaProtocolripng
alaRipngHolddownTimer

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-81
ipv6 rip jitter IPv6 Commands

ipv6 rip jitter

Configures an offset value for RIPng updates. This is the maximum (positive or negative) value that can
be used to offset the update interval. For example, with an update interval of 30 seconds, and a jitter value
of 5 seconds, the RIPng update packet would be sent somewhere (random) between 25 and 35 seconds
from the previous update.
ipv6 rip jitter value

Syntax Definitions

value Time, in seconds, that a routing update is offset. Valid range is 0 to one-
half the updated interval value (e.g., if the updated interval is 30, the
range would be 0 - 300).

Defaults

parameter default
value 5

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
As you increase the number of RIPng interfaces/peers, it is recommended that you increase the Jitter value
to reduce the number of RIPng updates being sent over the network.

Examples
-> ipv6 rip jitter 10

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 rip update-interval Configures the RIPng update interval.

show ipv6 rip Displays RIPng status and general configuration information.

MIB Objects
alaProtocolripng
alaRipngJitter

page 17-82 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 rip route-tag

ipv6 rip route-tag

Configures the route tag value for RIP routes generated by the switch.
ipv6 rip route-tag value

Syntax Definitions

value Route tag value. Valid range is 0 – 65535.

Defaults

parameter default
value 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This value does not apply to routes learned from other routers. For these routes, the route tag propagates
with the route.

Examples
-> ipv6 rip route-tag 30

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 rip Displays RIPng status and general configuration information.

MIB Objects
alaProtocolripng
alaRipngRouteTag

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-83
ipv6 rip update-interval IPv6 Commands

ipv6 rip update-interval

Configures the RIPng update interval. This is the interval, in seconds, that RIPng routing updates will be
sent out.
ipv6 rip update-interval seconds

Syntax Definitions

seconds Interval, in seconds, that RIPng routing updates are sent out. Valid range
is 0–120.

Defaults

parameter default
seconds 30

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use this command, along with the ipv6 rip jitter command to configure RIPng updates.

Examples
-> ipv6 rip update-interval 30

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 rip jitter Configures an offset value for RIPng updates.

show ipv6 rip Displays RIPng status and general configuration information.

MIB Objects
alaRipng
alaRipngUpdateInterval

page 17-84 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 rip triggered-sends

ipv6 rip triggered-sends

Configures the behavior of triggered updates.
ipv6 rip triggered-sends {all | updated-only | none}

Syntax Definitions

updated-only Only route changes that are causing the triggered update are included in
the update packets.
none RIPng routes are not added to triggered updates.

Defaults

parameter default
all | updated-only | none updated-only

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If set to all, all routes are sent in the update, not just route changes, which increases RIPng traffic on
the network.
• If set to none, no triggered updates are sent, which can cause delays in network convergence.

Examples
-> ipv6 rip triggered-sends none

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 rip Displays RIPng status and general configuration information.

MIB Objects
alaProtocolripng
alaRipngTriggeredSends

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-85
ipv6 rip interface IPv6 Commands

ipv6 rip interface

Creates or deletes a RIPng interface.
ipv6 rip interface if_name
[no] ipv6 rip interface if_name

Syntax Definitions

if_name IPv6 interface name.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• By default, a RIPng interface is created in the enabled state.

• Routing is enabled on a VLAN when you create a router port. However, to enable RIPng routing, you
must also configure and enable a RIPng routing interface on the VLAN’s IP router port. For more
information on VLANs and router ports, see Chapter 5, “VLAN Management Commands”.
• RIPng will support a maximum of 20 interfaces.

Examples
-> ipv6 rip interface Test_Lab

Release History
Release 8.1.1; command introduced.

page 17-86 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 rip interface

Related Commands

ipv6 redist Loads RIPng into memory.

ipv6 rip admin-state Enables or disables RIPng on the switch.
ipv6 rip interface recv-status Configures IPv6 RIPng interface “Receive” status. When this status
is set to "enable", packets can be received on this interface.
ipv6 rip interface send-status Configures IPv6 RIPng interface “Send” status. When this status is
set to "enable", packets can be sent on this interface.
show ipv6 rip interface Displays information for all or specified RIPng interfaces.

MIB Objects
alaRipngInterfaceTable
alaRipngInterfaceStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-87
ipv6 rip interface metric IPv6 Commands

ipv6 rip interface metric

Configures the RIPng metric or cost for a specified interface. You can set priorities for routes generated by
a switch by assigning a metric value to routes generated by that switch’s RIPng interface. For example,
routes generated by a neighboring switch may have a hop count of 1. However, you can lower the priority
of routes generated by that switch by increasing the metric value for routes generated by the RIPng inter-
face.
ipv6 rip interface if_name metric value

Syntax Definitions

if_name IPv6 interface name.

value Metric value. Valid range is 1 - 15.

Defaults

parameter default
value 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
When you configure a metric for a RIPng interface, this metric cost is added to the metric of the incoming
route.

Examples
-> ipv6 rip Test_Lab metric 1

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 rip interface Creates or deletes a RIPng interface.

show ipv6 rip interface Displays information for all or specified RIPng interfaces.

MIB Objects
alaRipngInterfaceTable
alaRipngInterfaceMetric

page 17-88 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 rip interface recv-status

ipv6 rip interface recv-status

Configures IPv6 RIPng interface “Receive” status. When this status is set to "enable", packets can be
received on this interface. When it is set to "disable", packets will not be received on this interface.
ipv6 rip interface if_name recv-status {enable | disable}

Syntax Definitions

if_name IPv6 interface name.

enable Enables the “Receive” status for the specified interface.
disable Disables the “Receive” status for the specified interface.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
RIPng must be loaded (ipv6 load rip) and enabled (ipv6 rip admin-state) on the switch to send or receive
packets on the interface.

Examples
-> ipv6 rip interface Test_Lab recv-status disable

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 redist Loads RIPng into memory.

ipv6 rip admin-state Enables/disables RIPng on the switch.
ipv6 rip interface send-status Configures IPv6 RIPng interface “Send” status.

MIB Objects
alaRipngInterfaceTable
alaRipngInterfaceRecvStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-89
ipv6 rip interface send-status IPv6 Commands

ipv6 rip interface send-status

Configures IPv6 RIPng interface “Send” status. When this status is enabled, packets can be sent from this
interface. When it is disabled, packets will not be sent from this interface.
ipv6 rip interface if_name send-status {enable | disable}

Syntax Definitions

if_name IPv6 interface name.

enable Enables the “Send” status for the specified interface.
disable Disables the “Send” status for the specified interface.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
RIPng must be loaded (ipv6 load rip) and enabled (ipv6 rip admin-state)on the switch to send or receive
packets on the interface.

Examples
-> ipv6 rip interface Test_Lab send-status enable

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 redist Loads RIPng into memory.

ipv6 rip admin-state Enables/disables RIPng on the switch.
ipv6 rip interface recv-status Configures IPv6 RIPng interface “Receive” status.

MIB Objects
alaRipngInterfaceTable
alaRipngInterfaceSendStatus

page 17-90 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 rip interface horizon

ipv6 rip interface horizon

Configures the routing loop prevention mechanisms.
ipv6 rip interface if_name horizon {none | split-only | poison}

Syntax Definitions

if_name IPv6 interface name.

none Disables loop prevention mechanisms.
split-only Enables split-horizon, without poison-reverse.
poison Enables split-horizon with poison-reverse.

Defaults

parameter default
none | split-only | poison poison

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If set to none the route is not sent back to the peer.

• If set to split-only, the route received from the peer is sent back with an increased metric.

• If set to poison the route received from the peer is sent back with an “infinity” metric.

Examples
-> ipv6 rip interface Test_Lab none

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 rip interface Displays information for all or specified RIPng interfaces.
show ipv6 rip routes Displays all or a specific set of routes in the RIPng Routing Table.

MIB Objects
alaRipngInterfaceTable
alaRipngInterfaceHorizon

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-91
show ipv6 rip IPv6 Commands

show ipv6 rip

Displays the RIPng status and general configuration parameters.
show ipv6 rip

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 rip

Status = Enabled,
Number of routes = 10,
Route tag = 0,
Update interval = 30,
Invalid interval = 180,
Garbage interval = 120,
Holddown interval = 0,
Jitter interval = 5,
Triggered Updates = All Routes,

output definitions
Status RIPng protocol status (enabled or disabled).
Number of routes Number of RIPng routes in Forwarding Information Base (FIB).
Route tag Route tag value for RIP routes generated by the switch. Default is 0.
Invalid interval Invalid Timer setting, in seconds.
Garbage interval Garbage Timer setting, in seconds.
Holddown interval Holddown Timer setting, in seconds.
Jitter interval Jitter setting.
Triggered updates Triggered Updates setting (All Routes, Updated Routes, and None).

Release History
Release 8.1.1; command introduced.

page 17-92 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 rip

Related Commands

ipv6 rip admin-state Enables or disables RIPng routing on the switch.

ipv6 rip route-tag Configures the route tag value for RIP routes generated by the
switch.
ipv6 rip update-interval Configures the Interval, in seconds, so that RIPng routing updates
are sent out.
ipv6 rip invalid-timer Configures the amount of time a route remains active in RIB before
being moved to the "garbage" state.
ipv6 rip invalid-timer Configures the RIPng garbage timer value. Routes move into the
garbage collection state because the timer expired or a route update
with an INFINITY metric was received.
ipv6 rip holddown-timer Configures the amount of time a route is placed in a holddown state.
ipv6 rip jitter Configures an offset value for RIPng updates. This is the maximum
(positive or negative) value that can be used to offset the update
interval.
ipv6 rip triggered-sends Configures the behavior of triggered updates.

MIB Objects
alaRipngInterfaceTable
alaRipngInterfaceStatus
alaRipngRouteTag
laRipngInvalidTimer
alaRipngGarbageTimer
alaRipngHolddownTimer
alaRipngJitter
alaRipngTriggeredSends

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-93
show ipv6 rip interface IPv6 Commands

show ipv6 rip interface

Displays information for all or specified RIPng interfaces.
show ipv6 rip interface [if_name]

Syntax Definitions

if_name IPv6 interface name.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If you do not specify an interface, all IPv6 RIP interfaces are displayed.

Examples
-> show ipv6 rip interface

Interface Packets
Name Status Recvd Sent Metric
--------------------+----------+---------+--------+---------
Test_Lab Active 12986 12544 1
Test_Lab_2 Active 12556 12552 1

-> show ipv6 rip interface if3

Name = Test_Lab,
IPv6 interface index = 3,
Interface status = Active,
Next Update = 27 secs,
Horizon Mode = Split and Poison-reverse,
MTU size = 1500,
Metric = 1,
Send status = Enabled,
Receive status = Enabled,
Packets received = 12986,
Packets sent = 12544,

output definitions
Interface name Interface name.
IPv6 interface index IPv6 index of this interface.
Status Interface status (Active/Inactive).
Packets Recvd Number of packets received by the interface.

page 17-94 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 rip interface

output definitions (continued)

Packets Sent Number of packets sent by the interface.
Metric RIPng metric (cost) configured for the interface.
IPv6 interface index IPv6 interface index number.
Interface status Interface status (Active/Inactive).
Next update Seconds remaining until the next update on this interface.
Horizon mode Interface Horizon Mode (routing loop prevention mechanisms).
Displayed modes are none/split-only/poison-reverse.
MTU size Maximum transmission size for RIPng packets on the interface.
Send status Interface “Send” status. When this status is set to "enable", packets can
be sent from this interface. When it is set to "disable", packets will not
be sent from this interface.
Receive status Interface “Receive” status. When this status is set to "enable", packets
can be received by this interface. When it is set to "disable", packets
cannot be received by this interface.
Packets received Number of packets received by the interface.
Packets sent Number of packets sent by the interface.

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 rip interface IPv6 interface name.

ipv6 rip admin-state Enables or disables RIPng routing on the switch.
ipv6 rip interface recv-status Configures the interface “Receive” status. When this status is set to
"enable", packets can be received by this interface. When it is set to
"disable", packets cannot be received by this interface.
ipv6 rip interface send-status Configures the interface “Send” status. When this status is set to
"enable", packets can be sent from this interface. When it is set to
"disable", packets will not be sent from this interface.
ipv6 rip interface metric Configures the RIPng metric (cost) for the interface.
ipv6 rip interface horizon Configures the interface Horizon Mode (routing loop prevention
mechanisms).
show ipv6 rip Displays RIPng status and general configuration parameters (e.g.,
force holddown timer).

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-95
show ipv6 rip interface IPv6 Commands

MIB Objects
alaRipngInterfaceTable
alaRipngInterfaceEntry
alaRipngInterfaceStatus
alaRipngInterfacePacketsRcvd
alaRipngInterfacePacketsSent
alaRipngInterfaceMetric
alaRipngInterfaceIndex
alaRipngInterfaceNextUpdate
alaRipngInterfaceHorizon
alaRipngInterfaceMTU
alaRipngInterfaceSendStatus
alaRipngInterfaceRecvStatus

page 17-96 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 rip peer

show ipv6 rip peer

Displays a summary of the observed RIPng peers, or specific information about a peer when a peer
address is provided.
show ipv6 rip peer [ipv6_addresss]

Syntax Definitions

ipv6_addresss IPv6 address of the peer.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If you do not specify a peer, all IPv6 RIP peers are displayed.

Examples
-> show ipv6 peer
Seen on Packets Last
Address Interface Recv Update
-----------------------------+-------------+--------+----------
fe80::200:39ff:fe1f:710c vlan172 23 20
fe80::2d0:95ff:fe12:da40 bkbone20 33 2
fe80::2d0:95ff:fe12:da40 vlan150 26 25
fe80::2d0:95ff:fe6a:5d41 nssa23 20 25

-> show ipv6 rip peer fe80::2d0:95ff:fe12:da40

Peer#1 address = fe80::2d0:95ff:fe12:da40,

Seen on interface = bkbone20,
Last Update = 8 secs,
Received packets = 33,
Received bad packets = 0
Received routes = 5,
Received bad routes = 0

Peer#2 address = fe80::2d0:95ff:fe12:da40,

Seen on interface = vlan150,
Last Update = 1 secs,
Received packets = 27,
Received bad packets = 0
Received routes = 2,
Received bad routes = 0

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-97
show ipv6 rip peer IPv6 Commands

output definitions
Address IPv6 address of the peer.
Seen on Interface Interface used to reach the peer.
Packets Recvd Number of packets received from the peer.
Last Update Number of seconds since the last update was received from the peer.
Peer address Peer IPv6 address.
Received packets Number of packets received from the peer.
Received bad packets Number of bad packets received from the peer.
Received routes Number of RIPng routes received from the peer.
Received bad routes Number of bad RIPng routes received from the peer.

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 rip interface Displays all or specified RIPng interface status.
show ipv6 rip routes Displays all or a specific set of routes in RIPng Routing Table.

MIB Objects
alaRipngPeerTable
alaRipngPeerEntry
alaRipngPeerAddress
alaRipngPeerIndex
alaRipngPeerLastUpdate
alaRipngPeerNumUpdates
alaRipngPeerBadPackets
alaRipngPeerNumRoutes
alaRipngPeerBadRoutes

page 17-98 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 rip routes

show ipv6 rip routes

Displays all or a specific set of routes in RIPng Routing Table.
show ipv6 rip routes [dest <ipv6_prefix/prefix_length>] | [gateway <ipv6_addr>] | [detail <ipv6
prefix/prefix_length>]

Syntax Definitions

dest Displays all routes whose destination matches the IPv6 prefix/prefix
length.
gateway Displays all routes whose gateway matches the specified IPv6 address.
detail Displays detailed information about a single route matching the
specified destination.
ipv6_addr IPv6 address.
ipv6_prefix/prefix length IPv6 address and prefix/prefix length.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If you do not enter one of the optional parameters, all IPv6 RIP routes are displayed.

Examples
-> show ipv6 rip routes

Legends: State: A = Active, H = Holddown, G = Garbage

Destination Gateway State Metric Proto
---------------+----------------------------+-------+------+------
100::1/128 +fe80::200:39ff:fe1f:710c A 2 Rip
100::100:1/128 +fe80::200:39ff:fe1f:710c A 2 Rip
400::/100 +fe80::2d0:95ff:fe12:e050 A 1 Local
900::/100 +fe80::2d0:95ff:fe12:e050 A 1 Local
8900::/100 +fe80::2d0:95ff:fe12:da40 A 2 Rip
9800::/100 +fe80::2d0:95ff:fe12:da40 A 2 Rip
9900::/100 +fe80::2d0:95ff:fe12:e050 A 1 Local

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-99
show ipv6 rip routes IPv6 Commands

-> show ipv6 rip routes detail 9900::/100

Destination = 9900::,
Mask length = 100,
Gateway(1) = fe80::2d0:95ff:fe12:e050,
Protocol = Local,
Out Interface = nssa23,
Metric = 1,
Status = Installed,
State = Active,
Age = 10544s,
Tag = 0,
Gateway(2) = fe80::2d0:95ff:fe12:da40,
Protocol = Rip,
Out Interface = bkbone20,
Metric = 2,
Status = Not Installed,
State = Active,
Age = 15s,
Tag = 0,

output definitions
Destination IPv6 address/address length of the destination.
Gateway IPv6 gateway used to reach the destination.
State Route status (Active/Inactive).
Metric Routing metric for this route.
Protocol Protocol used to learn the route.
Mask Length Prefix Length.
Out Interface The interface used to reach the destination.
Status Route status (Active/Inactive).
Age The number of seconds since the route was last updated.
Tag The route tag value for the route.

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 rip interface Creates/deletes a RIPng interface.

ipv6 rip interface metric Configures the RIPng metric or cost for a specified interface.
show ipv6 rip interface Displays all or specified RIPng interface status.

page 17-100 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 rip routes

MIB Objects
alaRipngRouteTable
alaRipngRouteEntry
alaRipngRoutePrefixLen
alaRipngRouteNextHop
alaRipngRouteType
alaRipngRouteAge
alaRipngRouteTag
alaRipngRouteStatus
alaRipngRouteMetric

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-101
ipv6 dhcp relay admin-state IPv6 Commands

ipv6 dhcp relay admin-state

Enables or disables the DHCPv6 Relay feature on a per-VRF basis.
ipv6 dhcp relay admin-state {enable | disable}

Syntax Definitions

enable Enables the DHCPv6 Relay feature.

disable Disables the DHCPv6 Relay feature.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
DHCPv6 Relay must still be explicitly enabled on the interfaces from which received DHCP client
messages are to be relayed.

Examples
-> ipv6 dhcp relay admin-state enable
-> ipv6 dhcp relay admin-state disable

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 dhcp relay interface Enables or disables the relay of DHCPv6 client messages received
admin-state on an interface.
show ipv6 dhcp relay Displays all the interface on which the DHCPv6 relay is configured,
the relay destinations, and the status of the DHCPv6 relay.

MIB Objects
alaDHCPv6Config
alaDHCPv6RelayAdminStatus

page 17-102 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 dhcp relay interface admin-state

ipv6 dhcp relay interface admin-state

Enables or disables the relay of DHCPv6 client messages received on an interface.
ipv6 dhcp relay if-name admin-state {enable | disable}

Syntax Definitions

if-name IPv6 interface name.

enable Enables the DHCPv6 Relay on an interface.
disable Disables the DHCPv6 Relay on an interface.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
At least one relay destination should be configured before enabling the DHCPv6 relay on an interface.

Examples
-> ipv6 dhcp relay int1 admin-state enable
-> ipv6 dhcp relay int1 admin-state disable

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 dhcp relay destination Configures the DHCPv6 relay destination.

show ipv6 dhcp relay Displays all the interface on which the DHCPv6 relay is configured,
the relay destinations, and the status of the DHCPv6 relay.

MIB Objects
alaDHCPv6RelayInterfaceTable
alaDHCPv6RelayInterfaceAdminStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-103
ipv6 dhcp relay destination IPv6 Commands

ipv6 dhcp relay destination

Configures the DHCPv6 relay destination.
ipv6 dhcp relay if-name destination ip6-address scope-if-name
no ipv6 dhcp relay if-name destination ip6-address scope-if-name

Syntax Definitions

if-name IPv6 interface name.

ip6-address The IPv6 address of the relay destination.
scope-if-name Name of the interface for the local-link. This should be specified if the
relay destination is a local-link.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Maximum five destinations can be configured for an interface.

• If the relay destination is a local-link then the interface-ID of the local-link should be specified.

• Use the no form of the command to remove the configured DHCPv6 relay destination for an interface.

Examples
-> ipv6 dhcp relay int1 destination 3001::3
-> ipv6 dhcp relay int1 destination fe80::64 int1
-> no ipv6 dhcp relay int1 destination 3001::3

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 dhcp relay Displays all the interface on which the DHCPv6 relay is configured,
the relay destinations, and the status of the DHCPv6 relay.

page 17-104 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands ipv6 dhcp relay destination

MIB Objects
alaDHCPv6RelayDestinationTable
alaDHCPv6RelayDestinationEntry
alaDHCPv6RelayDestinationAddressType
alaDHCPv6RelayDestinationAddress
alaDHCPv6RelayDestinationRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-105
show ipv6 dhcp relay IPv6 Commands

show ipv6 dhcp relay

Displays all the interface on which the DHCPv6 relay is configured, the relay destinations, and the status
of the DHCPv6 relay.
show ipv6 dhcp relay

Syntax Definitions
N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The interface for which the DHCPv6 relay is disabled for the VRF and which do not have relay destination
configured will not be displayed in the output.

Examples
-> show ipv6 dhcp relay

DHCPv6 Relay: Enabled

Interface Relay Destination(s) Status

---------------------------+-----------------------------------------+--------
vlan-41 ff02::1:2 Enabled
vlan-103 2001:dbc8:8003::17 Disabled
2001:dbc8:8004::99
vlan-200 fe80::cd0:deff:fe28:1ca5 vlan-201 Enabled
tunnel-2 2001:dbc8:a23::ea77 Enabled

output definitions
DHCPv6 Relay Specifies if the DHCPv6 Relay feature is enabled in the current VRF.
Interface Displays the interface on which DHCPv6 Relay is enabled.
Relay Destination(s) Displays the configured DHCPv6 Relay destination(s) for the interface.
Status Displays the status of DHCPv6 Relay on the interface.

Release History
Release 8.1.1; command introduced.

page 17-106 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPv6 Commands show ipv6 dhcp relay

Related Commands

ipv6 dhcp relay admin-state Enables or disables the DHCPv6 Relay feature on a per-VRF basis.
ipv6 dhcp relay interface Enables or disables the relay of DHCPv6 client messages received
admin-state on an interface.
ipv6 dhcp relay destination Configures the DHCPv6 relay destination.

MIB Objects
alaDHCPv6RelayAdminStatus
alaDHCPv6RelayInterfaceEntry
alaDHCPv6RelayDestinationAddress
alaDHCPv6RelayInterfaceAdminStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 17-107
show ipv6 dhcp relay IPv6 Commands

page 17-108 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 18 IPsec commands

IPsec is a suite of protocols for securing IPv6 communications by authenticating and/or encrypting each
IPv6 packet in a data stream. IPsec provides security services such as Encrypting traffic, Integrity
validation, Authenticating the peers, and Anti-replay.
IPsec protocols operate at network layer using appropriate security protocols, cryptographic algorithms,
and cryptographic keys. The security services are provided through use of two security protocols, the
Authentication Header (AH) and the Encapsulating Security Payload (ESP), and through the use of
cryptographic key management procedures and protocols.
There are two modes of IPsec operation: transport mode and tunnel mode. In transport mode, only the data
you transfer (payload) in the IPv6 packet is encrypted and/or authenticated and only the payloads that are
originated and destined between two intermediate systems are processed with IPsec. In tunnel mode, the
entire IPv6 packet with both the data and the message headers is encrypted and/or authenticated. In tunnel
mode, all the IPv6 packets that passess through the endpoints are processed by IPsec. The current
implementation of IPsec supports only the transport mode.

Note. The current implementation of IPsec supports only IPv6.

The pre-configured Security Policy determines the traffic that is to be rendered with IPsec protection. A
Security Association (SA) specifies the actual IPsec actions to be performed (e.g encryption using 3DES,
authentication with HMAC-SHA1). A security association is bundle of algorithms and parameters (such as
keys) that is being used to encrypt and authenticate a particular flow in one direction. Security
Associations can be manually configured or negotiated through IKE. The current implementation of IPsec
does not support the negotiation of SA through IKE and SAs need to be configured manually.
A summary of the available commands is listed here:

ipsec key
ipsec security-key
ipsec policy
ipsec policy rule
ipsec sa
show ipsec policy
show ipsec sa
show ipsec key
show ipsec ipv6 statistics

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 18-1
ipsec key IPsec commands

ipsec key
Adds, modifies or deletes the authentication and encryption keys for a manually configured IPsec SA.
ipsec key name {sa-authentication | sa-encryption} [encrypted] key
no ipsec key name {sa-authentication | sa-encryption}

Syntax Definitions

name The name of this key (maximum 20 characters).

sa-authentication Indicates that the key value is used for Authentication Header.
sa-encryption Indicates that the key value is used for Encapsulated Security Payload.
encrypted Not user configured, used only by switch in config file.
key Specifies the key value. The key value can be either in the hexadecimal
format or as a string.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The name parameter must be same as the name of the manually configured SA that uses this SA
authentication and encryption key.
• The length of the key value must match the value that is required by the encryption or authentication
algorithm that uses the key. The required key length for the supported algorithm are as follows:

algorithm key length

3des-cbc 192 bits
aes-cbc 128, 192, or 256 bits
hmac-md5 128 bits
hmac-sha1 160 bits
aes-xcbc-mac 128

• The combination of the key's name and type must be unique.

• The encrypted option is used when the key commands are written to the vcboot.cfg or other snapshot
file. This option can not be specified by the user when entering CLI commands.

Examples
-> ipsec key sa_md5_in sa-authentication takd03c9@skL68L%

page 18-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPsec commands ipsec key

Release History
Release 8.1.1; command introduced.

Related Commands

ipsec sa Adds, modifies, or deletes a manually configured IPsec Security

Association (SA).
show ipsec key Displays the keys for the manually configured IPsec SA.

MIB Objects
AlaIPsecKeyTable
alaIPsecKeyName
alaIPsecKeyType
alaIPsecKeyEncrypted
alaIPsecKey

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 18-3
ipsec security-key IPsec commands

ipsec security-key
Sets the master security key for the switch. The master security key is used to encrypt and decrypt the
configured SA keys.
ipsec security-key [old_key] new_key

Syntax Definitions

old_key The current master security key. The key can be specified either in the
hexadecimal format or as a string.
new_key The new key value. The key can be specified either in the hexadecimal
format or as a string.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The old_key parameter must always be specified when you modify an existing key. Setting the key for
first time does not require the old_key.
• If the value of the old_key is incorrect, the attempt to set a new key fails.

• While the SA keys can be configured without a master security key; the configured SA keys are
written to the configuration file unencrypted, and a warning is logged.
• The security key must be 16 characters or 16 bytes if in hex form (32 hex digits).

• If the master security key is reset using debug clear ipsec security key command, the currently config-
ured SA keys are deleted.

Examples
-> ipsec security-key “old key value ab” 0xa38d901bde77af091a2485ce0a14a8cc

Release History
Release 8.1.1; command introduced.

page 18-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPsec commands ipsec security-key

Related Commands

ipsec key Adds, modifies or deletes the authentication and encryption keys for
a manually configured IPsec SA.

MIB Objects
AlaIPsecSecurityKeyTable
alaIPsecSecurityKeyCurrent
alaIPsecSecurityKeyNew

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 18-5
ipsec policy IPsec commands

ipsec policy
Adds, modifies, or removes a security policy.
ipsec policy name [priority priority] [source {ipv6_address [/prefix_length]} [port port]] [destination
{ipv6_address [/prefix_length]} [port port]] [protocol {any | icmp6 [type type]| tcp | udp | ospf | vrrp |
number protocol}] [in | out] [discard | ipsec | none] [description description] [admin-state {enable |
disable}]
no ipsec policy name

Syntax Definitions

name The name for the policy

priority The priority for the policy. Values may range from 1 to 1000. The lower
the value, the higher the priority.
source ipv6_address Specifies the source address of the IPv6 traffic that is covered by the
policy.
source /prefix_length Specifies the prefix length of the source address of the IPv6 traffic that
is covered by the policy.
source port Specifies the source port of the IPv6 traffic that is covered by the policy.
The value 0 can be specified to match packets originated from any port.
destination ipv6_address Specifies the destination address of the IPv6 traffic that is covered by
the policy.
destination /prefix-length Specifies the prefix length of the destination address of the IPv6 traffic
that is covered by the policy.
destination port Specifies the destination port of the IPv6 traffic that is covered by the
policy. The value 0 can be specified to match packets destined to any
port.
protocol Specifies that the particular protocol specific traffic to be covered by the
policy (Refer to the table in the “Usage Guidelines“ section below for
various protocol options).
in Specifies that the policy is applied to the inbound IPv6 traffic.
out Specifies that the policy is applied to the outbound IPv6 traffic.
discard Specifies the policy to discard the IPv6 packet, if it matches the criteria.
ipsec Specifies the policy to send the IPv6 packet for IPsec processing, if it
matches the criteria.
none Specifies IPsec should not process the packet.
description The detailed description of the policy.
admin-state enable Administratively enables the policy.
admin-state disable Administratively disables the policy.

page 18-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPsec commands ipsec policy

Defaults

parameter default
priority 100
port 0
any | icmp6 | tcp | udp | ospf | any
vrrp | number
icmp6 type not present
discard | ipsec | none ipsec
admin-state enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If two policies can cover the same traffic, the policy with the highest priority is applied. If two policies
have the same priority, the one configured first has precedence.
• The following table lists the various protocol options in this command:

protocol
any
icmp6[type type]
tcp
udp
ospf
vrrp
number protocol

The any option must be used to apply the policy to all protocol traffic. Otherwise, an upper-layer
protocol (or protocol number) may be specified to restrict the policy to the specified protocol traffic.
The optional type parameter of icmp6 can also be specified to restrict the policy for certain type of
ICMPv6 packets.
• If the ipsec option is specified this policy cannot be enabled until at least one rule has been defined.
The policy rules specify that IPsec algorithms be applied to the traffic that matches the policy.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 18-7
ipsec policy IPsec commands

Examples
-> ipsec policy tcp_out source 2001:db8:3::12 destination 201:db8:4::a3e protocol
tcp out ipsec description “Outbound TCP traffic” admin-state disable
-> no ipsec policy tcp_out

Release History
Release 8.1.1; command introduced.

Related Commands

ipsec policy rule Adds, modifies, or removes an IPsec rule for a security policy.
show ipsec policy Displays information about the security policies.

MIB Objects
AlaIPsecSecurityPolicyTable
alaIPsecSecurityPolicyName
alaIPsecSecurityPolicyPriority
alaIPsecSecurityPolicySource
alaIPsecSecurityPolicySourceType
alaIPsecSecurityPolicySourcePrefixLength
alaIPsecSecurityPolicySourcePort
alaIPsecSecurityPolicyDestination
alaIPsecSecurityPolicyDestinationType
alaIPsecSecurityPolicyDestinationPrefixLength
alaIPsecSecurityPolicyDestinationPort
alaIPsecSecurityPolicyULProtocol
alaIPsecSecurityPolicyICMPv6Type
alaIPsecSecurityPolicyDirection
alaIPsecSecurityPolicyAction
alaIPsecSecurityPolicyDescription
alaIPsecSecurityPolicyAdminState

page 18-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPsec commands ipsec policy rule

ipsec policy rule

Adds, modifies, or removes an IPsec rule for a security policy.
ipsec policy name rule index [ah | esp]
no ipsec policy name

Syntax Definitions

name The name of the security policy created by using the ipsec policy
command.
index The index of this rule. Values may range from 1 to 10.
ah Specifies that the rule requires the presence of an Authentication Header
(AH).
esp Specifies that the rule requires the presence of an Encrypted Security
Payload header (ESP).

Defaults
N/A.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
You can use the index parameter to specify the order in which the multiple rules for the same security
policy is applied to the original layload.

Examples
-> ipsec policy alucent rule 1 ah
-> no ipsec policy alucent

Release History
Release 8.1.1; command introduced.

Related Commands

ipsec policy Adds, modifies, or removes a security policy.

MIB Objects
AlaIPsecSecurityPolicyRuleTable
alaIPsecSecurityPolicyName
alaIPsecSecurityPolicyRuleIndex
alaIPsecSecurityPolicyRuleProtocol

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 18-9
ipsec sa IPsec commands

ipsec sa
Adds, modifies, or deletes a manually configured IPsec Security Association (SA).
ipsec sa name {esp | ah} [source ipv6_address ] [destination ipv6_address] [spi spi] [encryption {null |
3des-cbc | aes-cbc [key-size key_length]}] [authentication {none | hmac-md5 | hmac-sha1 | aes-xcbc-
mac}] [description description] [admin-state {enable | disable}]
no ipsec sa name

Syntax Definitions

name The name assigned to this IPsec SA.

esp Specifies the type of security association as ESP.
ah Specifies the type of security association as AH.
source ipv6_address Specifies the source address of the IPv6 traffic that is covered by the
SA.
destination ipv6_address Specifies the destination address of the IPv6 traffic that is covered by
the SA.
spi The Security Parameters Index (SPI) for the SA.
encryption Specifies the encryption algorithm to be used for traffic covered by the
SA. This parameter must be used only when the SA type is ESP.
key_length key length for the specified encryption algorithm.
authentication Specifies the authentication algorithm to be used for traffic covered by
the SA.
description The detailed description of the SA.
admin-state enable Administratively enables the SA.
admin-state disable Administratively disables the SA.

Defaults

parameter Defaults
encryption none
authentication none
admin-state enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The encryption parameter must be specified with the none option, if ESP is being used to verify integ-
rity only.

page 18-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPsec commands ipsec sa

• If null is specified as the option for encryption, an integrity algorithm must be specified using the
authentication parameter.
• To override a default key length in an encryption algorithm, the key length must be specified after the
protocol name.The key length supported for various algorithm are as follows:

encryption algorithm key length (in bits)

aes-cbc 128(default), 192, and 256

• For AH SAs, one of the authentication algorithms such as aes-xcbc-mac, hmac-md5 or hmac-sha1
must be specified.

Examples
-> ipsec sa esp_in_1 esp source 2001:db8:3::13d destination 2001:db8:1::24 spi
10392 encryption aes-cbc authentication hmac-sha1
-> no ipsec sa esp_in_1

Release History
Release 8.1.1; command introduced.

Related Commands

show ipsec sa Displays information about manually configured IPsec Security

Associations.

MIB Objects
AlaIPsecSAConfigTable
alaIPsecSAConfigName
alaIPsecSAConfigType
alaIPsecSAConfigSource
alaIPsecSAConfigSourceType
alaIPsecSAConfigDestination
alaIPsecSAConfigDestinationType
alaIPsecSAConfigSPI
alaIPsecSAConfigEncryptionAlgorithm
alaIPsecSAConfigEncryptionKeyLength
alaIPsecSAConfigAuthenticationAlgorithm
alaIPsecSAConfigDescription
alaIPsecSAConfigAdminState

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 18-11
show ipsec policy IPsec commands

show ipsec policy

Displays information about the security policies.
show ipsec policy [name]

Syntax Definitions

name The policy name.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the name parameter to display information about a specific security policy.

Examples
-> show ipsec policy
Name Source-> Destination Protocol Direction Action State
------------+--------------------------------+--------+----------+--------+--------
ftp-in-drop ::/0->2001:db8:3::13d TCP in discard active
telnet-in-1 2001:db8::/48->2001:db8:1::24 TCP in ipsec active
telnet-out-1 2001:db8:1::24->2001:db8::/48 TCP out ipsec active

output definitions
Name The name of the security policy.
Source -> Destination Indicates the source and destination of traffic covered by this policy.
Protocol Indicates the protocol traffic covered by this policy. The protocol name
(TCP) or protocol number (80) is displayed in this field.
Direction Indicates whether the policy has been applied to the incoming or
outgoing traffic.
Action Indicates the action to be taken on the traffic covered by this policy.
State Indicates the operational state of this policy.

-> show ipsec policy telnet-out-1

Name = telnet-out-1
Source = 2001:db8:1::24
Destination = 2001:db8::/48
Protocol = TCP
Direction = out
Action = ipsec
State = active
Rules:
1) esp

page 18-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPsec commands show ipsec policy

2) ah
Description:
Require AH and ESP headers on outgoing telnet traffic.

output definitions
Name The name of the security policy.
Source Indicates the source of the traffic covered by this policy.
Destination Indicates the destination of the traffic covered by this policy.
Protocol Indicates the protocol traffic covered by this policy. The protocol name
(TCP) or protocol number (80) is displayed in this field.
Direction Indicates whether the policy has been applied to the incoming or
outgoing traffic.
Action Indicates the action to be taken on the traffic covered by this policy.
State Indicates the operational state of this policy.
Rules Indicates the rules specified for this policy.
Description The description for this policy.

Release History
Release 8.1.1; command introduced.

Related Commands

ipsec policy Adds, modifies, or removes a security policy.

MIB Objects
AlaIPsecSecurityPolicyTable
alaIPsecSecurityPolicyName
alaIPsecSecurityPolicySource
alaIPsecSecurityPolicySourceType
alaIPsecSecurityPolicySourcePrefixLength
alaIPsecSecurityPolicySourcePort
alaIPsecSecurityPolicyDestination
alaIPsecSecurityPolicyDestinationType
alaIPsecSecurityPolicyDestinationPrefixLength
alaIPsecSecurityPolicyDestinationPort
alaIPsecSecurityPolicyProtocol
alaIPsecSecurityPolicyDirection
alaIPsecSecurityPolicyAction
alaIPsecSecurityPolicyOperationalState
alaIPsecSecurityPolicyRuleIndex
alaIPsecSecurityPolicyRuleProtocol
alaIPsecSecurityPolicyDescription

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 18-13
show ipsec sa IPsec commands

show ipsec sa
Displays information about manually configured IPsec Security Associations.
show ipsec sa [name | esp | ah]

Syntax Definitions

name The name of the Security Association.

esp Restricts the display to ESP type SAs.
ah Restricts the display to AH type SAs.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the name parameter to display the information about a specific SA.

• Use esp or ah option to display the information about their respective type SAs.

Examples
-> show ipsec sa
Name Type Source-> Destination[SPI] State Encryption
Authentication
--------------+----+-----------------------------------+--------+----------------
telnet-in-esp ESP 2001:db8::/49->2001:db8:1::24 active aes-cbc(128)
hmac-sha1
telnet-out-esp ESP 2001:db8:1::24->2001:db8::/48 active aes-cbc(128)
hmac-sha1

output definitions
Name The SA name.
Type The SA type: AH or ESP.
Source -> Destination [SPI] The traffic source, traffic destination, and SPI for this SA.
State The operational state of this SA.
Encryption The encryption algorithm used for this SA.
Authentication The authentication algorithm in use for this SA.

page 18-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPsec commands show ipsec sa

-> show ipsec sa telnet-in-esp

Name = telnet-in-esp
Type = ESP
Source = 2001:db8::/48
Destination = 2001:db8:1::24
SPI = 8920
Encryption = aes-cbc(128)
Authentication = hmac-sha1

State = active
Description:
Security association for traffic from 2001:db8::/48 to
2001:db8:1::24.

output definitions
Name The SA name.
Type The SA type: AH or ESP.
Source The traffic source for this SA.
Destination The traffic destination for this SA.
SPI The SA's SPI.
Encryption The encryption algorithm used for this SA.
Authentication The authentication algorithm used for this SA.
State The operational state of this SA.
Description The SA's description.

Release History
Release 8.1.1; command introduced.

Related Commands

ipsec sa Adds, modifies, or deletes a manually configured IPsec Security

Association (SA).

MIB Objects
AlaIPsecSAConfigTable
alaIPsecSAConfigName
alaIPsecSAConfigType
alaIPsecSAConfigSource
alaIPsecSAConfigSourceType
alaIPsecSAConfigDestination
alaIPsecSAConfigDestinationType
alaIPsecSAConfigSPI
alaIPsecSAConfigOperationalState
alaIPsecSAConfigEncryptionAlgorithm
alaIPsecSAConfigEncryptionKeyLength
alaIPsecSAConfigAuthenticationAlgorithm
alaIPsecSAConfigAuthenticationKeyLength
alaIPsecSAConfigDescription

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 18-15
show ipsec key IPsec commands

show ipsec key

Displays the keys for the manually configured IPsec SA.
show ipsec key [sa-encryption | sa-authentication]

Syntax Definitions

sa-encryption Displays the encryption keys.

sa-authentication Displays the authentication keys.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The key values are not be displayed due to security reasons.

Examples
-> show ipsec key sa-encryption
Encryption Keys
Name Length (bits)
--------------------+-------------
sa_1 192
sa_2 160
sa_3 64

-> show ipsec key sa-authentication

Authentication Keys
Name Length (bits)
--------------------+-------------
sa_1 128
sa_5 160

output definitions
Name The name of the SA for which the key is used.
Length The length of the key in bits.

Release History
Release 8.1.1; command introduced.

page 18-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPsec commands show ipsec key

Related Commands

ipsec key Adds, modifies or deletes the authentication and encryption keys for
a manually configured IPsec SA.

MIB Objects
AlaIPsecKeyTable
alaIPsecKeyName
alaIPsecKey

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 18-17
show ipsec ipv6 statistics IPsec commands

show ipsec ipv6 statistics

Displays IPsec statistics.
show ipsec ipv6 statistics

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
Inbound:
Discarded = 2787
Policy violation = 0
Authentication Failure = 0
No SA found = 0
Outbound:
Discarded = 5135
No SA found = 19

output definitions
Discarded The number of incoming packets discarded because they matched a
discard policy.
Policy violation The number of incoming packets that don’t have the IPsec protection
required by a security policy.
Authentication Failure Authentication of a packet failed.
No SA found No SA found matching the information present in a packet.

Release History
Release 8.1.1; command introduced.

Related Commands
N/A

page 18-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IPsec commands show ipsec ipv6 statistics

MIB Objects
AlaIPsecStatisticsTable
alaIPsecStatisticsInDiscarded
alaIPsecStatisticsInPolicyViolation
alaIPsecStatisticsInAHAuthenticationFail
alaIPsecStatisticsInNoSA
alaIPsecStatisticsOutDiscarded
alaIPsecStatisticsOutPolicyViolation
alaIPsecStatisticsOutNoSA

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 18-19
show ipsec ipv6 statistics IPsec commands

page 18-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 19 RIP Commands

Routing Information Protocol (RIP) is an Interior Gateway Protocol (IGP) that uses hop count as its rout-
ing metric. RIP-enabled switches update neighboring switches by transmitting a copy of their own routing
table. The RIP routing table always uses the most efficient route to a destination, that is, the route with the
fewest hops and longest matching prefix.
The switch supports RIP version 1 (RIPv1), RIP version 2 (RIPv2), and RIPv2 that is compatible with
RIPv1. It also supports simple and MD5 authentication, on an interface basis, for RIPv2.
The RIP commands comply with the following RFCs: RFC1058, RFC2453, RFC1722, RFC1723, and
RFC1724.
MIB information for the RIP commands is as follows:
Filename: RIPv2.mib
Module: rip2
Filename: AlcatelIND1Rip.mib
Module: alaRipMIB
A summary of the available commands is listed here:

ip load rip
ip rip admin-state
ip rip interface
ip rip interface admin-state
ip rip interface metric
ip rip interface send-version
ip rip interface recv-version
ip rip interface ingress-filter
ip rip interface egress-filter
ip rip force-holddowntimer
ip rip host-route
ip rip route-tag
ip rip interface auth-type
ip rip interface auth-key
ip rip update-interval
ip rip invalid-timer
ip rip garbage-timer
ip rip holddown-timer
show ip rip
show ip rip routes
show ip rip interface
show ip rip peer

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 19-1
ip load rip RIP Commands

ip load rip
Loads RIP into memory. When the switch is initially configured, you must load RIP into memory before it
can be enabled.
ip load rip

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• In simple networks where only IP forwarding is required, you may not want to use RIP. If you are not
using RIP, it is best not to load it to save switch resources.
• To remove RIP from switch memory, you must manually edit the vcboot.cfg file. The vcboot.cfg file
is an ASCII text-based file that controls many of the switch parameters. Open the file and delete all
references to RIP. You must reboot the switch when this is complete.
• Use the ip rip admin-state command to enable RIP on the switch.

Examples
-> ip load rip

Release History
Release 8.1.1; command introduced.

Related Commands

ip rip admin-state Enables/disables RIP routing on the switch.

show ip rip Displays the RIP status and general configuration parameters (e.g.,
forced hold-down timer).

MIB Objects
alaDrcTmConfig
alaDrcTmIPRipStatus

page 19-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
RIP Commands ip rip admin-state

ip rip admin-state
Enables/disables RIP on the switch. RIP performs well in small networks. By default, RIP packets are
broadcast every 30 seconds, even if no change has occurred anywhere in a route or service. Depending on
the size and speed of the network, these periodic broadcasts can consume a significant amount of band-
width.
ip rip admin-state {enable | disable}

Syntax Definitions

enable Enables RIP routing on the switch.

disable Disables RIP routing on the switch.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• RIP must be loaded on the switch (ip load rip) to enable RIP on the switch.

• A RIP network can be no more than 15 hops (end-to-end). If there is a 16th hop, that network is
identified as infinity and the packet is discarded.

Examples
-> ip rip admin-state enable

Release History
Release 8.1.1; command introduced.

Related Commands

ip load rip Loads RIP into the switch memory.

show ip rip Displays the RIP status and general configuration parameters (e.g.,
forced hold-down timer).

MIB Objects
alaProtocolRip
alaRipProtoStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 19-3
ip rip interface RIP Commands

ip rip interface
Creates/deletes a RIP interface. Routing is enabled on a VLAN when you create a router interface.
However, to enable RIP routing, you must also configure and enable a RIP routing interface on the
VLAN’s IP router interface.
ip rip interface {interface_name}
no ip rip interface {interface_name}

Syntax Definitions

interface_name The name of the interface.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• By default, a RIP interface is created in the disabled state. To enable RIP routing on the interface, you
must enable the interface by using the ip rip interface admin-state command.
• You can create a RIP interface even if an IP router interface has not been configured. However, RIP
will not function unless an IP router interface is configured with the RIP interface.
• For more information on VLANs and router ports, see Chapter 5, “VLAN Management Commands”.

Examples
-> ip rip interface rip-1

Release History
Release 8.1.1; command introduced.

page 19-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
RIP Commands ip rip interface

Related Commands

ip interface Creates a VLAN router interface.

ip load rip Loads RIP into memory. When the switch is initially configured,
you must load RIP into memory before it can be enabled.
ip rip admin-state Enables/disables RIP routing on the switch.
ip rip interface admin-state Enables/disables a RIP interface.

MIB Objects
rip2IfConfTable
rip2IfConfAddress
rip2IfConfStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 19-5
ip rip interface admin-state RIP Commands

ip rip interface admin-state

Enables/disables a RIP interface. By default, a RIP interface is created in the disabled state. After creating
a RIP interface, you must use this command to enable the interface.
ip rip interface {interface_name} admin-state {enable | disable}

Syntax Definitions

interface_name The name of the interface.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• You must first create a RIP interface by using the ip rip interface command before enabling the inter-
face.
• You can create a RIP interface even if an IP router interface has not been configured. However, RIP
will not function unless an IP router interface is configured with the RIP interface.
• For more information on VLANs and router ports, see Chapter 5, “VLAN Management Commands”.

Examples
-> ip rip interface rip-1 admin-state enable

Release History
Release 8.1.1; command introduced.

page 19-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
RIP Commands ip rip interface admin-state

Related Commands

ip interface Creates a VLAN router interface.

ip load rip Loads RIP into memory. When the switch is initially configured,
you must load RIP into memory before it can be enabled.
ip rip admin-state Enables/disables RIP routing on the switch.
ip rip interface Creates/deletes a RIP interface.

MIB Objects
rip2IfConfTable
rip2IfConfAddress
rip2IfConfStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 19-7
ip rip interface metric RIP Commands

ip rip interface metric

Configures the RIP metric or cost for a specified interface. You can set priorities for routes generated by a
switch by assigning a metric value to routes generated by that switch’s RIP interface. For example, routes
generated by a neighboring switch may have a hop count of 1. However, you can lower the priority of
routes generated by that switch by increasing the metric value for routes generated by the RIP interface.
ip rip interface {interface_name} metric value

Syntax Definitions

interface_name The name of the interface.

value Metric value. Valid range is 1–15.

Defaults

parameter default
value 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
When you configure a metric for a RIP interface, this metric cost is added to the metric of the incoming
route.

Examples
-> ip rip interface rip-1 metric 2

Release History
Release 8.1.1; command introduced.

Related Commands

ip rip interface Enables/disables RIP on a specific interface.

show ip rip peer Displays active RIP neighbors (peers). An active peer is a switch
that has sent a RIP packet within the last 180 seconds.

MIB Objects
rip2IfConfTable
rip2IfConfAddress
rip2IfConfDefaultMetric

page 19-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
RIP Commands ip rip interface send-version

ip rip interface send-version

Configures the send option for a RIP interface. This defines the type(s) of RIP packets that the interface
will send.
ip rip interface {interface_name} send-version {none | v1 | v1compatible | v2}

Syntax Definitions

interface_name The name of the interface.

none RIP packets will not be sent by the interface.
v1 Only RIPv1 packets will be sent by the interface.
v1compatible Only RIPv2 broadcast packets (not multicast) will be sent by the inter-
face.
v2 Only RIPv2 packets will be sent by the interface.

Defaults

parameter default
none | v1 | v2 | v1compatible v2

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Using this command will override RIP default behavior.

• Other devices must be able to interpret the information provided by this command or there will not be
proper routing information exchanged between the switch and other devices on the network.

Examples
-> ip rip interface rip-1 send-version v1

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 19-9
ip rip interface send-version RIP Commands

Related Commands

ip rip interface recv-version Configures the receive option for a RIP interface.

MIB Objects
rip2IfConfTable
rip2IfConfAddress
rip2IfConfSend

page 19-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
RIP Commands ip rip interface recv-version

ip rip interface recv-version

Configures the receive option for a RIP interface. This defines the type(s) of RIP packets that the inter-
face will accept.
ip rip interface {interface_name} recv-version {v1 | v2 | both | none}

Syntax Definitions

interface_name The name of the interface.

v1 Only RIPv1 packets will be received by the interface.
v2 Only RIPv2 packets will be received by the interface.
both Both RIPv1 and RIPv2 packets will be received by the interface.
none Interface ignores any RIP packets received.

Defaults

parameter default
v1 | v2 | both | none both

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Using this command will override RIP default behavior.

• Other devices must be able to interpret the information provided by this command or there will not be
proper routing information exchanged between the switch and other devices on the network.

Examples
-> ip rip interface rip-1 recv-version both

Release History
Release 8.1.1; command introduced.

Related Commands

ip rip interface send-version Configures the send option for a RIP interface.

MIB Objects
rip2IfConfTable
rip2IfConfAddress
rip2IfConfReceive

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 19-11
ip rip interface ingress-filter RIP Commands

ip rip interface ingress-filter

Assigns an ingress route map filter to the specified RIP interface. Received route advertisements are
compared against ingress filters. When a prefix matches the corresponding filter, that prefix is accepted
on the interface. When a prefix does not match the filter, the prefix is dropped as if it was never received.
ip rip interface {interface_name} ingress-filter {filter_name}

Syntax Definitions

interface_name The name of an existing RIP interface.

filter_name The name of an existing route-map filter.

Defaults
By default, no such filter is associated with the RIP interface.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• One route-map filter is configurable in each direction (ingress/egress) for each RIP interface.

• Configuring multiple filters in the same direction for a single RIP interface is not supported.

Examples
-> ip route-map ripfilter1 action permit
-> ip route-map ripfilter1 match ip-address 202.5.0.0/16 deny
-> ip rip interface vlan-100 Ingress-filter RipFilter1

Release History
Release 8.1.1; command introduced.

Related Commands

ip rip interface egress-filter Assigns an egress route map filter to a RIP interface.
show ip rip interface Displays RIP interface status and configuration.

MIB Objects
N/A

page 19-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
RIP Commands ip rip interface ingress-filter

ip rip interface ingress-filter

Assigns an ingress route map filter to the specified RIP interface. Received route advertisements are
compared against ingress filters. When a prefix matches the corresponding filter, that prefix is accepted
on the interface. When a prefix does not match the filter, the prefix is dropped as if it was never received.
ip rip interface {interface_name} ingress-filter {filter_name}

Syntax Definitions

interface_name The name of an existing RIP interface.

filter_name The name of an existing route-map filter.

Defaults
By default, no such filter is associated with the RIP interface.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• One route-map filter is configurable in each direction (ingress/egress) for each RIP interface.

• Configuring multiple filters in the same direction for a single RIP interface is not supported.

Examples
-> ip route-map ripfilter1 action permit
-> ip route-map ripfilter1 match ip-address 202.5.0.0/16 deny
-> ip rip interface vlan-100 ingress-filter RipFilter1

Release History
Release 8.1.1; command introduced.

Related Commands

ip rip interface egress-filter Assigns an egress route map filter to a RIP interface.
show ip rip interface Displays RIP interface status and configuration.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 19-13
ip rip interface egress-filter RIP Commands

ip rip interface egress-filter

Assigns an egress route map filter to the specified RIP interface. Outbound route advertisements are
compared against egress filters. When a prefix matches the corresponding filter, that prefix is sent on the
interface. When a prefix does not match the filter, the prefix is dropped as if it did not exist in the RIP
RIB.
ip rip interface {interface_name} egress-filter {filter_name}

Syntax Definitions

interface_name The name of an existing RIP interface.

filter_name The name of an existing route-map filter.

Defaults
By default, no such filter is associated with the RIP interface.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• One route-map filter is configurable in each direction (ingress/egress) for each RIP interface.

• Configuring multiple filters in the same direction for a single RIP interface is not supported.

Examples
-> ip route-map ripfilter1 action permit
-> ip route-map ripfilter1 match ip-address 202.5.0.0/16 deny
-> ip rip interface vlan-100 egress-filter RipFilter1

Release History
Release 8.1.1; command introduced.

Related Commands

iip rip interface ingress-filter Assigns an ingress route map filter to a RIP interface.
show ip rip interface Displays RIP interface status and configuration.

MIB Objects
N/A

page 19-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
RIP Commands ip rip force-holddowntimer

ip rip force-holddowntimer
Configures the forced hold-down timer value, in seconds, that defines an amount of time during which
routing information regarding better paths is suppressed. A route enters into a forced hold-down state
when an update packet is received that indicates the route is unreachable and when this timer is set to a
non-zero value. After this timer has expired and if the value is less than 120 seconds, the route enters a
hold-down state for the rest of the period until the remainder of the 120 seconds has also expired. During
this time the switch will accept any advertisements for better paths that are received.
ip rip force-holddowntimer seconds

Syntax Definitions

seconds The forced hold-down time interval, in seconds. The valid range is 0–
120.

Defaults

parameter default
seconds 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The forced hold-down timer is not the same as the RIP hold-down timer. The forced hold-down timer
defines a separate interval that overlaps the hold-down state. During the forced hold-down timer inter-
val, the switch will not accept better routes from other gateways.
• The forced hold-down time interval can become a subset of the hold-down timer (120 seconds) by
using this command to set a value less than 120.
• To allow the routing switch to use better routes advertised during the entire hold-down time period,
leave the forced hold-down timer set to the default value.

Examples
-> ip rip force-holddowntimer 10

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 19-15
ip rip force-holddowntimer RIP Commands

Related Commands

show ip rip Displays the RIP status and general configuration parameters (for
example, forced hold-down timer).

MIB Objects
alaProtocolRip
alaRipForceHolddownTimer

page 19-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
RIP Commands ip rip host-route

ip rip host-route
Specifies whether or not RIP can add host routes (routes with a 32-bit mask) to the RIP table.
ip rip host-route
no ip rip host-route

Syntax Definitions

N/A

Defaults
The default is to enable a default host route.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to prevent RIP from adding host routes to the RIP table.

• When enabled, RIPv1 will interpret an incoming route announcement that contains any 1 bit in the host
portion of the IP address as a host route, implying a mask of 255.255.255.255.

Examples
-> ip rip host-route

Release History
Release 8.1.1; command introduced.

Related Commands

show ip rip routes Displays the RIP Routing Database.

MIB Objects
alaProtocolRip
alaRipHostRouteSupport

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 19-17
ip rip route-tag RIP Commands

ip rip route-tag
Configures the route tag value for RIP routes generated by the switch.
ip rip route-tag value

Syntax Definitions

value Route tag value. Valid range is 0–2147483647.

Defaults

parameter default
value 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Only RIPv2 supports route tags.

Examples
-> ip rip route-tag 0

Release History
Release 8.1.1; command introduced.

Related Commands
show ip rip Displays the RIP status and general configuration parameters (e.g.,
forced hold-down timer).

MIB Objects
alaRipRedistRouteTag

page 19-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
RIP Commands ip rip interface auth-type

ip rip interface auth-type

Configures the type of authentication that will be used for the RIP interface. By default, there is no authen-
tication used for RIP. However, you can configure a password for a RIP interface. To configure a pass-
word, you must first select the authentication type (simple or MD5), then configure a password.
ip rip interface {interface_name} auth-type {none | simple | md5}

Syntax Definitions

interface_name The name of the interface.

none No authentication will be used.
simple Simple authentication will be used.
md5 MD5 authentication will be used.

Defaults

parameter default
none | simple none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Regardless of which authentication type is used (simple or MD5), both switches on either end of a link
must share the same password.

Examples
-> ip rip interface rip-1 auth-type none

Release History
Release 8.1.1; command introduced.

Related Commands

ip rip interface auth-key Configures the text string that will be used as the password for the
RIP interface.

MIB Objects
rip2IfConfTable
rip2IfConfAddress
rip2IfConfAuthType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 19-19
ip rip interface auth-key RIP Commands

ip rip interface auth-key

Configures the text string that will be used as the password for the RIP interface. If you configure simple
or MD5 authentication, you must configure a text string that will be used as the password for the RIP
interface.
ip rip interface {interface_name} auth-key string

Syntax Definitions

interface_name The name of the interface.

string 16-byte text string.

Defaults
The default authentication string is a null string.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Regardless of which authentication type is used (simple or MD5), both switches on either end of a link
must share the same password.

Examples
-> ip rip interface rip-1 auth-key nms

Release History
Release 8.1.1; command introduced.

Related Commands

ip rip interface auth-type Configures the type of authentication that will be used for the RIP
interface.

MIB Objects
rip2IfConfTable
rip2IfConfAddress
rip2IfConfAuthKey

page 19-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
RIP Commands ip rip update-interval

ip rip update-interval
Configures the time interval during which RIP routing updates are sent out.
ip rip update-interval seconds

Syntax Definitions

seconds The RIP routing update interval, in seconds. The valid range is 1–120.

Defaults

parameter default
seconds 30

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The update interval value must be less than or equal to one-third the invalid interval value.

Examples
-> ip rip update-interval 45

Release History
Release 8.1.1; command introduced.

Related Commands

show ip rip Displays the RIP status and general configuration parameters (e.g.,
forced hold-down timer).

MIB Objects
alaProtocolRip
alaRipUpdateInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 19-21
ip rip invalid-timer RIP Commands

ip rip invalid-timer
Configures the RIP invalid timer value that defines the time interval during which a route will remain
active in Routing Information Base (RIB) before moving to the invalid state.
ip rip invalid-timer seconds

Syntax Definition

seconds The RIP invalid timer value, in seconds. The valid range is 3–360.

Defaults

parameter default
seconds 180

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The invalid time interval value must be three times the update interval value.

Examples
-> ip rip invalid-timer 270

Release History
Release 8.1.1; command introduced.

Related Commands

show ip rip Displays the RIP status and general configuration parameters (e.g.,
forced hold-down timer).

MIB Objects
alaProtocolRip
alaRipInvalidTimer

page 19-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
RIP Commands ip rip garbage-timer

ip rip garbage-timer
Configures the RIP garbage timer value that defines the time interval, which must elapse before an expired
route is removed from the RIB.
ip rip garbage-timer seconds

Syntax Definition

seconds The RIP garbage timer value, in seconds. The valid range is 0–180.

Defaults

parameter default
seconds 120

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
During the RIP garbage interval, the router advertises the route with a metric of INFINITY (i.e., 16 hops).

Examples
-> ip rip garbage-timer 180

Release History
Release 8.1.1; command introduced.

Related Commands

show ip rip Displays the RIP status and general configuration parameters (e.g.,
forced hold-down timer).

MIB Objects
alaProtocolRip
alaRipGarbageTimer

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 19-23
ip rip holddown-timer RIP Commands

ip rip holddown-timer
Configures the RIP hold-down timer value that defines the time interval during which a route remains in
the hold-down state.
ip rip holddown-timer seconds

Syntax Definition

seconds The hold-down time interval, in seconds. The valid range is 0–120.

Defaults

parameter default
seconds 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
When RIP detects a route with higher metric than the route in the RIB, the route with the higher metric
goes into the hold-down state. The route updates with a metric of INFINITY are rejected.

Examples
-> ip rip holddown-timer 10

Release History
Release 8.1.1; command introduced.

Related Commands

show ip rip Displays the RIP status and general configuration parameters (e.g.,
forced hold-down timer).

MIB Objects
alaProtocolRip
alaRipHolddownTimer

page 19-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
RIP Commands show ip rip

show ip rip
Displays the RIP status and general configuration parameters (e.g., forced hold-down timer).
show ip rip

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip rip

Status = Enabled
Number of routes = 9
Host Route Support = Enabled
Route Tag = 42
Update interval = 30
Invalid interval = 180
Garbage interval = 120
Holddown interval = 0
Forced Hold-Down Timer = 0

output definitions
Status RIP status (Enabled or Disabled).
Number of routes Number of network routes in the RIP routing table.
Host Route Support Host route status (Enabled or Disabled). Indicates whether or not RIP
can add host routes (routes with a 32-bit mask) to the RIP table.
Route Tag Route tag value for RIP routes generated by the switch. Valid values are
0–2147483647.
Update interval The RIP routing update interval, in seconds.
Invalid interval The RIP invalid timer value, in seconds.
Garbage interval The RIP garbage timer value, in seconds.
Holddown interval The hold-down time interval, in seconds.
Forced Hold-Down Timer The forced hold-down time interval, in seconds.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 19-25
show ip rip RIP Commands

Release History
Release 8.1.1; command introduced.

Related Commands

ip rip admin-state Enables/disables RIP routing on the switch.

ip rip force-holddowntimer Configures the interval during which a RIP route remains in the
forced hold-down state.
ip rip update-interval Configures the time interval during which RIP routing updates are
sent out.
ip rip invalid-timer Configures the RIP invalid timer value that defines the time interval
during which a route will remain active in Routing Information
Base (RIB) before moving to the invalid state.
ip rip garbage-timer Configures the RIP garbage timer value that defines the time inter-
val, which must elapse before an expired route is removed from the
RIB.
ip rip holddown-timer Configures the RIP hold-down timer value that defines the time
interval during which a route remains in the hold down state.

MIB Objects
alaProtocolRip
alaRipProtoStatus
alaRipRouteNumber
alaRipHostRouteSupport
alaRipRedistRouteTag
alaRipUpdateInterval
alaRipInvalidTimer
alaRipGarbageTimer
alaRipHolddownTimer
alaRipForceHolddownTimer

page 19-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
RIP Commands show ip rip routes

show ip rip routes

Displays the RIP routing database. The routing database contains all of the routes learned through RIP.
show ip rip routes [ip_address ip_mask]

Syntax Definitions

ip_address 32-bit IP address.

ip_mask The mask corresponding to the IP address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
To view all RIP routes, enter the basic command syntax (show ip rip routes). To view a specific route,
enter the destination IP address and mask.

Examples
-> show ip rip routes

Legends: State: A = Active, H = Holddown, G = Garbage

Destination Gateway State Metric Proto
------------------+-----------------+----+------+------
2.0.0.0/8 +5.0.0.14 A 2 Rip
4.0.0.7 A 3 Rip
4.0.0.0/8 +5.0.0.14 A 3 Rip
2.0.0.14 A 3 Rip
5.0.0.0/8 +2.0.0.14 A 2 Rip
4.0.0.7 A 3 Rip
10.0.0.0/8 +4.0.0.7 A 2 Rip
5.0.0.14 A 2 Rip
2.0.0.14 A 2 Rip
22.0.0.0/8 +5.0.0.14 A 2 Rip
2.0.0.14 A 2 Rip
4.0.0.7 A 3 Rip
128.251.40.0/24 +4.0.0.7 A 2 Rip
5.0.0.14 A 3 Rip
2.0.0.14 A 3 Rip
150.0.0.0/24 +4.0.0.7 A 2 Rip
5.0.0.14 A 2 Rip
2.0.0.14 A 2 Rip
152.0.0.0/24 +4.0.0.7 A 2 Rip
5.0.0.14 A 3 Rip

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 19-27
show ip rip routes RIP Commands

output definitions
Destination Destination network IP address.
Gateway The Gateway IP address (switch from which the destination address
was learned).
State The associated state of the route, which can be A (Active), H
(Holddown), or G (Garbage).
Metric Metric associated with this network. Generally, this is the RIP hop
count (the number of hops from this switch to the destination switch).
Proto The type of route (Local, Rip, or Redist).

-> show ip rip routes 2.0.0.0 255.0.0.0

Destination = 2.0.0.0,
Mask length = 8,
Gateway(1) = 5.0.0.14,
Protocol = Rip,
Out Interface = intf5,
Metric = 2,
Status = Installed,
State = Active,
Age = 19s,
Tag = 0,
Gateway(2) = 4.0.0.7,
Protocol = Rip,
Out Interface = intf4,
Metric = 3,
Status = Not Installed,
State = Active,
Age = 12s,
Tag = 0,

output definitions
Destination Destination network IP address.
Mask length Length of the destination network IP subnet mask.
Gateway The Gateway IP address (switch from which the destination address
was learned).
Protocol The type of the route (Local, Rip, or Redist).
Out Interface The RIP interface through which the next hop is reached.
Metric Metric associated with this network. Generally, this is the RIP hop
count (the number of hops from this switch to the destination switch).
Status The RIP interface status (Installed or Not Installed).
State The associated state of the route (Active, Holddown, or Garbage).
Age The age of the route in seconds (the number of seconds since this route
was last updated or otherwise determined to be correct).
Tag The associated route tag.

page 19-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
RIP Commands show ip rip routes

Release History
Release 8.1.1; command introduced.

Related Commands

ip rip host-route Enables/disables a host route to an individual host on a network.

MIB Objects
alaRipEcmpRouteTable
alaRipEcmpRouteDest
alaRipEcmpRouteMask
alaRipEcmpRouteNextHop
alaRipEcmpRouteType
alaRipEcmpMetric
alaRipEcmpStatus
alaRipEcmpAge
alaRipEcmpTag
alaRipEcmpRouteState
alaRipEcmpRouteStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 19-29
show ip rip interface RIP Commands

show ip rip interface

Displays RIP interface status and configuration.
show ip rip interface [interface_name]

Syntax Definitions

interface_name The interface name.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Enter an IP address to view a specific interface. Enter the basic show ip rip interface command to show
status for all interfaces.

Examples
-> show ip rip interface rip-1

Interface IP Name = rip-1,

Interface IP Address = 11.11.11.1
IP Interface Number (VLANId) = 4,
Interface Admin status = enabled,
IP Interface Status = enabled,
Interface Config AuthType = None,
Interface Config AuthKey Length = 0,
Interface Config Send-Version = v2,
Interface Config Receive-Version = both,
Interface Config Default Metric = 1,
Received Packets = 154,
Received Bad Packets = 0,
Received Bad Routes = 0,
Sent Updates = 8

output definitions
Interface IP Name The IP Interface name.
Interface IP Address Interface IP address.
IP Interface Number Interface VLAN ID number.
Interface Admin Status The RIP administrative status (enabled/disabled).
IP Interface Status Interface status (enabled /disabled).
Interface Config AuthType The type of authentication that will be used for the RIP interface (None
or Simple).

page 19-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
RIP Commands show ip rip interface

output definitions (continued)

Interface Config AuthKey The authentication key length used for the RIP interface.
Length
Interface Config Send-Version Interface send option (none, v1, v2, and v1 compatible).
Interface Config Receive-Ver- Interface receive option (none, v1, v2, and both).
sion
Interface Config Default Met- Default redistribution metric.
ric
Received Packets Number of packets received on the interface.
Received Bad Packets Number of bad packets received and discarded. Normally this value is
zero (0).
Received Bad Routes Number of bad routes received and discarded. Normally this value is
zero (0).
Sent Updates Number of RIP routing table updates sent.

Release History
Release 8.1.1; command introduced.

Related Commands

ip rip interface Enables/disables RIP for a specific interface.

MIB Objects
alaProtocolRip
alaRipProtoStatus
alaRip2IfConfAugTable
alaRip2IfConfName
alaRip2IfRecvPkts
alaRip2IfIpConfStatus
rip2IfConfTable
rip2IfConfAddress
rip2IfConfAuthType
rip2IfConfAuthKey
rip2IfConfSend
rip2IfConfReceive
rip2IfConfDefaultMetric
rip2IfStatTable
rip2IfStatRcvBadPackets
rip2IfStatRcvBadRoutes
rip2IfStatSentUpdates

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 19-31
show ip rip peer RIP Commands

show ip rip peer

Displays active RIP neighbors (peers). An active peer is a switch that has sent a RIP packet within the last
180 seconds. If a peer does not send a RIP packet (request or response) within 180 seconds, it is aged out
and will not be displayed.
show ip rip peer [ip_address]

Syntax Definitions

ip_address 32-bit IP address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip rip peer

Total Bad Bad xxxxxxxxxxxxSecs since

IP Address Recvd Packets Routes Version last update
----------------+------+-------+------+-------+-----------
100.10.10.1 1 0 0 2 3

output definitions
IP Address Peer IP address.
Total recvd Total number of RIP packets received from the peer.
Bad Packets Number of bad packets received from peer.
Bad Routes Number of bad routes received from peer.
Version Peer's RIP version as seen on the last packet received.
Secs since last update Number of seconds since the last packet was received from the peer.

Release History
Release 8.1.1; command introduced.

page 19-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
RIP Commands show ip rip peer

Related Commands

show ip rip interface Displays the RIP interface status and configuration.

MIB Objects
rip2PeerTable
rip2PeerAddress
rip2PeerDomain
rip2PeerLastUpdate
rip2PeerVersion
rip2PeerRcvBadPackets
rip2PeerRcvBadRoutes

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 19-33
show ip rip peer RIP Commands

page 19-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 20 BFD Commands

Bidirectional Forwarding Detection (BFD) is a hello protocol, which can be configured to interact with
routing protocols for the detection of path failures and can reduce the convergence time in a network. BFD
is supported with the BGP, OSPF, VRRP, and Static Routes.
When BFD is configured and enabled, BFD sessions are created and timers are negotiated between BFD
neighbors. If a system does not receive a BFD control packet within the negotiated time interval, the
neighbor system is considered down. Rapid failure detection notices are then sent to the routing protocol,
which initiates a routing protocol recalculation. This process can reduce the time of convergence in a
network.
BFD can be operated in two different modes: Asynchronous mode with Echo enabled and Echo-Only
mode. Demand mode is not supported.
In Asynchronous mode, the systems continuously send BFD control packets between each other as part of
a BFD session. If there are no packets received for a minimum time interval negotiated between the
systems, then the neighbor system is considered down.
In Echo mode, a stream of BFD echo packets are transmitted in a forwarding path for which the
neighboring system would loop the packets and send them back. If the number of packets transmitted is
not echoed back, then the system is declared down. Echo mode can be operated along with Asynchronous
mode.
MIB information for the BFD commands is as follows:
Filename: ALCATEL-IND1-BFD-MIB
Module: ALCATEL-IND-BFD-MIB
A summary of the available commands is listed here:

Global BFD commands ip bfd admin-state

ip bfd transmit
ip bfd receive
ip bfd multiplier
ip bfd echo-interval
ip bfd interface
show ip bfd
show ip bfd sessions
show ip bfd sessions statistics

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 20-1
 BFD Commands

BFD Interface commands ip bfd interface

ip bfd interface admin-state
ip bfd interface transmit
ip bfd interface receive
ip bfd interface multiplier
ip ospf bfd-state
ip bfd interface echo-interval
show ip bfd interfaces
Commands to configure BFD ip ospf bfd-state
supported protocols ip ospf bfd-state all-interfaces
ip ospf interface bfd-state
ip ospf interface bfd-state drs-only
ip ospf interface bfd-state all-neighbors
ip bgp bfd-state
ip bgp bfd-state all-neighbors
ip bgp neighbor bfd-state
vrrp bfd-state
vrrp track address bfd-state
ip static-route all bfd-state
ip static-route bfd-state

page 20-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BFD Commands ip bfd admin-state

ip bfd admin-state
Enables or disables the global BFD protocol status for the switch.
ip bfd admin-state {enable | disable}

Syntax Definitions

enable Enables BFD.

disable Disables BFD.

Defaults
By default, BFD is disabled for the switch.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Disabling BFD does not remove the existing BFD configuration from the switch.

• When BFD is disabled, all BFD functionality is disabled for the switch, but configuring BFD is still
allowed.
• Configuring BFD global parameters is not allowed when BFD is enabled for the switch.

Examples
-> ip bfd admin-state enable
-> ip bfd admin-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip bfd Displays the BFD global status and general configuration parameters.

MIB Objects
alaBfdGlobalAdminStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 20-3
ip bfd transmit BFD Commands

ip bfd transmit
Configures the global transmit time interval for BFD control packets. This command specifies the
minimum amount of time BFD waits between each transmission of control packets.
ip bfd transmit transmit_interval

Syntax Definitions

transmit_interval The transmit time interval, in milliseconds. The valid range is 100–999.

Defaults

parameter default
transmit_interval 300 milliseconds

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The transmit time interval is also configurable at the BFD interface level. Note that configuring the
global value with the ip bfd transmit command does not override the value set for the interface using
the ip bfd interface transmit command.
• The global transmit time interval serves as the default interval value for a BFD interface. The default
interval value is overridden when a specific value is configured for the interface.

Examples
-> ip bfd transmit 500

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bfd interface transmit Configures the transmit time interval for a specific BFD interface.
show ip bfd Displays the BFD global status and general configuration parameters.

MIB Objects
alaBfdGlobalTxInterval

page 20-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BFD Commands ip bfd receive

ip bfd receive
Configures the global receive time interval for BFD control packets. This command specifies the
minimum amount of time BFD waits to receive control packets before determining there is a problem.
ip bfd receive receive_interval

Syntax Definitions

receive_interval The receive time interval, in milliseconds. The valid range is 100–999.

Defaults

parameter default
receive_interval 300 milliseconds

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The minimum receive time interval is also configurable at the BFD interface level. Note that
configuring the global value with the ip bfd receive command does not override the value set for the
interface using the ip bfd interface receive command.
• The global receive time interval serves as the default interval value for a BFD interface. The default
interval value is overridden when a specific value is configured for the interface.

Examples
-> ip bfd receive 500

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bfd interface receive Configures the receive time interval for a specific BFD interface.
show ip bfd Displays the BFD global status and general configuration parameters.

MIB Objects
alaBfdGlobalRxInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 20-5
ip bfd multiplier BFD Commands

ip bfd multiplier
Configures the global BFD detection time multiplier. This command specifies a number that is used to
calculate the BFD detection time used in the asynchronous mode. The detection time value that is
specified determines how long to wait before declaring that the BFD session is down.
ip bfd multiplier num

Syntax Definitions

num The detection time multiplier number. The valid range is 3–255.

Defaults
By default, the multiplier value is set to 3.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The global detection time multiplier is also configurable at the BFD interface level. Note that
configuring the global value with the ip bfd multiplier command does not override the value set for
the interface using the ip bfd interface multiplier command.
• The global detection time multiplier serves as the default multiplier value for a BFD interface. The
default multiplier value is overridden when a specific value is configured for the interface.

Examples
-> ip bfd multiplier 5

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bfd interface multiplier Configures the detection time multiplier for a BFD interface.
show ip bfd Displays the BFD global status and general configuration parameters.

MIB Objects
alaBfdGlobalDetectMult

page 20-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BFD Commands ip bfd echo-interval

ip bfd echo-interval
Configures the global BFD echo packet time interval. The echo function is available with the
asynchronous mode. Echo packets are transmitted to BFD peers to see if they loop back to the peer from
which they originated.
ip bfd echo-interval echo_interval

Syntax Definitions

echo_interval The echo time interval, in milliseconds. The valid range is 100–999.

Defaults

parameter default
echo_interval 300 milliseconds

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The echo packet time interval is also configurable at the BFD interface level. Note that configuring the
global value with the ip bfd echo-interval command does not override the value set for the interface
using the ip bfd interface echo-interval command.
• The global echo packet time interval serves as the default interval value for a BFD interface. The
default interval value is overridden when a specific value is configured for the interface.

Examples
-> ip bfd echo-interval 500

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bfd interface echo-interval Configures the echo packet time interval for a BFD interface.
show ip bfd Displays the BFD global status and general configuration parameters.

MIB Objects
alaBfdGlobalEchoRxInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 20-7
ip bfd interface BFD Commands

ip bfd interface
Configures a BFD interface.
ip bfd interface if_name
no ip bfd interface if_name

Syntax Definitions

if_name The name of an existing IP interface.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete a BFD interface.

• The interface name must be an existing IP interface name that is configured with an IP address.

Examples
-> ip bfd interface bfd-vlan-101
-> no ip bfd interface bfd-vlan-101

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bfd interface admin-state Configures the administrative status of a BFD interface.

show ip bfd interfaces Displays the status and statistics of a BFD interface.
show ip bfd sessions Displays the status and statistics of the BFD sessions.

MIB Objects
alaBfdIntfTable
alaBfdIntfAddrType
alaBfdIntfAddr
alaBfdIntfIndex

page 20-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BFD Commands ip bfd interface admin-state

ip bfd interface admin-state

Enables or disables the administrative status of a BFD interface.
ip bfd interface if_name admin-state {enable | disable}

Syntax Definitions

if_name The name of an existing BFD interface.

enable Enables the BFD interface.
disable Disables the BFD interface.

Defaults
By default, a BFD interface is disabled when it is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The BFD interface must be enabled to participate in the BFD protocol.

Examples
-> ip bfd interface bfd-vlan-101 admin-state enable
-> ip bfd interface bfd-vlan-101 admin-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bfd interface Creates a BFD interface.

show ip bfd interfaces Displays the status and statistics of a BFD interface.
show ip bfd sessions Displays the status and statistics of BFD sessions.

MIB Objects
alaBfdIntfTable
alaBfdIntfAdminStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 20-9
ip bfd interface transmit BFD Commands

ip bfd interface transmit

Configures the transmit time interval for the BFD interface. This command specifies the minimum amount
of time BFD waits between each transmission of control packets from the interface.
ip bfd interface if_name transmit transmit_interval

Syntax Definitions

if_name The name of an existing BFD interface.

transmit_interval The transmit time interval, in milliseconds. The valid range is 100–999.

Defaults

parameter default
transmit_interval 300 milliseconds

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The global transmit time interval serves as the default interval value for a BFD interface. The default
interval value is overridden when a specific value is configured for the interface.
• Note that configuring the interface transmit time interval using the ip bfd interface transmit command
does not change the global value configured with the ip bfd transmit command.

Examples
-> ip bfd interface bfd-vlan-101 transmit 500

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bfd interface Creates a BFD interface.

ip bfd transmit Configures a global BFD transmit time interval.
show ip bfd interfaces Displays the status and statistics of a BFD interface.
show ip bfd sessions Displays the status and statistics of the BFD sessions.

MIB Objects
alaBfdIntfTable
alaBfdIntfDesiredMinTxInterval

page 20-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BFD Commands ip bfd interface receive

ip bfd interface receive

Configures the receive time interval for the BFD interface. This command specifies the minimum amount
of time BFD waits to receive control packets on the interface before determining there is a problem.
ip bfd interface if_name receive receive_interval

Syntax Definitions

if_name The name of an existing BFD interface.

receive_interval The receive time interval, in milliseconds. The valid range is 100–999.

Defaults

parameter default
receive_interval 300 milliseconds

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The global receive time interval serves as the default interval value for a BFD interface. The default
interval value is overridden when a specific value is configured for the interface.
• Note that configuring the interface transmit time interval using the ip bfd interface receive command
does not change the global value configured with the ip bfd receive command.

Examples
-> ip bfd interface bfd-vlan-101 receive 500

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bfd interface Creates a BFD interface.

ip bfd receive Configures a global BFD receive time interval.
show ip bfd interfaces Displays the BFD interface configuration table.
show ip bfd sessions Displays the BFD interface configuration table.

MIB Objects
alaBfdIntfTable
alaBfdReqMinRxInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 20-11
ip bfd interface multiplier BFD Commands

ip bfd interface multiplier

Configures the BFD interface detection time multiplier. This command specifies a number that is used to
calculate the BFD detection time used in the asynchronous mode. When an interface stops receiving
packets from a neighbor, the interface uses the detection time value to determine how long to wait before
declaring that the BFD session is down.
ip bfd interface if_name multiplier num

Syntax Definitions

if_name The name of an existing BFD interface.

num The detection time multiplier number. The valid range is 3–255.

Defaults
By default, the multiplier value is set to 3.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The detection time between neighbors is calculated by multiplying the negotiated transmit time interval by
the detection time multiplier.

Examples
-> ip bfd interface bfd-vlan-101 multiplier 5

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bfd interface Creates a BFD interface.

show ip bfd interfaces Displays the BFD interface configuration table.
show ip bfd sessions Displays the BFD interface configuration table.

MIB Objects
alaBfdIntfTable
alaBfdIntfDetectMult

page 20-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BFD Commands ip bfd interface echo-interval

ip bfd interface echo-interval

Configures the echo time interval for the BFD interface. The echo function is available with the
asynchronous mode. Echo packets are transmitted to BFD peers to see if they loop back to the peer from
which they originated.
ip bfd interface if_name echo-interval echo_interval

Syntax Definitions

if_name The name of an existing IP interface.

echo_interval The echo time interval, in milliseconds. The valid range is 100–999.

Defaults

parameter default
echo_interval 300 milliseconds

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The global echo time interval serves as the default interval value for a BFD interface. The default
interval value is overridden when a specific value is configured for the interface.
• Note that configuring the interface echo time interval using the ip bfd interface echo-interval
command does not change the global value configured with the ip bfd echo-interval command.

Examples
-> ip bfd interface bfd-vlan-101 echo-interval 500

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 20-13
ip bfd interface echo-interval BFD Commands

Related Commands

ip bfd interface Creates a BFD interface.

ip bfd echo-interval Configures a global BFD echo time interval.
show ip bfd interfaces Displays the BFD interface configuration table.
show ip bfd sessions Displays the BFD interface configuration table.

MIB Objects
alaBfdIntfTable
alaBfdIntfReqMinEchoRxInterval

page 20-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BFD Commands ip ospf bfd-state

ip ospf bfd-state
Enables or disables the BFD status for the OSPF protocol.
ip ospf bfd-state {enable | disable}

Syntax Definitions

enable Enables BFD Status.

disable Disables BFD Status.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• All the status changes on the neighbors are received from the BFD level and the OSPF protocol acts
based upon the BFD message.
• Whenever a neighbor goes down, OSPF will inform BFD to remove that neighbor from the BFD active
list.

Examples
-> ip ospf bfd-state enable
-> ip ospf bfd-state disable

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 20-15
ip ospf bfd-state BFD Commands

Related Commands

ip ospf bfd-state all-interfaces Enables or disables BFD for all OSPF interfaces configured.
ip ospf interface bfd-state Enables or disables BFD for a specific OSPF interface.
ip ospf interface bfd-state drs- Establishes BFD sessions only on neighbors in full state.
only
ip ospf interface bfd-state all- Establishes BFD sessions with all neighbors of the corresponding
neighbors interface which are greater than or equal to “2-way” state.

MIB Objects
alaProtocolospf
alaOspfBfdStatus

page 20-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BFD Commands ip ospf bfd-state all-interfaces

ip ospf bfd-state all-interfaces

Enables or disables BFD for all OSPF interfaces in the switch configuration.
ip ospf bfd-state all-interfaces {enable | disable}

Syntax Definitions

enable Enables BFD for all the OSPF interfaces.

disable Disables BFD for all the OSPF interfaces.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The BFD status for OSPF must be enabled before OSPF can interact with BFD.

Examples
-> ip ospf bfd-state all-interfaces enable
-> ip ospf bfd-state all-interfaces disable

Release History
Release 8.1.1; command was introduced.

Related Commands

ip ospf bfd-state Enables or disables the BFD status for the OSPF protocol.
ip ospf interface bfd-state Enables or disables BFD for a specific OSPF interface.
ip ospf interface bfd-state drs- Establishes BFD sessions only on neighbors in full state.
only
ip ospf interface bfd-state all- Establishes BFD sessions with all neighbors of the corresponding
neighbors interface which are greater than or equal to “2-way” state.

MIB Objects
alaProtocolospf
alaOspfBfdAllInterfaces

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 20-17
ip ospf interface bfd-state BFD Commands

ip ospf interface bfd-state

Enables or disables BFD for a specific OSPF interface.
ip ospf interface if_name bfd-state {enable | disable}

Syntax Definitions

if_name The name of an existing OSPF interface.

enable Enables the OSPF interface.
disable Disables the OSPF interface.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The BFD status for OSPF must be enabled before OSPF can interact with BFD.

Examples
-> ip ospf interface int1 bfd-state enable
-> ip ospf interface int2 bfd-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

ip ospf bfd-state Enables or disables the BFD status for the OSPF protocol.
ip ospf bfd-state all-interfaces Enables or disables BFD for all OSPF interfaces configured.
ip ospf interface bfd-state drs- Establishes BFD sessions only on neighbors in full state.
only
ip ospf interface bfd-state all- Establishes BFD sessions with all neighbors of the corresponding
neighbors interface which are greater than or equal to “2-way” state.

MIB Objects
alaOspfIfAugEntry
ospfIfIpAddress
alaOspfIfBfdStatus

page 20-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BFD Commands ip ospf interface bfd-state drs-only

ip ospf interface bfd-state drs-only

Establishes BFD sessions only with neighbors that are in the full state.
ip ospf interface if_name bfd-state drs-only

Syntax Definitions

if_name The name of an existing OSPF interface.

Defaults

parameter default
drs-only disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The specified OSPF interface must be enabled to interact with BFD.

• The BFD status for OSPF must be enabled before OSPF can interact with BFD.

Examples
-> ip ospf interface int1 bfd-state drs-only

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bfd interface admin-state Enables or disables the BFD status for OSPF protocol.
ip ospf bfd-state all-interfaces Enables or disables BFD for all OSPF interfaces configured.
ip ospf interface bfd-state Enables or disables BFD for a specific OSPF interface.
ip ospf interface bfd-state all- Establishes BFD sessions with all neighbors of the corresponding
neighbors interface which are greater than or equal to “2-way” state.

MIB Objects
alaOspfIfAugEntry
ospfIfIpAddress
alaOspfIfBfdDrsOnly

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 20-19
ip ospf interface bfd-state all-neighbors BFD Commands

ip ospf interface bfd-state all-neighbors

Establishes BFD sessions with all neighbors of the corresponding interface which are greater than or equal
to “2-way” state.
ip ospf interface if_name bfd-state all-neighbors {enable | disable }

Syntax Definitions

if_name The name of an existing OSPF interface.

Defaults

parameter default
all-neighbors enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The specified OSPF interface must be enabled to interact with BFD.

• The BFD status for OSPF must be enabled before OSPF can interact with BFD.

Examples
-> ip ospf interface int1 bfd-state all-neighbors enable
-> ip ospf interface int1 bfd-state all-neighbors disable

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bfd interface admin-state Enables or disables the BFD status for OSPF protocol.
ip ospf bfd-state all-interfaces Enables or disables BFD for all OSPF interfaces configured.
ip ospf interface bfd-state Enables or disables BFD for a specific OSPF interface.
ip ospf interface bfd-state drs- Establishes BFD sessions only on neighbors in full state.
only

MIB Objects
alaOspfIfAugEntry
ospfIfIpAddress
alaOspfIfBfdDrsOnly

page 20-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BFD Commands ip bgp bfd-state

ip bgp bfd-state
Enables or disables BFD for the BGP protocol.
ip bgp bfd-state {enable | disable}

Syntax Definitions

enable Enables BGP.

disable Disables BGP.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• All the status changes on the neighbors are received from the BFD level and the BGP protocol acts
based upon the BFD message.
• Whenever a neighbor goes down, BGP will inform BFD to remove that neighbor from the BFD active
list.

Examples
-> ip bgp bfd-state enable
-> ip bgp bfd-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp bfd-state all-neighbors Enables or disables BFD for all BGP neighbors.
ip bgp neighbor bfd-state Enables or disables BFD for a specific neighbor.

MIB Objects
alaBgpGlobal
alaBgpBfdStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 20-21
ip bgp bfd-state all-neighbors BFD Commands

ip bgp bfd-state all-neighbors

Enables or disables BFD for all BGP neighbors.
ip bgp bfd-state all-neighbors {enable | disable}

Syntax Definitions

enable Enables BFD for all the BGP neighbors.

disable Disables BFD for all the BGP neighbors.

Defaults

N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The BFD status for BGP must be enabled before BGP can interact with BFD.

Examples
-> ip bgp bfd-state all-neighbors enable
-> ip bgp bfd-state all-neighbors disable

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp bfd-state Enables or disables BGP with BFD protocol.

ip bgp neighbor bfd-state Enables or disables the BFD for a specific BGP neighbor.

MIB Objects
alaBgpGlobal
alaBgpBfdAllNeighbors

page 20-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BFD Commands ip bgp neighbor bfd-state

ip bgp neighbor bfd-state

Enables or disables BFD for a specific BGP neighbor.
ip bgp neighbor ipv4_address bfd-state {enable | disable}

Syntax Definitions

ipv4_address The IP address of the BGP neighbor.

enable Enables BGP neighbor.
disable Disables BGP neighbor.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The BFD status for BGP must be enabled before BGP can interact with BFD.

Examples
-> ip bgp neighbor 135.10.10.2 bfd-state enable
-> ip bgp neighbor 135.10.10.2 bfd-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp bfd-state Enables or disables BGP with BFD protocol.

ip bgp bfd-state all-neighbors Enables or disables BFD for all BGP neighbors.

MIB Objects
alaBgpPeerEntry
alaBgpPeerName
alaBgpPeerBfdStatus
alaBgpGlobal
alaBgpBfdAllNeighbors

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 20-23
vrrp bfd-state BFD Commands

vrrp bfd-state
Enables or disables VRRP with the BFD protocol.
vrrp bfd-state {enable | disable}

Syntax Definitions

enable Enables BFD for VRRP.

disable Disables BFD for VRRP.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• BFD support for VRRP is done only for tracking policy configuration for a remote address.

• The BFD status for VRRP must be enabled before VRRP can interact with BFD.

Examples
-> vrrp bfd-state enable
-> vrrp bfd-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

vrrp track address bfd-state Enables or disable BFD for a specific tracking policy.

MIB Objects
alaVrrpConfig
alaVrrpBfdStatus

page 20-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BFD Commands vrrp track address bfd-state

vrrp track address bfd-state

Enables or disable BFD for a specific track policy.
vrrp track track_id address ipv4_address bfd-state {enable| disable}

Syntax Definitions

track_id The VRRP track number.

ipv4_address The remote IP address.
enable Enables BFD.
disable Disables BFD.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• BFD support for VRRP is done only for tracking policy configuration for a remote address.

• The BFD status for VRRP must be enabled before VRRP can interact with BFD.

Examples
-> vrrp track 2 address 10.1.1.1 bfd-state enable
-> vrrp track 3 address 10.1.1.2 bfd-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

vrrp bfd-state Enables or disables VRRP with BFD protocol.

MIB Objects
alaVRRPConfig
alaVrrpTrackBfdStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 20-25
show ip bfd BFD Commands

show ip bfd
Displays the global BFD configuration table.
show ip bfd

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip bfd
BFD Version Number = 1,
Admin Status = Enabled,
Desired Tranmit Interval = 300,
Minimum Receive Interval = 300,
Detection Time Multiplier = 3,
Minimum Echo Receive Interval = 300,
Applications Registered = STATIC-ROUTING OSPF PIM

output definitions
BFD Version Number Refers to BFD version.
Admin Status Refers to BFD global admin status.
Desired Transmit Interval Refers to BFD global Tx interval.
Minimum Receive Interval Refers to BFD global Rx interval.
Detection Time Multiplier Refers to the BFD Detection Time multiplier number.
Minimum Echo Receive Refers to BFD echo Rx interval.
Interval
Applications Registered Refers to applications registered to BFD.

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; Output updated to include PIM protocol application.

page 20-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BFD Commands show ip bfd

Related Commands

ip bfd admin-state Configures BFD at global level.

ip bfd interface Configures BFD at interface level.

MIB Objects
alaBfdIntfTable
alaBfdGlobalVersionNumber
alaBfdGlobalAdminStatus
alaBfdGlobalTxInterval
alaBfdGlobalRxInterval
alaBfdGlobalDetectMult
alaBfdGlobalEchoRxInterval
alaBfdGlobalProtocolApps

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 20-27
show ip bfd interfaces BFD Commands

show ip bfd interfaces

Displays the BFD interface configuration table.
show ip bfd interfaces [if_name]

Syntax Definitions

if_name The name of the BFD interface.

Defaults
By default, the configuration for all BFD interfaces is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Enter an interface name to display information for a specific BFD interface.

Examples
-> show ip bfd interfaces
Interface Admin Tx Min Rx Min EchoRx Detect OperStatus
Name Status Interval Interval Interval Multiplier
---------+--------+---------+---------+----------+----------+----------
one enabled 300 300 300 3 UP
two enabled 300 300 300 3 UP

-> show ip bfd interfaces one

Interface Name = one,
Interface IP Address = 100.1.1.1,
Admin Status = Enabled,
Desired Transmit Interval = 300,
Minimum Receive Interval = 300,
Detection Time Multiplier = 3,
Minimum Echo Receive Interval = 300,
Authentication Present = No,
Oper Status = UP

output definitions
Interface Name Refers to BFD Interface name.
Admin status Refers to BFD interface admin status.
Desired Transmit Interval Refers to BFD interface Tx interval.
Minimum Receive Interval Refers to BFD interface Rx interval.
Detection Time Multiplier Refers to BFD interface Detection Time Multiplier.
Minimum Echo Receive Refers to BFD interface echo Rx interval.
Interval

page 20-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BFD Commands show ip bfd interfaces

output definitions (continued)

Authentication Present Refers to availability of BFD message authentication on the BFD
interface.
Oper Status Refers to BFD interface operational status.

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bfd admin-state Configures BFD at global level.

ip bfd interface Configures BFD at interface level.

MIB Objects
alaBfdIntfTable
alaBfdIntfIfName
alaBfdIntfAddr
alabfdIntfAdminStatus
alaBfdIntfDesiredMinTxInterval
alaBfdIntfReqMinRxInterval
alaBfdIntfDetectMult
alaBfdIntfReqMinEchoRxInterval
alaBfdIntfAuthPresFlag
alaBfdIntfOperStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 20-29
show ip bfd sessions BFD Commands

show ip bfd sessions

Displays all the BFD sessions for the switch.
show ip bfd sessions [session_num] [slot chassis/slot_num]

Syntax Definitions

chassis The chassis identifier.

num The BFD session number. Valid range is 1–1024.
slot The current slot position used by the switch.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip bfd sessions
Local Interface Neighbor State Remote Negotiated Negotiated Session
Discr Name Address Discr Rx Interval Tx Interval Type
------+-----------+-----------+------+-------+------------+------------+--------
1 one 100.1.1.10 UP 0 0 0 ECHO
2 one 101.1.1.11 UP 10 300 300 ASYNC

-> show ip bfd sessions slot 1

Local Interface Neighbor State Remote Negotiated Negotiated EchoRx
Discr Name Address Discr Rx Interval Tx Interval
------+----------+----------+------+-------+------------+------------+-------
1 one 100.1.1.10 UP 0 0 0 300

-> show ip bfd sessions 1

Local discriminator = 1,
Neighbor IP Address = 100.1.1.10,
Requested Session Type = ECHO,
Interface IP Address = 100.1.1.1,
Source UDP Port = 49152,
State = UP,
Session Operating Mode = ECHO only,
Remote discriminator = 0,
Negotiated Tx interval = 0,
Negotiated Rx interval = 0,
Echo Rx interval = 300,
Multiplier = 3,
Applications Registered: = STATIC-ROUTING PIM

page 20-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BFD Commands show ip bfd sessions

output definitions
Local discriminator The local discriminator.
Neighbor IP address The IP address of the BFD neighbor.
Requested Session Type The bit map of the session type that is requested. .
Interface IP address The IP address of the outgoing BFD interface for this session.
Source UDP Port The unique source UDP port used to send BFD packets for this session.
State The state of the BFD session.
Session Operating Mode The current operating mode of the BFD session.
Remote discriminator The remote discriminator.
Negotiated Tx interval The negotiated transmit interval.
Negotiated Rx interval The negotiated receive interval.
Echo Rx interval The Echo packet receive interval.
Detection Time Multiplier The BFD Detection Time multiplier number.
Applications Registered The bit map object of applications that are registered with this BFD
session.

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; Output updated to include PIM protocol application.

Related Commands

ip bfd admin-state Configures BFD at global level.

ip bfd interface Configures BFD at interface level.
show ip bfd sessions statistics Displays the statistics for all BFD sessions.

MIB Objects
alaBfdSessTable
alaBfdSessDiscriminator
alaBfdSessNeighborAddr
alaBfdSessSessionType
alaBfdSessIfIndex
alaBfdSessUdpPort
alaBfdSessState
alaBfdSessOperMode
alaBfdSessDiscriminator
alaBfdSessNegotiatedTxInterval
alaBfdSessNegotiatedRxInterval
alaBfdSessEchoRxInterval
alaBfdSessDetectMult
alaBfdSessProtocolApps

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 20-31
show ip bfd sessions statistics BFD Commands

show ip bfd sessions statistics

Displays the statistics for all BFD sessions, a specific session, or a specific slot.
show ip bfd sessions statistics session_num

Syntax Definitions

session_num The BFD session number. Valid range is 1–1024.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip bfd sessions statistics
Local Neighbor Tx Rx Echo Tx Last Down Up
Discr Address Packets Packets Packets Diag Code Count
------+----------------+----------+----------+----------+-----------+-------
1 100.1.1.10 0 0 5772 0 1
2 101.1.1.11 5242 5241 0 0 1

-> show ip bfd sessions statistics 1

Tx packet counter = 0,
Rx packet counter = 0,
Tx Echo packet counter = 5772,
Rx Echo packet counter = 5774,
Session Up Time = 6160400,
Session Down Time = 0,
Last Down Diagnostic Code = 0,
Session Up Count = 1

output definitions
Local discriminator The local discriminator.
Neighbor address The IP address of the BFD neighbor.
Tx Packets Number of BFD Control packets transmitted on this session.
Rx Packets Number of BFD Control packets received on this session.
Echo Tx Packets Number of BFD Echo packets transmitted on this session.
Last Down Diagnostic Code Diagnostic code for last session down event
Up Count Number of times the session has moved to an UP state since the system
was last reset or initialized.

page 20-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BFD Commands show ip bfd sessions statistics

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip bfd Displays the global BFD configuration table.

show ip bfd sessions Displays all BFD sessions.

MIB Objects
alaBfdSessPerfTable
alaBfdSessDiscriminator
alaBfdSessNeighborAddr
alaBfdSessPerfPktOut
alaBfdSessPerfPktIn
alaBfdSessPerfEchoOut
alaBfdSessPerfEchoIn
alaBfdSessPerfLastCommLostDiag
alaBfdSessPerfSessUpCount

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 20-33
ip static-route all bfd-state BFD Commands

ip static-route all bfd-state

Enables BFD for all static routes.
ip static-route all bfd-state {enable | disable}

Syntax Definitions

enable Enables BFD.

disable Disables BFD.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When there are static route configured in the switch, BFD is enabled to track the gateway.

• If the route is not reachable, it will be moved to the inactive database.

Examples
-> ip static-route all bfd-state enable
-> ip static-route all bfd-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands
N/A

MIB Objects
alaIprmConfig
alaIprmStaticallbfd

page 20-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BFD Commands ip static-route bfd-state

ip static-route bfd-state
Enables or disables BFD for a specific static route.
ip static-route ipv4_prefix/pfx_length gateway ipv4_host_address bfd-state {enable| disable}

Syntax Definitions

ipv4_prefix The destination IP address.

pfx_length The prefix length for the destination IP address.
gateway ipv4_host_address The gateway IP address.
enable Enables BFD.
disable Disables BFD.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
BFD is enabled to track the gateway of static routes.

Examples
-> ip static-route 192.100.1.0/24 gateway 100.1.1.10 bfd-state enable
-> ip static-route 192.100.1.0/24 gateway 100.1.1.10 bfd-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

ip static-route all bfd-state Enables BFD for all static routes.

MIB Objects
alaIprmStaticRouteEntry
alaIprmStaticRouteDest
alaIprmStaticRouteMask
alaIprmStaticRouteNextHop
alaIprmStaticRouteBfdStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 20-35
ip static-route bfd-state BFD Commands

page 20-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 21 DHCP Relay Commands

Bootstrap Protocol (BOOTP) and Dynamic Host Configuration Protocol (DHCP) packets contain
configuration information for network hosts. DHCP Relay enables forwarding of BOOTP/DHCP packets
between networks. This allows routing of DHCP traffic between clients and servers. It is not necessary to
enable DHCP Relay if DHCP traffic is bridged through one network (the clients and servers are on the
same physical network).
This chapter includes a description of DHCP Relay commands that are used to define the IP address of
DHCP servers, maximum number of hops, and forward delay time. Configure DHCP Relay on the switch
where routing of BOOTP/DHCP packets occur. These CLI commands are applicable for all VRF
instances.
MIB information for DHCP Relay commands is as follows:
Filename: AlcatelIND1UDPRelay.MIB
Module: ALCATEL-IND1-UDP-RELAY-MIB
A summary of the available commands is listed here.

IP Helper ip helper address

ip helper vlan address
ip helper standard
ip helper per-vlan-only
ip helper forward-delay
ip helper maximum-hops
ip helper agent-information
ip helper agent-information policy
ip helper pxe-support
ip helper boot-up
ip helper boot-up enable
show ip helper
show ip helper statistics
no ip helper statistics
UDP ip udp relay port
ip udp relay service
ip udp relay service vlan
show ip udp relay
show ip udp relay statistics
ip udp relay no statistics

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-1
 DHCP Relay Commands

DHCP Server Commands dhcp-server

dhcp-server restart
show dhcp-server leases
show dhcp-server statistics
clear dhcp-server statistics
dhcpv6-server
dhcpv6-server restart
show dhcpv6-server leases
clear dhcpv6-server statistics
show dhcpv6-server statistics
dhcp-message-service
dhcp-message-service restart
show message-service status
DHCP Snooping dhcp-snooping admin-state
dhcp-snooping mac-address-verification
dhcp-snooping option-82-data-insertion
dhcp-snooping bypass option-82-check
dhcp-snooping option-82 format
dhcp-snooping vlan
dhcp-snooping port
dhcp-snooping linkagg
dhcp-snooping ip-source-filter
dhcp-snooping binding admin-state
dhcp-snooping binding timeout
dhcp-snooping binding action
dhcp-snooping binding persistency
dhcp-snooping binding
show dhcp-snooping ip-source-filter
show dhcp-snooping vlan
show dhcp-snooping port
show dhcp-snooping binding

page 21-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands ip helper address

ip helper address
Adds or deletes a DHCP server IP address. DHCP Relay forwards BOOTP/DHCP broadcasts to and from
the specified address. If multiple DHCP servers are used, configure one IP address for each server.
ip helper address ip_address
no ip helper address [ip_address]

Syntax Definitions

ip_address DHCP server IP address (for example 21.0.0.10).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete an IP address from the DHCP Relay service. If an address
is not specified, then all addresses are deleted.
• Using this command enables a Global DHCP Relay service on the switch. When the DHCP Relay is
specified by the DHCP server IP address, the service is called Global DHCP.
• When the DHCP Relay is specified by the VLAN number of the DHCP request, the service is referred
to as Per-VLAN DHCP.
• Global DHCP and Per-VLAN DHCP are mutually exclusive. You can only configure one or the other.

• Use this command to configure DHCP Relay on switches where packets are routed between IP
networks.

Examples
-> ip helper address 75.0.0.10
-> no ip helper address 31.0.0.20

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-3
ip helper address DHCP Relay Commands

Related Commands

ip helper vlan address Specifies or deletes DHCP Relay based on the VLAN of the DHCP
request.
ip helper forward-delay Sets the forward delay time value. DHCP Relay does not process a
client packet unless the packet contains an elapsed boot time value that
is equal to or greater than the configured value of the forward delay
time.
ip helper maximum-hops Sets the maximum number of hops value to specify how many relays a
BOOTP/DHCP packet can traverse.
show ip helper Displays current DHCP Relay configuration information.
show ip helper statistics Displays DHCP Relay statistics, including the number of client packets
received and transmitted to the DHCP server and packets dropped due to
forward delay time and maximum hops violations.

MIB Objects
iphelperTable
iphelperService
iphelperForwAddr

page 21-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands ip helper vlan address

ip helper vlan address

Configures a DHCP Relay service for the specified VLAN. This command is used when a per-VLAN only
relay service is active on the switch. It does not apply when a standard relay service is used.
ip helper vlan vlan_id[-vlan_id2] address ip_address
no ip helper vlan vlan_id[-vlan_id2] address ip_address

Syntax Definitions

vlan_id VLAN identification number (for example 3) of the DHCP server

VLAN.
vlan_id2 The last VLAN ID number in a contiguous range of VLAN IDs.
ip_address IP address (for example 21.0.0.10) of the DHCP server VLAN.

Defaults
If no VLAN identification number is entered, VLAN ID 0 is used by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Specifying multiple VLAN IDs and/or a range of VLAN IDs on the same command line is allowed.
Use a hyphen to indicate a contiguous range of VLAN ID entries. (for example, 10-15).
• The ip helper vlan address command works only if the per-vlan-only forwarding option is active.
Use the ip helper per-vlan-only command to enable this option.
• Configure DHCP Relay on switches where packets are routed between IP networks.

• The IP interface must be defined for the VLANs before using this command.

• Use the no form of this command to delete the DHCP server VLAN from the DHCP Relay.

Examples
-> ip helper vlan 3 address 75.0.0.10
-> ip helper vlan 250-255 address 198.206.15.2
-> no ip helper vlan 3 address 75.0.0.1
-> no ip helper vlan 1601 address 198.206.15.20

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-5
ip helper vlan address DHCP Relay Commands

Related Commands

ip helper per-vlan-only Sets the DHCP Relay forwarding option to process only DHCP packets
received from a specific, identified VLAN.
show ip helper Displays current DHCP Relay configuration information.
show ip helper statistics Displays DHCP Relay statistics, including the number of client packets
received and transmitted to the DHCP server and packets dropped due to
forward delay time and maximum hops violations.

MIB Objects
iphelperTable
iphelperService
iphelperVlan

page 21-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands ip helper standard

ip helper standard
Sets the DHCP Relay forwarding option to standard. All DHCP packets are processed by a global relay
service.
ip helper standard

Syntax Definitions

N/A

Defaults
By default, the DHCP Relay forwarding option is set to standard.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
To process DHCP packets on a per VLAN basis, or to change the DHCP Relay forwarding option from
standard to per VLAN, use the ip helper per-vlan-only command.

Examples
-> ip helper standard

Release History
Release 8.1.1; command introduced.

Related Commands

show ip helper Displays current DHCP Relay configuration information.

show ip helper statistics Displays DHCP Relay statistics, including the number of client packets
received and transmitted to the DHCP server and packets dropped due to
forward delay time and maximum hops violations.

MIB Objects
iphelperStatTable
iphelperForwOption

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-7
ip helper per-vlan-only DHCP Relay Commands

ip helper per-vlan-only
Sets the DHCP Relay forwarding option to process only DHCP packets received from a specific, identified
VLAN. This option allows each VLAN to have its own relay.
ip helper per-vlan-only

Syntax Definitions

N/A

Defaults
By default, the UDP forwarding option is set to standard.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When the forwarding option is set to per-vlan-only, the standard (global) DHCP relay service is not
available. These two types of services are mutually exclusive.
• To process DHCP packets on a per VLAN basis, or to change the DHCP Relay forwarding option from
standard to per VLAN, use the ip helper per-vlan-only command.
• Using the per-vlan-only forwarding option requires you to specify a DHCP server IP address for each
VLAN that provides a relay service. The ip helper vlan address command performs this function and
at the same time enables relay for the specified VLAN.

Examples
-> ip helper per-vlan-only

Release History
Release 8.1.1; command introduced.

page 21-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands ip helper per-vlan-only

Related Commands

ip helper vlan address Configures a DHCP Relay service for the specified VLAN.
ip helper standard Sets DHCP Relay forwarding option to standard. All DHCP packets are
processed.
show ip helper Displays current DHCP Relay configuration information.
show ip helper statistics Displays DHCP Relay statistics, including the number of client packets
received and transmitted to the DHCP server and packets dropped due to
forward delay time and maximum hops violations.

MIB Objects
iphelperStatTable
iphelperForwOption

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-9
ip helper forward-delay DHCP Relay Commands

ip helper forward-delay
Sets the forward delay time value for the DHCP Relay configuration. The BOOTP/DHCP packet sent
from the client contains the elapsed boot time. This is the amount of time, in seconds, since the client last
booted. DHCP Relay does not process the packet unless the elapsed boot time value of the client is equal
to or greater than the configured value of the forward delay time.
ip helper forward-delay seconds

Syntax Definitions

seconds Forward delay time value in seconds.

Defaults
By default, the forward delay time is set to three seconds.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The time specified applies to all defined IP helper addresses.

• If a packet contains an elapsed boot time value that is less than the specified forward delay time value,
DHCP Relay discards the packet.

Examples
-> ip helper forward-delay 300
-> ip helper forward-delay 120

Release History
Release 8.1.1; command introduced.

page 21-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands ip helper forward-delay

Related Commands

ip helper address Adds or deletes one or more DHCP server IP addresses to the DHCP
Relay configuration.
ip helper maximum-hops Sets the maximum number of hops value to specify how many relays a
BOOTP/DHCP packet can traverse.
show ip helper Displays current DHCP Relay configuration information.
show ip helper statistics Displays DHCP Relay statistics, including the number of client packets
received and transmitted to the DHCP server and packets dropped due to
forward delay time and maximum hops violations.

MIB Objects
iphelperStatTable
iphelperForwDelay

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-11
ip helper maximum-hops DHCP Relay Commands

ip helper maximum-hops
Sets the maximum number of hops value for the DHCP Relay configuration. This value specifies the
maximum number of relays a BOOTP/DHCP packet is allowed to traverse until it reaches its server
destination. Limiting the number of hops that can forward a packet prevents packets from looping through
the network.
ip helper maximum-hops hops

Syntax Definitions

hops The maximum number of relays.

Defaults
By default, the maximum hops value is set to four hops.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If a packet contains a hop count equal to or greater than the hops value, DHCP Relay discards the
packet.
• The maximum hops value only applies to DHCP Relay and is ignored by other services.

Examples
-> ip helper maximum-hops 1
-> ip helper maximum-hops 10

Release History
Release 8.1.1; command introduced.

page 21-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands ip helper maximum-hops

Related Commands

ip helper address Adds or deletes one or more DHCP server IP addresses to the DHCP
Relay configuration.
ip helper forward-delay Sets the forward delay time value. DHCP Relay does not process a
client packet unless the packet contains an elapsed boot time value that
is equal to or greater than the configured value of the forward delay
time.
show ip helper Displays current DHCP Relay configuration information.
show ip helper statistics Displays DHCP Relay statistics, including the number of client packets
received and transmitted to the DHCP server and packets dropped due to
forward delay time and maximum hops violations.

MIB Objects
iphelperStatTable
iphelperMaxHops

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-13
ip helper agent-information DHCP Relay Commands

ip helper agent-information
Enables or disables the DHCP relay agent information option (Option-82) feature. When this feature is
enabled, local relay agent information is inserted into client DHCP packets when the agent forwards these
packets to a DHCP server.
ip helper agent-information {enable | disable}

Syntax Definitions

enable Enables the relay agent Option-82 feature for the switch.
disable Disables the relay agent Option-82 feature for the switch.

Defaults
By default, this feature is disabled on the switch.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command enables the DHCP Option-82 feature for the entire switch; it is not configurable on a
per-VLAN basis.
• When the relay agent receives a DHCP packet that already contains the Option-82 field, the packet is
processed based on the agent information policy configured for the switch. This policy is configured
using the ip help agent-information policy command.

Examples
-> ip helper agent-information enable
-> ip helper agent-information disable

Release History
Release 8.1.1; command introduced.

page 21-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands ip helper agent-information

Related Commands

ip helper agent-information Configures a policy to determine how the relay agent handles DHCP
policy packets that already contain the Option-82 field.
show ip helper Displays current DHCP Relay configuration information.
show ip helper statistics Displays DHCP Relay statistics, including the number of client packets
received and transmitted to the DHCP server and packets dropped due to
forward delay time and maximum hops violations.

MIB Objects
iphelperAgentInformation

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-15
ip helper agent-information policy DHCP Relay Commands

ip helper agent-information policy

Configures a policy that determines how the DHCP relay agent handles the DHCP packets that already
contain an Option-82 field.
ip helper agent-information policy {drop | keep | replace}

Syntax Definitions

drop Drop DHCP packets that already contain an Option-82 field.

keep Keep the existing Option-82 field information and continue to relay the
DHCP packet.
replace Replace the existing Option-82 field information with local relay agent
information and continue to relay the DHCP packet.

Defaults
By default, DHCP packets that already contain an Option-82 field are dropped.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The agent information policy is not applied if the DHCP relay agent receives a DHCP packet from a
client that contains a non-zero value for the gateway IP address (giaddr). In this case, the agent does
not insert the relay agent information option into the DHCP packet and forwards the packet to the
DHCP server.
• Note that if a DHCP packet contains a gateway IP address (giaddr) value that matches a local subnet
and also contains the Option-82 field, the packet is dropped by the relay agent.

Examples
-> ip helper agent-information policy drop
-> ip helper agent-information policy keep
-> ip helper agent-information policy replace

Release History
Release 8.1.1; command introduced.

page 21-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands ip helper agent-information policy

Related Commands

ip helper agent-information Enables the insertion of relay agent information Option-82 into DHCP
packets.
show ip helper Displays current DHCP Relay configuration information.
show ip helper statistics Displays DHCP Relay statistics, including the number of client packets
received and transmitted to the DHCP server and packets dropped due to
forward delay time and maximum hops violations.

MIB Objects
iphelperAgentInformationPolicy

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-17
ip helper pxe-support DHCP Relay Commands

ip helper pxe-support
Enables or disables relay agent support for Preboot Execution Environment (PXE) devices.
ip helper pxe-support {enable | disable}

Syntax Definitions

enable Enables PXE support.

disable Disables PXE support.

Defaults
By default, PXE support is disabled for the switch.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
PXE support is disabled by default and it is a user-configurable option using the ip helper pxe-support
command.

Examples
-> ip helper pxe-support enable
-> ip helper pxe-support disable

Release History
Release 8.1.1; command introduced.

Related Commands

show ip helper Displays current DHCP Relay configuration information.

MIB Objects
iphelperPXESupport

page 21-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands ip helper boot-up

ip helper boot-up
Enables or disables automatic IP address configuration for default VLAN 1 when an unconfigured switch
boots up. If enabled, the switch broadcasts a BootP or a DHCP request packet at boot time. When the
switch receives an IP address from a BootP/DHCP server, the address is assigned to default VLAN 1.

Note: Automatic IP address configuration only supports the assignment of a permanent IP address to
the switch. Make sure that the DHCP server is configured with such an address before using this
feature.

ip helper boot-up {enable | disable}

Syntax Definitions

enable Enables automatic IP address configuration for default VLAN 1.

disable Disables automatic IP address configuration for default VLAN 1.

Defaults
By default, this feature is disabled on the switch.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the ip helper boot-up enable command to specify BootP or DHCP for the request packet type.

• If an IP router port already exists for VLAN 1, a request packet is not broadcast even if automatic IP
address configuration is enabled for the switch.

Examples
-> ip helper boot-up enable
-> ip helper boot-up disable

Release History
Release 8.1.1; command introduced.

Related Commands

ip helper boot-up enable Specifies BootP or DHCP as the type of request packet the switch
broadcasts at boot time.

MIB Objects
iphelperStatTable
iphelperBootupOption

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-19
ip helper boot-up enable DHCP Relay Commands

ip helper boot-up enable

Specifies the type of packet to broadcast (BootP or DHCP) when automatic IP address configuration is
enabled for the switch.

Note: Automatic IP address configuration only supports the assignment of a permanent IP address to
the switch. Make sure that the DHCP server is configured with such an address before using this
feature.

ip helper boot-up enable {bootp | dhcp}

Syntax Definitions

bootp Broadcasts a BOOTP formatted request packet.

dhcp Broadcasts a DHCP formatted request packet.

Defaults

parameter default
BOOTP | DHCP BOOTP

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command is only valid if automatic IP address configuration is already enabled for the switch.

Examples
-> ip helper boot-up enable DHCP
-> ip helper boot-up enable BOOTP

Release History
Release 8.1.1; command introduced.

Related Commands

ip helper boot-up Enables or disables automatic IP configuration for the switch.

MIB Objects
iphelperStatTable
iphelperBootupPacketOption

page 21-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands ip udp relay port

ip udp relay port

Enables or disables UDP port relay for user-defined service ports that are not well-known.
ip udp relay port port_num [description description]
ip udp relay no port port_num

Syntax Definitions

port_num A service port number that is not well-known or user-defined.

description A description of the user-defined service for the specified port.

Defaults
By default, relay is enabled on the BOOTP/DHCP well-known ports.

parameter default
name UDP port #

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable the user-defined service for the specified port.

• Use the port parameter to specify service port numbers that are not well known.

Examples
-> ip udp relay port 54
-> ip udp relay port 54 description “Generic Service”
-> ip udp relay no port 54

Release History
Release 8.1.1; command introduced.

Related Commands

ip udp relay service vlan Specifies the VLAN to which traffic from the specified UDP service
port is forwarded.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-21
ip udp relay port DHCP Relay Commands

MIB Objects
iphelperxServicePortAssociationTable
iphelperxServicePortAssociationService
iphelperxServicePortAssociationPort
iphelperxServicePortAssociationName
iphelperxPortServiceAssociationTable
iphelperxPortServiceAssociationService
iphelperxPortServiceAssociationPort
iphelperxPortServiceAssociationName

page 21-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands ip udp relay service

ip udp relay service

Enables or disables UDP port relay for generic UDP service ports (NBNS, NBDD, or other well-known
UDP ports).
ip udp relay service {tftp | tacacs | ntp | nbns | nbdd | dns} [description description]
ip udp relay no service {tftp | tacacs | ntp | nbns | nbdd | dns}

Syntax Definitions

tftp TFTP well-known port 69.

tacacs TACACS well-known port 65.
ntp NTP well-known port 123.
nbns NBNS well-known ports 137.
nbdd NBDD well-known port 138.
dns DNS well-known port 53.
description A description of the UDP service.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable UDP Relay for the specified service port.

• The description parameter is only used with any of the service keywords and provides a user-defined
description to identify the port service.
• When UDP Relay is disabled for BOOTP/DHCP, the ip helper configuration is not retained and all
dependant functionality (automatic IP configuration for VLAN 1, Telnet and HTTP client
authentication, and so on) is disrupted.
• Up to three types of UDP Relay services are supported at any one time and in any combination.

• If port relay is enabled for the NBDD well-known port, NBNS is not automatically enabled by default.

• Note that when UDP port relay is enabled for NTP, relay cannot forward NTP packets that contain a
destination IP address that matches a VLAN router IP address on the switch.

Examples
-> ip udp relay service DNS
-> ip udp relay service DNS description DNS_1
-> ip udp relay no service DNS

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-23
ip udp relay service DHCP Relay Commands

Release History
Release 8.1.1; command introduced.

Related Commands

ip udp relay service vlan Specifies the VLAN to which traffic from the specified UDP service
port is forwarded.

MIB Objects
iphelperxServicePortAssociationTable
iphelperxServicePortAssociationService
iphelperxServicePortAssociationPort
iphelperxServicePortAssociationName
iphelperxPortServiceAssociationTable
iphelperxPortServiceAssociationService
iphelperxPortServiceAssociationPort
iphelperxPortServiceAssociationName

page 21-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands ip udp relay service vlan

ip udp relay service vlan

Specifies a VLAN on which traffic destined for a UDP port is forwarded.
ip udp relay service {tftp | tacacs | ntp | nbns | nbdd | dns} | port port_num [description description]
vlan vlan_id[-vlan_id2]
ip udp relay service {tftp | tacacs | ntp | nbns | nbdd | dns} | port port_num no vlan vlan_id[-vlan_id2]

Syntax Definitions

tftp TFTP well-known port 69.

tacacs TACACS well-known port 65.
ntp NTP well-known port 123.
nbns NBNS well-known ports 137.
nbdd NBDD well-known port 138.
dns DNS well-known port 53.
port_num A user-defined port number.
description A description of the UDP service.
vlan_id A numeric value that uniquely identifies an individual VLAN.
-vlan_id2 The last VLAN ID number in a contiguous range of VLAN IDs. Use a
hyphen to specify a range of VLANs (for example, 1-5).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the VLAN association with the UDP service port.

• The UDP port must be created before using this command.

• Use the service keyword to define a well-known UDP port. Use the port keyword to specify a user-
defined port.
• Only specify service port numbers that are not well known when using the port parameter with this
command. For example, do not specify port 53 as it is the well-known port number for the DNS UDP
service. Instead, use the DNS parameter to enable relay for port 53.
• Specifying a VLAN for the BOOTP/DHCP service does not work if the per-vlan-only forwarding
option is not active. Use the ip helper per-vlan-only command to enable this option.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-25
ip udp relay service vlan DHCP Relay Commands

Examples
-> ip udp relay service DNS vlan 10
-> ip udp relay service DNS vlan 500-550
-> ip udp relay service DNS no vlan 10
-> ip udp relay port 3047 vlan 20
-> ip udp relay port 3047 no vlan 20

Release History
Release 8.1.1; command introduced.

Related Commands

ip udp relay port Enables or disables UDP port relay for user-defined service ports that
are not well-known.
ip udp relay service Enables or disables relay for UDP service ports.

MIB Objects
iphelperxPortServiceAssociationTable
iphelperxPortServiceAssociationService

page 21-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands show ip helper

show ip helper
Displays the current DHCP Relay and Relay Agent Information.
show ip helper

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Displays information for all IP addresses configured.

Examples
The following example shows the show ip helper command output:
-> show ip helper
Ip helper :
Forward Delay(seconds) = 300,
Max number of hops = 5,
Relay Agent Information = Enabled,
Relay Agent Information Policy = Keep,
PXE support = Enabled,
Forward option = standard mode,
Bootup Option = Disable,
Bootup Packet Option = DHCP
Forwarding address list (Standard mode):
128.100.16.1

output definitions
Forward Delay The current forward delay time (default is three seconds). Use the
ip helper forward-delay command to change this value.
Max number of hops The current maximum number of hops allowed (default is four
hops). Use the ip helper maximum-hops command to change this
value.
Relay Agent Information Indicates the status (Enabled or Disabled) of the DHCP relay
agent information option feature. Configured through the ip helper
agent-information command.
Relay Agent Information Policy The policy configured to determine how the DHCP relay agent
handles the DHCP packets that already contain an Option-82 field.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-27
show ip helper DHCP Relay Commands

output definitions
PXE support Specifies the status (Enabled or Disabled) of the relay agent
support for PXE devices. By default the PXE support is disabled.
Configured through the ip helper pxe-support command.
Forward option The current forwarding option setting: standard mode.
Bootup Option Indicates whether or not automatic IP address configuration for
default VLAN 1 is done when the switch boots up (Enabled or
Disabled). Configured through the ip helper boot-up command.
Bootup Packet Option Indicates if the Bootup Option broadcasts a DHCP or BOOTP
packet to obtain an IP address for default VLAN 1. Configured
through the ip helper boot-up enable command. Note that this
field does not appear if the Bootup Option is disabled.
Forwarding Addresses IP addresses for DHCP servers that receive BOOTP/DHCP packets
forwarded by this DHCP Relay service. Use the ip helper address
command to add or remove DHCP server IP addresses from the
DHCP Relay configuration.

Release History
Release 8.1.1; command introduced.

Related Commands

show ip helper statistics Displays DHCP Relay statistics, including the number of client packets
received and transmitted to the DHCP server and packets dropped due to
forward delay time and maximum hops violations.

MIB Objects
iphelperTable
iphelperService
iphelperForwAddr
iphelperForwDelay
iphelperMaxHops
iphelperAgentInformation
iphelperAgentInformationPolicy
iphelperStatTable
iphelperBootupOption
iphelperBootupPacketOption

page 21-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands show ip helper statistics

show ip helper statistics

Displays the number of packets DHCP Relay has received, the number of packets dropped due to forward
delay and maximum hops violations. It also displays the number of packets processed since the last time
these statistics were displayed. It includes statistics that apply to a specific DHCP server, such as the
number of packets transmitted to the server and the difference between the number of packets received
from a client and the number transmitted to the server.
show ip helper statistics

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to clear all DHCP Relay statistics.

Examples
-> show ip helper statistics

Global Statistics :
Reception From Client :
Total Count = 12, Delta = 12,
Forw Delay Violation :
Total Count = 3, Delta = 3,
Max Hops Violation :
Total Count = 0, Delta = 0,
Agent Info Violation :
Total Count = 0, Delta = 0,
Invalid Gateway IP :
Total Count = 0, Delta = 0,
Invalid Agent Info From Server :
Total Count = 0, Delta = 0,
Server Specific Statistics :
Server 5.5.5.5
Tx Server :
Total Count = 9, Delta = 9

output definitions
Reception From Client Number of packets DHCP Relay has received from the DHCP client.
Forw Delay Violation Number of packets dropped as a result of forward delay violations. A
violation occurs if a client packet contains an elapsed boot time value
that is less than the configured DHCP Relay forward delay time value.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-29
show ip helper statistics DHCP Relay Commands

output definitions (continued)

Max Hops Violation Number of packets dropped as a result of maximum hop violations. A
violation occurs if a packet contains a hop count equal to or greater than
the configured DHCP Relay maximum hops value.
Agent Info Violation Number of packets dropped as a result of a relay agent information
(Option-82) violation. A violation occurs if an Option-82 DHCP packet
contains a zero gateway IP address (giaddr) and the relay agent
information policy is set to Drop or a DHCP packet has no Option-82
field and contains a non-zero giaddr.
Invalid Gateway IP Number of packets dropped as a result of a gateway IP violation. A
violation occurs if an Option-82 DHCP packet contains a gateway IP
address (giaddr) that matches a local subnet address.
Invalid Agent Info From Number of invalid Option-82 DHCP server packets dropped by the
Server relay agent.
Delta Total number of packets processed since the last time the ip helper
statistics were checked during any user session.
Server DHCP server IP address that receives BOOTP/DHCP packets
forwarded by this DHCP Relay service. Use the ip helper address
command to add or remove DHCP server IP addresses from DHCP
Relay configuration.
Tx Server Number of packets DHCP Relay has transmitted to the DHCP server.
Delta The difference between the number of packets received from the client
and the number of packets transmitted to the DHCP server since the last
time DHCP Relay statistics were checked during any user session.

Release History
Release 8.1.1; command introduced.

Related Commands

show ip helper Displays current DHCP Relay configuration information.

MIB Objects
iphelperStatTable
iphelperServerAddress
iphelperRxFromClient
iphelperTxToServer
iphelperMaxHopsViolation
iphelperForwDelayViolation
iphelperResetAll

page 21-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands show ip udp relay

show ip udp relay

Displays the VLAN assignments to which the traffic received on the UDP service ports is forwarded.
Displays the current configuration for UDP services by service name or by service port number.
show ip udp relay [service {tftp | tacacs | ntp | nbns | nbdd | dns} | port port_num]

Syntax Definitions

tftp TFTP well-known port 69.

tacacs TACACS well-known port 65.
ntp NTP well-known port 123.
nbns NBNS well-known port 137.
nbdd NBDD well-known ports 138.
dns DNS well-known port 53.
port_num A user-specified port that is not a well-known port.

Defaults
By default, the configuration for all UDP services is shown.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the show ip udp relay command without the additional parameters to display information related
to all the ports.
• Enter a service name with this command along with the service parameter to display information about
an individual service.
• Mention a port number along with the port parameter, to get the UDP relay information for the
specific user defined or well-known port.

Examples
-> show ip udp relay

Service Port VLANs

---------------+--------+----------------
DNS 53 2 4
TACACS 65 3

output definitions
Service The active UDP service name. Configured through the ip udp relay
port command.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-31
show ip udp relay DHCP Relay Commands

output definitions (continued)

Port The UDP service port number. Configured through the ip udp relay
port command.
VLANs The VLAN assigned to the UDP service port that forwards traffic
destined for that port. Configured through the ip udp relay service
vlan command.

-> show ip udp relay service DNS

Service Port(s) Description

---------+--------+------------------
4 53 DNS

-> show ip udp relay port

Service Port(s) Description

---------+--------+------------------
4 54 Generic_Service
5 66 Tservice

-> show ip udp relay port 54

Service Port(s) Description

---------+--------+------------------
4 54 Generic_Service

output definitions
Service The UDP service number. (1 through 7 for well-known service ports
and 8 and above for user-defined service ports).
Port(s) The UDP service port number.
Description A description of the UDP service.

Release History
Release 8.1.1; command introduced.

Related Commands

show ip udp relay Displays the VLAN assignments to which the traffic received on the
specified UDP service port is forwarded.
show ip udp relay statistics Displays the current statistics for each UDP port relay service.

MIB Objects
iphelperTable
iphelperService
iphelperVlan
iphelperxPropertiesTable
iphelperxPropertiesName
iphelperxPropertiesPort
iphelperxPropertiesService

page 21-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands show ip udp relay statistics

show ip udp relay statistics

Displays the current statistics for each UDP port relay service. These statistics include the name of the
service, the forwarding VLAN(s) configured for that service, and the number of packets the service has
sent and received.
show ip udp relay statistics [service {tftp | tacacs | ntp | nbns | nbdd | dns}] [port [port_num]]

Syntax Definitions

tftp TFTP well-known port 69.

tacacs TACACS well-known port 65.
ntp NTP well-known port 123.
nbns NBNS well-known port 137.
nbdd NBDD well-known ports 138.
dns DNS well-known port 53.
port_num A user-specified port that is not a well-known port.

Defaults
By default, the statistics for all UDP services is shown.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enter a service name with the service parameter to display information about an individual service.

• Enter a port number with the port parameter to display information about an individual service.

Examples
-> show ip udp relay statistics

Service Vlan Pkts Sent Pkts Recvd

---------------+--------+------------+----------
145 0 0
DNS 2 10 10
4 15 15
TACACS 3 0 0

-> show ip udp relay statistics service tacacs

Service Vlan Pkts Sent Pkts Recvd

---------------+--------+------------+-----------
TACACS 3 0 0

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-33
show ip udp relay statistics DHCP Relay Commands

-> show ip udp relay statistics port 1776

Service Vlan Pkts Sent Pkts Recvd

-------------------+--------+-----------+-----------
A UDP Protocol 18 2 2

output definitions
Service The active UDP service name.
VLAN The VLAN assigned to the UDP service port that forwards traffic
destined for that port. Use the ip udp relay service vlan command to
configure this value.
Pkts Sent The number of packets sent from this service port to the server.
Pkts Recvd The number of packets received by this service port from a client.

Release History
Release 8.1.1; command introduced.

Related Commands

show ip udp relay Displays current configuration for UDP services by service name or by
service port number.

MIB Objects
iphelperxStatTable
iphelperxStatService
iphelperxStatVlan
iphelperxStatTxToServer
iphelperxStatRxFromClient

page 21-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands no ip helper statistics

no ip helper statistics
Resets the IP helper statistics for the specified VRF instances.
no ip helper statistics [global-only | server-only | address ip_address | vlan vlan_id {address
ip_address}]

Syntax Definitions

global-only Specifies that only the global IP helper statistics must be reset.
server-only Specifies that only the IP helper statistics related to the server must be
reset.
ip_address Specifies the IP address for the flat mode instance.
vlan_id Specifies the VLAN ID for the per-VLAN mode instance.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command works only for VRF instances.

• To reset all the IP helper related statistics, use this command without the additional keywords.

• To reset the IP helper statistics for the flat mode instance, provide the related IP address with the
address keyword
• To reset the IP helper statistics for the per-vlan mode instance, provide the VLAN ID with the vlan
keyword and the related IP address with the address keyword.

Examples
-> no ip helper statistics
-> no ip helper statistics global-only
-> no ip helper statistics server-only
-> no ip helper statistics address 172.6.5.1
-> no ip helper statistics vlan 20 address 172.6.5.1

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-35
no ip helper statistics DHCP Relay Commands

Related Commands

show ip helper statistics Displays the current statistics for each UDP port relay service.

MIB Objects
iphelperStatsTable
iphelperResetAllStats
iphelperResetSrvStats

page 21-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands ip udp relay no statistics

ip udp relay no statistics

Resets all the generic UDP Relay Service related statistics.
ip udp relay no statistics

Syntax Definitions

N/A

Defaults

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
On applying this command, the UDP relay statistics are cleared and the show ip udp relay statistics
command display no information.

Examples
-> ip udp relay no statistics

Release History
Release 8.1.1; command introduced.

Related Commands

show ip udp relay statistics Displays the current statistics for each UDP port relay service.

MIB Objects
genericUdpRelayTable
genericUdpRelayStatReset

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-37
dhcp-server DHCP Relay Commands

dhcp-server
Enables or disables the DHCP server operation.
dhcp-server {enable | disable}

Syntax Definitions

enable Enables the DHCP server.

disable Disables the DHCP server.

DefaultsDefaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When DHCP server is enabled on the switch, DHCP relay and DHCP snooping will not be supported
on the default VRF of the switch.
• DHCP server must be restarted when changes are made to the dhcpd.conf or dhcpd.pcy file. Use the
dhcp-server restart command to restart the DHCP server.

Examples
-> dhcp-server enable
-> dhcp-server disable

Release History
Release 8.2.1; command was introduced.

Related Commands

show dhcp-server leases Displays the leases offered by the DHCP server.
dhcp-server restart Allows to restart the DHCP server when the dhcpd.conf or dhcpd.pcy
file is modified.
clear dhcp-server statistics Clears the statistics of the DHCP server.

MIB Objects
alaDhcpSrvGlobalConfigStatus

page 21-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands dhcp-server restart

dhcp-server restart
Allows to restart the DHCP server when the dhcpd.conf or dhcpd.pcy file is modified.
dhcp-server restart

Syntax Definitions

restart Restarts the DHCP server.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The command can be used to restart the DHCP server when the dhcpd.conf or dhcpd.pcy file is modified.

Examples
-> dhcp-server restart

Release History
Release 8.2.1; command was introduced.

Related Commands

dhcp-server Enables or disables the DHCP server operation.

MIB Objects
alaDhcpSrvGlobalRestart

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-39
show dhcp-server leases DHCP Relay Commands

show dhcp-server leases

Displays the leases offered by the DHCP server.
show dhcp-server leases [ip- address ip_address | mac-address mac_address] [type {static | dynamic}]
[count]

Syntax Definitions

ip_address Specifies IP address of the interface configured with DHCP server.

mac_address Specifies MAC address of the interface configured with DHCP server.
static Displays only static leases.
dynamic Displays only dynamic leases.
count Count of DHCP messages recorded.

Defaults
By default, all leases are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
DHCP server should be enabled before using this command.

Examples
-> show dhcp-server leases

Total leases: 8

IP Address MAC address Lease Granted Lease Expiry Type

---------+------------------+---------------------+--------------------+-----------
200.0.1.1 00:00:01:b8:91:3f DEC 15 14:10:59 2009 DEC 19 01:30:59 2009 DYNAMIC
200.0.1.2 00:00:01:b8:91:37 DEC 15 14:11:05 2009 DEC 19 01:31:05 2009 DYNAMIC
200.0.1.3 00:00:01:b8:91:3b DEC 15 14:11:48 2009 DEC 19 01:31:48 2009 DYNAMIC
200.0.1.4 00:00:01:b8:91:3d DEC 15 14:11:53 2009 DEC 19 01:31:53 2009 DYNAMIC
220.0.0.2 00:00:01:1d:4f:7e DEC 15 14:11:45 2009 DEC 15 22:31:45 2009 DYNAMIC
220.0.0.3 00:00:01:5a:0b:76 DEC 15 14:12:00 2009 DEC 15 22:32:00 2009 DYNAMIC
220.0.0.4 00:00:01:1d:4f:7d DEC 15 14:11:53 2009 DEC 15 22:31:53 2009 DYNAMIC
120.0.0.4 00:00:02:12:4f:8c DEC 15 14:11:53 2009 DEC 15 23:31:53 2009 STATIC

-> show dhcp-server leases ip-address 200.0.1.2

IP Address MAC address Lease Granted Lease Expiry Type

----------+-----------------+---------------------+---------------------+---------
200.0.1.2 00:00:01:b8:91:37 DEC 15 14:11:05 2009 DEC 19 01:31:05 2009 DYNAMIC

page 21-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands show dhcp-server leases

-> show dhcp-server leases mac-address 00:00:01:1d:4f:7d

IP Address MAC address Lease Granted Lease Expiry Type

----------+-----------------+--------------------+---------------------+----------
220.0.0.4 00:00:01:1d:4f:7d DEC 15 14:11:53 2009 DEC 15 22:31:53 2009 DYNAMIC

Total leases: 1

-> show dhcp-server leases type static

IP Address MAC address Lease Granted Lease Expiry Type

----------+-----------------+---------------------+--------------------+-----------
120.0.0.4 00:00:02:12:4f:8c DEC 15 14:11:53 2009 DEC 15 23:31:53 2009 STATIC

output definitions
IP address The IP address allocated to the client.
MAC address The MAC address of the client for which the lease is allocated.
Lease Granted The date and time at which lease is granted.
Lease Expiry The date and time at which lease expires.
Type The type of lease offered.

Release History
Release 8.2.1; command introduced.

Related Commands

clear dhcp-server statistics Clears the DHCP server lease statistics.

MIB Objects
alaDhcpSrvLeaseTable
alaDhcpSrvLeaseMACAddress
alaDhcpSrvLeaseIpAddress
alaDhcpSrvLeaseLeaseGrant
alaDhcpSrvLeaseLeaseExpiry
alaDhcpSrvLeaseType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-41
show dhcp-server statistics DHCP Relay Commands

show dhcp-server statistics

Displays the statistics of the DHCP server.
show dhcp-server statistics [packets | hosts | subnets | all]

Syntax Definitions

packets Displays general statistical information along with specific information

about data packets received, dropped, and transmitted.
hosts Displays general statistical information along with specific information
about leases related to the DHCP server.
subnets Displays general statistical information along with specific information
about all the subnets.
all Displays all statistical information related to the DHCP server.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
DHCP server should be enabled before using this command.

Examples
-> show dhcp-server statistics
General:
DHCP Server Name: mample.vitalqip.com,
DHCP Server Status : Enabled,
Total Subnets Managed : 7,
Total Subnets Used : 2,
Total Subnets Unused : 5,
Total Subnets Full : 0,
DHCP Server System Up Time : TUE DEC 15 14:10:27.9956
Lease DB Sync time (in sec) : 60,
Last sync time : TUE DEC 15 14:21:34 2009,
Next sync time : TUE DEC 15 14:22:34 2009

-> show dhcp-server statistics packets

Packets:
Total DHCP Discovers : 12,
Total DHCP Offers : 12,
Total DHCP Requests : 16,
Total DHCP Request Grants : 10,
Total DHCP Request Renews : 6,
Total DHCP Declines : 0,
Total DHCP Acks : 16,
Total DHCP Nacks : 0,

page 21-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands show dhcp-server statistics

Total DHCP Releases : 0,

Total DHCP Informs : 0,
Total Bootp requests : 0,
Total Bootp response : 0,
Total Unknown packets : 0

-> show dhcp-server statistics hosts

Leases:
Total:
Leases Managed: 1365,
Leases used : 7,
Leases unused : 1358,
Leases Pending : 0,
Leases unavailable : 0
Static DHCP:
Leases Managed : 0,
Leases used : 0,
Leases unused : 0,
Leases Pending : 0,
Leases unavailable : 0
Dynamic DHCP:
Leases Managed : 1365,
Leases used : 7,
Leases unused : 1358,
Leases Pending : 0,
Leases unavailable : 0
Automatic DHCP:
Leases Managed : 0,
Leases used : 0,
Leases unused : 0,
Leases Pending : 0,
Leases unavailable : 0
Static Bootp:
Leases Managed : 0,
Leases used : 0,
Leases unused : 0,
Leases Pending : 0,
Leases unavailable : 0
Automatic Bootp:
Leases Managed : 0,
Leases used : 0,
Leases unused : 0,
Leases Pending : 0,
Leases unavailable : 0

-> show dhcp-server statistics subnets

Subnets:
Subnet1:
Subnet: 200.0.0.0,
Total : 1022,
Static DHCP : 0,
Dynamic DHCP : 1022,
Automatic DHCP : 0,
Static Bootp : 0,
Automatic Bootp : 0
Ranges:
Start : 200.0.1.1,
End : 200.0.2.255,
Mask : 255.255.253.0,

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-43
show dhcp-server statistics DHCP Relay Commands

Type : 5
Used : 4,
Unused : 507,
Pending : 0,
Unavailable : 0
Subnet2:
Subnet : 220.0.0.0,
Total : 508,
Static DHCP : 0,
Dynamic DHCP : 508,
Automatic DHCP : 0,
Static Bootp : 0,
Automatic Bootp : 0
Ranges:
Start : 220.0.0.2,
End : 220.0.0.255,
Mask : 255.255.255.0,
Type : 5,
Unused : 251,
Used : 3,
Pending : 0,
Unavailable : 0
Subnet3:
Subnet : 150.0.0.0,
Total : 400,
Static DHCP : 0,
Dynamic DHCP : 400,
Automatic DHCP : 0,
Static Bootp : 0,
Automatic Bootp : 0
Ranges:
Range1:
Start : 150.0.1.1,
End : 150.0.1.100,
Mask : 255.255.255.0,
Type : 5,
Used : 0,
Unused : 100,
Pending : 0,
Unavailable : 0
Range2:
Start : 150.0.2.1,
End : 150.0.2.100,
Mask : 255.255.255.0,
Type : 5,
Unused : 100,
Used : 0,
Pending : 0,
Unavailable : 0
Subnet4:
Subnet : 50.0.0.0,
Total : 200,
Static DHCP : 0,
Dynamic DHCP : 200,
Automatic DHCP : 0,
Static Bootp : 0,
Automatic Bootp : 0
Ranges:
Start : 50.0.1.1,

page 21-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands show dhcp-server statistics

End : 50.0.1.100,
Mask : 255.255.255.0,
Type : 5,
Unused : 100,
Used : 0,
Pending : 0,
Unavailable : 0

-> show dhcp-server statistics all

General:
DHCP Server Name: mample.vitalqip.com,
DHCP Server Status : Enabled,
Total Subnets Managed : 7,
Total Subnets Used : 2,
Total Subnets Unused : 5,
Total Subnets Full : 0,
DHCP Server System Up Time : TUE DEC 15 14:10:27.9956
Lease DB Sync:
DB Sync time (in sec) : 60,
Last sync time : TUE DEC 15 14:21:34 2009,
Next sync time : TUE DEC 15 14:22:34 2009
Packets:
Total DHCP Discovers: 12,
Total DHCP Offers : 12,
Total DHCP Requests : 16,
Total DHCP Request Grants : 10,
Total DHCP Request Renews : 6,
Total DHCP Declines : 0,
Total DHCP Acks : 16,
Total DHCP Nacks : 0,
Total DHCP Releases : 0,
Total DHCP Informs : 0,
Total Bootp requests : 0,
Total Bootp response : 0,
Total Unknown packets : 0
Leases:
Total:
Leases Managed: 1365,
Leases used : 7,
Leases unused : 1358,
Leases Pending : 0,
Leases unavailable : 0
Static DHCP:
Leases Managed : 0,
Leases used : 0,
Leases unused : 0,
Leases Pending : 0,
Leases unavailable : 0
Dynamic DHCP:
Leases Managed : 1365,
Leases used : 7,
Leases unused : 1358,
Leases Pending : 0,
Leases unavailable : 0
Automatic DHCP:
Leases Managed : 0,
Leases used : 0,
Leases unused : 0,
Leases Pending : 0,

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-45
show dhcp-server statistics DHCP Relay Commands

Leases unavailable : 0
Static Bootp:
Leases Managed : 0,
Leases used : 0,
Leases unused : 0,
Leases Pending : 0,
Leases unavailable : 0
Automatic Bootp :
Leases Managed : 0,
Leases used : 0,
Leases unused : 0,
Leases Pending : 0,
Leases unavailable : 0
Subnets:
Subnet1:
Subnet : 200.0.0.0,
Total : 1022,
Static DHCP : 0,
Dynamic DHCP : 1022,
Automatic DHCP : 0,
Static Bootp : 0,
Automatic Bootp : 0
Ranges:
Start : 200.0.1.1,
End : 200.0.2.255,
Mask : 255.255.253.0,
Type : 5
Used : 4,
Unused : 507,
Pending : 0,
Unavailable : 0
Subnet2:
Subnet : 220.0.0.0,
Total : 508,
Static DHCP : 0,
Dynamic DHCP : 508,
Automatic DHCP : 0,
Static Bootp : 0,
Automatic Bootp : 0
Ranges:
Start : 220.0.0.2,
End : 220.0.0.255,
Mask : 255.255.255.0,
Type : 5
Unused : 251,
Used : 3,
Pending : 0,
Unavailable : 0
Subnet3:
Subnet : 150.0.0.0,
Total : 400,
Static DHCP : 0,
Dynamic DHCP : 400,
Automatic DHCP : 0,
Static Bootp : 0,
Automatic Bootp : 0
Ranges:
Range1:
Start : 150.0.1.1,

page 21-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands show dhcp-server statistics

End : 150.0.1.100,
Mask : 255.255.255.0,
Type : 5,
Used : 0,
Unused : 100,
Pending : 0,
Unavailable : 0
Range2:
Start : 150.0.2.1,
End : 150.0.2.100,
Mask : 255.255.255.0,
Type : 5,
Unused : 100,
Used : 0,
Pending : 0,
Unavailable : 0
Subnet4:
Subnet : 50.0.0.0,
Total : 200,
Static DHCP : 0,
Dynamic DHCP : 200,
Automatic DHCP : 0,
Static Bootp : 0,
Automatic Bootp : 0
Ranges:
Start : 50.0.1.1,
End : 50.0.1.100,
Mask : 255.255.255.0,
Type : 5,
Unused : 100,
Used : 0,
Pending : 0,
Unavailable : 0

output definitions
General stats Denotes general DHCP Server statistics.
Name Specifies the name assigned to the DHCP server.
Status Specifies up or down status of the DHCP server.
Total subnets used Specifies the total number of subnets being used.
Total subnets managed Specifies the total number of subnets being managed by the DHCP
server.
Total subnets unused Specifies the total number of subnets being unused.
Total subnets full Specifies the total number of subnets where all the IP addresses are
used.
DHCP Server System Up Time Shows the DHCP Server System Up Time Performance Monitor
counter.
Sync time Specifies the time for DHCP server to contact and synchronize with the
designated time server.
Last sync time Specifies the last time the synchronization occurred.
Next sync time Specifies the next time the synchronization should be scheduled.
Packet stats Denotes statistical information about the data packet transmission.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-47
show dhcp-server statistics DHCP Relay Commands

output definitions (continued)

Total DHCP Discovers Specifies the total number of DHCPDISCOVER packets sent by the
clients to the DHCP server.
Total DHCP Offers Specifies the total number of DHCPOFFER packets sent by the server
to the clients.
Total DHCP Requests Specifies the total number of DHCPREQUEST packets sent by the
clients in response to the DHCPOFFER packets.
Total DHCP Request Grants Specifies the total number of DHCP request grants provided by the
server to the clients.
Total DHCP Request Renews Specifies the total number of DHCP lease renew requests sent by the
clients to the DHCP server.
Total DHCP Declines Specifies the total number of DHCP requests declined by the DHCP
server.
Total DHCP Acks Specifies the total number of DHCPACK acknowledgement packets
sent by the DHCP server to the clients.
Total DHCP Nacks Specifies the total number of DHCP Negative acknowledgements sent
from the DHCP server to the clients. The DHCPNACK message is sent
when all the IP addresses available to the server are exhausted and the
client sends a DHCPREQUEST.
Total DHCP Releases Specifies the total number of DHCPRELEASE packets sent by the
DHCP server to release IP addresses from its clients.
Total DHCP Informs Specifies the total number of DHCPINFORM packets sent by the
clients to obtain DHCP options from the DHCP server.
Total Bootp requests Specifies the total number of BOOTP requests sent by the clients to the
DHCP server.
Total Bootp response Specifies the total number of BOOTP response packets sent by the
DHCP server to the clients.
Total Unknown packets Specifies the total number of unknown or badly formatted DHCP
packets received by the DHCP server.
Leases stats Denotes statistical information about leases provided by the DHCP
server.
Hosts Managed Specifies the total number of clients managed by the DHCP server.
Hosts used Specifies the total number of clients using the IP addresses provided by
the DHCP server.
Hosts unused Specifies the total number of clients managed by the DHCP server
which are not being used.
Hosts Pending Specifies the total number of DHCP IP address requests which are
pending by the DHCP server.
Hosts unavailable Specifies the total number of DHCP hosts which are unavailable i.e;
whose lease period have expired.
Static DHCP Denotes statistical information about the hosts configured with Static
DHCP.
Automatic DHCP Denotes statistical information about the hosts configured with
Automatic DHCP.

page 21-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands show dhcp-server statistics

output definitions (continued)

Static BootP Denotes statistical information about the hosts configured under Static
BootP. Note: BootP Relay is disabled when DHCP server is enabled
on the switch.
Automatic BootP Denotes statististical information about the hosts configured with
Automatic BootP.
Subnet statistics Denotes all DHCP related statististical information for individual
subnets.
Range Specifies the range of IP addresses in the individual subnet.
Mask Specifies the subnet mask.
Type Specifies whether the type of IP address allocation is dynamic or static.

Release History
Release 8.2.1; command introduced.

Related Commands

clear dhcp-server statistics Clears the DHCP Server lease statistics.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-49
clear dhcp-server statistics DHCP Relay Commands

clear dhcp-server statistics

Clears the packet counters of DHCP server statistics.
clear dhcp-server statistics

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use this command to clear the packet counters of DHCP server statistics.

Examples
-> clear dhcp-server statistics

Release History
Release 8.2.1; command introduced.

Related Commands

show dhcp-server statistics Displays the DHCP Server lease statistics.

MIB Objects
N/A

page 21-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands dhcpv6-server

dhcpv6-server
Enables or disables the DHCPv6 server operation.
dhcpv6-server {enable | disable}

Syntax Definitions

enable Enables the DHCPv6 server.

disable Disables the DHCPv6 server.

DefaultsDefaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The dhcpdv6.conf and dhcpdv6.pcy files will be parsed when the DHCPv6 status is enabled for the
first time.
• There will be one instance of DHCPv6 for the default VRF.

Examples
-> dhcpv6-server enable
-> dhcpv6-server disable

Release History
Release 8.2.1; command was introduced.

Related Commands

show dhcpv6-server leases Displays the leases offered by the DHCPv6 server.
dhcpv6-server restart Allows to restart the DHCPv6 server when the dhcpdv6.conf or
dhcpdv6.pcy file is modified.
clear dhcpv6-server statistics Displays the statistics of the DHCPv6 server.

MIB Objects
alaDhcpv6SrvGlobalConfigStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-51
dhcpv6-server restart DHCP Relay Commands

dhcpv6-server restart
Allows to restart the DHCPv6 server when the dhcpdv6.conf or dhcpdv6.pcy file is modified.
dhcpv6-server restart

Syntax Definitions

restart Restarts the DHCPv6 server.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> dhcpv6-server restart

Release History
Release 8.2.1; command was introduced.

Related Commands

dhcpv6-server Enables or disables the DHCPv6 server operation.

MIB Objects
alaDhcpv6SrvGlobalRestart

page 21-52 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands show dhcpv6-server leases

show dhcpv6-server leases

Displays the leases offered by the DHCPv6 server.
show dhcpv6-server leases [ip- address ipv6_address | type {static | dynamic}] [count]

Syntax Definitions

ipv6_address Specifies IPv6 address of the interface configured with DHCPv6 server.
static Displays only static leases.
dynamic Displays only dynamic leases.
count Count of DHCPv6 messages recorded.

Defaults
By default, all leases are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show dhcpv6-server leases

Total leases: 8

IP Address Lease Granted Pref Lease Expiry Valid Lease Expiry Type
------------------+---------------------+---------------------+-----------
2001:100::2 DEC 15 14:10:59 2009 DEC 19 01:30:59 2009 DEC 19 05:30:59 2009 STATIC
2001:100::3 DEC 15 14:11:05 2009 DEC 19 01:31:05 2009 DEC 19 05:31:05 2009 DYNAMIC
2001:200::2 DEC 15 14:11:48 2009 DEC 19 01:31:48 2009 DEC 19 05:31:48 2009 DYNAMIC

-> show dhcpv6-server leases ip-address 2001:100::3

IP Address Lease Granted Pref Lease Expiry Valid Lease Expiry Type
-------------------+--------------------+---------------------+---------------------+-----
2001:100::3 DEC 15 14:11:05 2009 DEC 19 01:31:05 2009 DEC 19 05:31:05 2009 DYNAMIc

-> show dhcpv6-server leases type static

Total leases: 1
IP Address Lease Granted Pref Lease Expiry Valid Lease Expiry Type
-----------------+------------------+---------------------+---------------------+-------
2001:100::2 DEC 15 14:10:59 2009 DEC 19 01:30:59 2009 DEC 19 05:30:59 2009 STATIC

output definitions
IP address The IP address allocated to the client.
Lease Granted The date and time at which lease is granted.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-53
show dhcpv6-server leases DHCP Relay Commands

output definitions (continued)

Pref Lease Expiry The date and time at which lease expires.
Type The type of lease offered.

Release History
Release 8.2.1; command introduced.

Related Commands

clear dhcpv6-server statistics Clears the DHCPv6 server lease statistics.

MIB Objects
alaDhcpv6SrvLeaseTable
alaDhcpv6SrvLeaseIpAddress
alaDhcpv6SrvLeaseLeaseGrant
alaDhcpv6SrvLeaseLeaseExpiry
alaDhcpv6SrvLeaseType

page 21-54 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands show dhcpv6-server statistics

show dhcpv6-server statistics

Displays the statistics of the DHCPv6 server.
show dhcpv6-server statistics [packets | hosts | subnets | all]

Syntax Definitions

packets Displays general statistical information along with specific information

about data packets received, dropped, and transmitted.
hosts Displays general statistical information along with specific information
about leases related to the DHCPv6 server.
subnets Displays general statistical information along with specific information
about all the subnets.
all Displays all statistical information related to the DHCPv6 server.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
DHCPv6 server should be enabled before using this command.

Examples
-> show dhcpv6-server statistics
General:
DHCPv6 Server Name : DHCPv6,
DHCPv6 Server Status : Enabled,
Total Subnets Managed : 4,
Total Subnets Used : 0,
Total Subnets Unused : 4,
Total Subnets Full : 0,
DHCPv6 Server System Up Time : Mon Jan 12 05:49:54.198,
Lease DB Sync time (in sec) : 60,
Last sync time : Mon Jan 12 08:41:02 2015,
Next sync time : Mon Jan 12 08:42:02 201

-> show dhcpv6-server statistics packets

Packet:
Total DHCPv6 Solicts : 0,
Total DHCPv6 Advertises : 0,
Total DHCPv6 Requests : 0,
Total DHCPv6 Renews : 0,
Total DHCPv6 Rebinds : 0,
Total DHCPv6 Declines : 0,
Total DHCPv6 Confirms : 0,
Total DHCPv6 Replys : 0,

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-55
show dhcpv6-server statistics DHCP Relay Commands

Total DHCPv6 Releases : 0,

Total DHCPv6 Information Requests : 0,
Total DHCPv6 Lease Querys : 0,
Total Delete Leases : 0,
Total Unknown packets : 0

-> show dhcpv6-server statistics leases

Leases:
Total:
Leases Managed : 50190,
Leases used : 0,
Leases unused : 50190,
Leases Pending : 0,
Leases unavailable : 0
Static DHCPv6:
Leases Managed : 10,
Leases used : 0,
Leases unused : 10,
Leases Pending : 0,
Leases unavailable : 0
Dynamic DHCPv6:
Leases Managed : 50180,
Leases used : 0,
Leases unused : 50180,
Leases Pending : 0,
Leases unavailable : 0

-> show dhcpv6-server statistics subnets

Subnets:
Subnet 1:
SubnetAddr : 2620:0:60:1480::,
Total : 17666,
Static DHCP : 1,
Dynamic DHCP : 17665,
Ranges:
Range1:
Start : 2620:0:60:1480::1f01,
End : 2620:0:60:1480::1f01,
PrefixLength : 97,
Type : 1,
inUse : 0,
Unused : 1,
Pending : 0,
Unavailable : 0
Range2:
Start : 2620:0:60:1480::2000,
End : 2620:0:60:1480::6500,
PrefixLength : 97,
Type : 2,
inUse : 0,
Unused : 17665,
Pending : 0,
Unavailable : 0
Subnet 2:
SubnetAddr : 2620:0:60:1481::,
Total : 29956,
Static DHCP : 3,
Dynamic DHCP : 29953,
Ranges:

page 21-56 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands show dhcpv6-server statistics

Range1:
Start : 2620:0:60:1481::1f01,
End : 2620:0:60:1481::1f01,
PrefixLength : 64,
Type : 1,
inUse : 0,
Unused : 1,
Pending : 0,
Unavailable : 0
Range2:
Start : 2620:0:60:1481::1f02,
End : 2620:0:60:1481::1f02,
PrefixLength : 64,
Type : 1,
inUse : 0,
Unused : 1,
Pending : 0,
Unavailable : 0
Range3:
Start : 2620:0:60:1481::1f03,
End : 2620:0:60:1481::1f03,
PrefixLength : 64,
Type : 1,
inUse : 0,
Unused : 1,
Pending : 0,
Unavailable : 0
Range4:
Start : 2620:0:60:1481::2000,
End : 2620:0:60:1481::9500,
PrefixLength : 64,
Type : 2,
inUse : 0,
Unused : 29953,
Pending : 0,
Unavailable : 0
Subnet 3:
SubnetAddr : 2620:0:60:1482::,
Total : 1284,
Static DHCP : 3,
Dynamic DHCP : 1281,
Ranges:
Range1:
Start : 2620:0:60:1482::1f01,
End : 2620:0:60:1482::1f01,
PrefixLength : 64,
Type : 1,
inUse : 0,
Unused : 1,
Pending : 0,
Unavailable : 0
Range2:
Start : 2620:0:60:1482::1f02,
End : 2620:0:60:1482::1f02,
PrefixLength : 64,
Type : 1,
inUse : 0,
Unused : 1,
Pending : 0,

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-57
show dhcpv6-server statistics DHCP Relay Commands

Unavailable : 0
Range3:
Start : 2620:0:60:1482::1f03,
End : 2620:0:60:1482::1f03,
PrefixLength : 64,
Type : 1,
inUse : 0,
Unused : 1,
Pending : 0,
Unavailable : 0
Range4:
Start : 2620:0:60:1482::3000,
End : 2620:0:60:1482::3500,
PrefixLength : 64,
Type : 2,
inUse : 0,
Unused : 1281,
Pending : 0,
Unavailable : 0
Subnet 4:
SubnetAddr : 2620:0:60:1483::,
Total : 1284,
Static DHCP : 3,
Dynamic DHCP : 1281,
Ranges:
Range1:
Start : 2620:0:60:1483::1f01,
End : 2620:0:60:1483::1f01,
PrefixLength : 64,
Type : 1,
inUse : 0,
Unused : 1,
Pending : 0,
Unavailable : 0
Range2:
Start : 2620:0:60:1483::1f02,
End : 2620:0:60:1483::1f02,
PrefixLength : 64,
Type : 1,
inUse : 0,
Unused : 1,
Pending : 0,
Unavailable : 0
Range3:
Start : 2620:0:60:1483::1f03,
End : 2620:0:60:1483::1f03,
PrefixLength : 64,
Type : 1,
inUse : 0,
Unused : 1,
Pending : 0,
Unavailable : 0
Range4:
Start : 2620:0:60:1483::4000,
End : 2620:0:60:1483::4500,
PrefixLength : 64,
Type : 2,
inUse : 0,
Unused : 1281,

page 21-58 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands show dhcpv6-server statistics

Pending : 0,
Unavailable : 0

-> show dhcp6-server statistics all

General:
DHCPv6 Server Name : DHCPv6,
DHCPv6 Server Status : Enabled,
Total Subnets Managed : 4,
Total Subnets Used : 0,
Total Subnets Unused : 4,
Total Subnets Full : 0,
DHCPv6 Server System Up Time : Mon Jan 12 05:49:54.198,
Lease DB Sync time (in sec) : 60,
Last sync time : Mon Jan 12 08:45:02 2015,
Next sync time : Mon Jan 12 08:46:02 2015
Packet:
Total DHCPv6 Solicts : 0,
Total DHCPv6 Advertises : 0,
Total DHCPv6 Requests : 0,
Total DHCPv6 Renews : 0,
Total DHCPv6 Rebinds : 0,
Total DHCPv6 Declines : 0,
Total DHCPv6 Confirms : 0,
Total DHCPv6 Replys : 0,
Total DHCPv6 Releases : 0,
Total DHCPv6 Information Requests : 0,
Total DHCPv6 Lease Querys : 0,
Total Delete Leases : 0,
Total Unknown packets : 0
Leases:
Total:
Leases Managed : 50190,
Leases used : 0,
Leases unused : 50190,
Leases Pending : 0,
Leases unavailable : 0
Static DHCPv6:
Leases Managed : 10,
Leases used : 0,
Leases unused : 10,
Leases Pending : 0,
Leases unavailable : 0
Dynamic DHCPv6:
Leases Managed : 50180,
Leases used : 0,
Leases unused : 50180,
Leases Pending : 0,
Leases unavailable : 0
Subnets:
Subnet 1:
SubnetAddr : 2620:0:60:1480::,
Total : 17666,
Static DHCP : 1,
Dynamic DHCP : 17665,
Ranges:
Range1:
Start : 2620:0:60:1480::1f01,
End : 2620:0:60:1480::1f01,
PrefixLength : 97,

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-59
show dhcpv6-server statistics DHCP Relay Commands

Type : 1,
inUse : 0,
Unused : 1,
Pending : 0,
Unavailable : 0
Range2:
Start : 2620:0:60:1480::2000,
End : 2620:0:60:1480::6500,
PrefixLength : 97,
Type : 2,
inUse : 0,
Unused : 17665,
Pending : 0,
Unavailable : 0
Subnet 2:
SubnetAddr : 2620:0:60:1481::,
Total : 29956,
Static DHCP : 3,
Dynamic DHCP : 29953,
Ranges:
Range1:
Start : 2620:0:60:1481::1f01,
End : 2620:0:60:1481::1f01,
PrefixLength : 64,
Type : 1,
inUse : 0,
Unused : 1,
Pending : 0,
Unavailable : 0
Range2:
Start : 2620:0:60:1481::1f02,
End : 2620:0:60:1481::1f02,
PrefixLength : 64,
Type : 1,
inUse : 0,
Unused : 1,
Pending : 0,
Unavailable : 0
Range3:
Start : 2620:0:60:1481::1f03,
End : 2620:0:60:1481::1f03,
PrefixLength : 64,
Type : 1,
inUse : 0,
Unused : 1,
Pending : 0,
Unavailable : 0
Range4:
Start : 2620:0:60:1481::2000,
End : 2620:0:60:1481::9500,
PrefixLength : 64,
Type : 2,
inUse : 0,
Unused : 29953,
Pending : 0,
Unavailable : 0
Subnet 3:
SubnetAddr : 2620:0:60:1482::,
Total : 1284,

page 21-60 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands show dhcpv6-server statistics

Static DHCP : 3,
Dynamic DHCP : 1281,
Ranges:
Range1:
Start : 2620:0:60:1482::1f01,
End : 2620:0:60:1482::1f01,
PrefixLength : 64,
Type : 1,
inUse : 0,
Unused : 1,
Pending : 0,
Unavailable : 0
Range2:
Start : 2620:0:60:1482::1f02,
End : 2620:0:60:1482::1f02,
PrefixLength : 64,
Type : 1,
inUse : 0,
Unused : 1,
Pending : 0,
Unavailable : 0
Range3:
Start : 2620:0:60:1482::1f03,
End : 2620:0:60:1482::1f03,
PrefixLength : 64,
Type : 1,
inUse : 0,
Unused : 1,
Pending : 0,
Unavailable : 0
Range4:
Start : 2620:0:60:1482::3000,
End : 2620:0:60:1482::3500,
PrefixLength : 64,
Type : 2,
inUse : 0,
Unused : 1281,
Pending : 0,
Unavailable : 0
Subnet 4:
SubnetAddr : 2620:0:60:1483::,
Total : 1284,
Static DHCP : 3,
Dynamic DHCP : 1281,
Ranges:
Range1:
Start : 2620:0:60:1483::1f01,
End : 2620:0:60:1483::1f01,
PrefixLength : 64,
Type : 1,
inUse : 0,
Unused : 1,
Pending : 0,
Unavailable : 0
Range2:
Start : 2620:0:60:1483::1f02,
End : 2620:0:60:1483::1f02,
PrefixLength : 64,
Type : 1,

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-61
show dhcpv6-server statistics DHCP Relay Commands

inUse : 0,
Unused : 1,
Pending : 0,
Unavailable : 0
Range3:
Start : 2620:0:60:1483::1f03,
End : 2620:0:60:1483::1f03,
PrefixLength : 64,
Type : 1,
inUse : 0,
Unused : 1,
Pending : 0,
Unavailable : 0
Range4:
Start : 2620:0:60:1483::4000,
End : 2620:0:60:1483::4500,
PrefixLength : 64,
Type : 2,
inUse : 0,
Unused : 1281,
Pending : 0,
Unavailable : 0

output definitions
General Denotes general DHCPv6 Server statistics.
DHCPv6 Server Name Specifies the name assigned to the DHCPv6 server.
DHCPv6 Server Status Specifies up or down status of the DHCPv6 server.
Total subnets used Specifies the total number of subnets being used.
Total subnets managed Specifies the total number of subnets being managed by the DHCPv6
server.
Total subnets unused Specifies the total number of subnets being unused.
Total subnets full Specifies the total number of subnets where all the IP addresses are
used.
DHCP Server System Up Time Shows the DHCPv6 Server System Up Time Performance Monitor
counter.
Sync time Specifies the time for DHCPv6 server to contact and synchronize with
the designated time server.
Last sync time Specifies the last time the synchronization occurred.
Next sync time Specifies the next time the synchronization should be scheduled.
Packet stats Denotes statistical information about the data packet transmission.
Total DHCP Discovers Specifies the total number of DHCPDISCOVER packets sent by the
clients to the DHCPv6 server.
Total DHCP Offers Specifies the total number of DHCPOFFER packets sent by the server
to the clients.
Total DHCP Requests Specifies the total number of DHCPREQUEST packets sent by the
clients in response to the DHCPOFFER packets.
Total DHCP Request Grants Specifies the total number of DHCPv6 request grants provided by the
server to the clients.

page 21-62 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands show dhcpv6-server statistics

output definitions (continued)

Total DHCP Request Renews Specifies the total number of DHCPv6 lease renew requests sent by the
clients to the DHCPv6 server.
Total DHCP Declines Specifies the total number of DHCPv6 requests declined by the
DHCPv6 server.
Total DHCP Acks Specifies the total number of DHCPACK acknowledgement packets
sent by the DHCPv6 server to the clients.
Total DHCP Nacks Specifies the total number of DHCPv6 Negative acknowledgements
sent from the DHCPv6 server to the clients. The DHCPNACK
message is sent when all the IP addresses available to the server are
exhausted and the client sends a DHCPREQUEST.
Total DHCP Releases Specifies the total number of DHCPRELEASE packets sent by the
DHCPv6 server to release IP addresses from its clients.
Total DHCP Informs Specifies the total number of DHCPINFORM packets sent by the
clients to obtain DHCPv6 options from the DHCPv6 server.
Total Bootp requests Specifies the total number of BOOTP requests sent by the clients to the
DHCPv6 server.
Total Bootp response Specifies the total number of BOOTP response packets sent by the
DHCPv6 server to the clients.
Total Unknown packets Specifies the total number of unknown or badly formatted DHCPv6
packets received by the DHCPv6 server.
Leases stats Denotes statistical information about leases provided by the DHCPv6
server.
Hosts Managed Specifies the total number of clients managed by the DHCPv6 server.
Hosts used Specifies the total number of clients using the IP addresses provided by
the DHCPv6 server.
Hosts unused Specifies the total number of clients managed by the DHCPv6 server
which are not being used.
Hosts Pending Specifies the total number of DHCPv6 IP address requests which are
pending by the DHCPv6 server.
Hosts unavailable Specifies the total number of DHCPv6 hosts which are unavailable (for
example, hosts whose lease period has expired).
Static DHCP Denotes statististical information about the hosts configured with Static
DHCPv6.
Automatic DHCP Denotes statististical information about the hosts configured with
Automatic DHCPv6.
Static BootP Denotes statististical information about the hosts configured under
Static BootP. Note: BootP Relay is disabled when DHCPv6 server is
enabled on the switch.
Automatic BootP Denotes statististical information about the hosts configured with
Automatic BootP.
Subnet statistics Denotes all DHCPv6 related statististical information for individual
subnets.
Range Specifies the range of IP addresses in the individual subnet.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-63
show dhcpv6-server statistics DHCP Relay Commands

output definitions (continued)

Mask Specifies the subnet mask.
Type Specifies whether the type of IP address allocation is dynamic or static.

Release History
Release 8.2.1; command introduced.

Related Commands

clear dhcpv6-server statistics Clears the DHCPv6 Server lease statistics.

MIB Objects
N/A

page 21-64 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands clear dhcpv6-server statistics

clear dhcpv6-server statistics

Clears the packet counters of DHCPv6 server statistics.
clear dhcpv6-server statistics

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use this command to clear the packet counters of DHCPv6 server statistics.

Examples
-> clear dhcpv6-server statistics

Release History
Release 8.2.1; command introduced.

Related Commands

show dhcpv6-server statistics Displays the DHCPv6 Server lease statistics.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-65
dhcp-message-service DHCP Relay Commands

dhcp-message-service
Enable or disable the message service operation.
dhcp-message-service {enable | disable}

Syntax Definitions

enable Enables the operational status of the message service.

disable Disables the operational status of the message service.

Defaults
By default, the operational status of the message service is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The conf and pcy files are parsed when message service is enabled.

• There is one instance of the message service for the default VRF in the switch that can be enabled or
disabled.

Examples
-> dhcp-message-service enable
-> dhcp-message-service disable

Release History
Release 8.2.1; command introduced.

Related Commands

dhcp-message-service restart Restarts the message service after the msgd.conf file is modified.

MIB Objects
alaMsgSrvGlobalConfigStatus

page 21-66 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands dhcp-message-service restart

dhcp-message-service restart
Restarts the message service after the msgd.conf file or dhcpd.pcy is modified.
dhcp-message-service restart

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Before using this command, enable the message service status using the dhcp-message-service command.

Examples
-> message-service restart

Release History
Release 8.2.1; command introduced.

Related Commands

dhcp-message-service Enable or disable the message service operation.

MIB Objects
alaMsgSrvGlobalRestart

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-67
show message-service status DHCP Relay Commands

show message-service status

Displays the status and statistical information related to the message service running on the switch.
show message-service status

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show message-service status
Message Service is enabled

Release History
Release 8.2.1; command introduced.

Related Commands

dhcp-message-service Enable or disable the message service operation.

dhcp-message-service restart Restarts the message service, after the msgd.conf file is modified.

MIB Objects
N/A

page 21-68 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands dhcp-snooping admin-state

dhcp-snooping admin-state
Enables or disables DHCP Snooping for the switch.
dhcp-snooping admin-state {enable | disable}

Syntax Definitions

enable Enables DHCP Snooping for the switch.

disable Disables DHCP Snooping for the switch.

Defaults
By default, this feature is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A.

Examples
-> dhcp-snooping admin-state enable
-> dhcp-snooping admin-state disable

Release History
Release 8.2.1; command introduced.

Related Commands

dhcp-snooping vlan .Enables or disables DHCP Snooping on a per VLAN basis.

show ip helper Displays the current DHCP configuration for the switch.

MIB Objects
dhcpSnoopingTable
dhcpSnoopingMode

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-69
dhcp-snooping mac-address-verification DHCP Relay Commands

dhcp-snooping mac-address-verification
Globally enables or disables MAC address verification for incoming DHCP traffic. When this feature is
enabled, the source MAC address is compared to the client hardware MAC address in the DHCP packet. If
these two addresses do not match, the DHCP packet is dropped.
dhcp-snooping mac-address-verification admin-state {enable | disable}

Syntax Definitions

enable Enables DHCP MAC address verification for the switch.

disable Disables DHCP MAC address verification for the switch.

Defaults
By default, this feature is enabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• DHCP Snooping must be enabled before using this command.

• When DHCP Snooping is enabled at the switch level, MAC address verification and Option-82 data
insertion are enabled by default. In addition, the trust mode for all ports is set to the DHCP client only
mode.
• Changing the enabled or disabled status for MAC address verification is only allowed when DHCP
Snooping is globally enabled for the switch.

Examples
-> dhcp-snooping mac-address-verification admin-state enable
-> dhcp-snooping mac-address-verification admin-state disable

Release History
Release 8.2.1; command introduced.

Related Commands

ip udp relay no statistics .Globally enables or disables DHCP Snooping for the switch.
dhcp-snooping option-82-data- Globally enables or disables DHCP Option-82 data insertion for DHCP
insertion packets.

MIB Objects
dhcpSnoopingTable
dhcpSnoopingMacAddrVerificationStatus

page 21-70 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands dhcp-snooping option-82-data-insertion

dhcp-snooping option-82-data-insertion
Globally enables or disables DHCP Option-82 data insertion for DHCP packets. When this feature is
enabled, the relay agent inserts the Option-82 field into DHCP packets before forwarding them to the
DHCP server.
dhcp-snooping option-82-data-insertion admin-state {enable | disable}

Syntax Definitions

enable Enables inserting the DHCP Option-82 field into DHCP packets.
disable Disables inserting the DHCP Option-82 field into DHCP packets.

Defaults
By default, this feature is enabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• DHCP Snooping must be enabled before using this command.

• When DHCP Snooping is enabled at the switch level, Option-82-data-insertion and MAC address
verification are enabled by default. In addition, the trust mode for all ports is set to the DHCP client
only mode.

Examples
-> dhcp-snooping option-82-data-insertion admin-state enable
-> dhcp-snooping option-82-data-insertion admin-state disable

Release History
Release 8.2.1; command introduced.

Related Commands

dhcp-snooping option-82 Configures the type of information that is inserted in both the Circuit ID
format and Remote ID sub option of the Option-82 field.
ip udp relay no statistics .Globally enables or disables DHCP Snooping for the switch.
dhcp-snooping ip-source-filter Enables or disables the DHCP Snooping binding table functionality
show ip helper Displays the current DHCP configuration for the switch.

MIB Objects
dhcpSnoopingTable
dhcpSnoopingOpt82InsertionStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-71
dhcp-snooping bypass option-82-check DHCP Relay Commands

dhcp-snooping bypass option-82-check

Enables or disables checking for an Option-82 field in DHCP packets ingressing on untrusted ports.
dhcp-snooping bypass option-82-check admin-state {enable | disable}

Syntax Definitions

enable Bypasses the Option-82 field check.

disable Checks DHCP packets for the Option-82 field.

Defaults
By default, this feature is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When this feature is disabled (the default), DHCP packets ingressing on untrusted ports are checked to
see if they contain the Option-82 field. If this field is present, the DHCP packet is discarded.
• When this feature is enabled, DHCP packets ingressing on untrusted ports are not checked to see if
they contain the Option-82 field. In this case, the Option-82 field is ignored and all DHCP packets are
processed.
• Using this command is only allowed when DHCP Snooping is enabled globally for the switch or at the
VLAN level.

Examples
-> dhcp-snooping bypass option-82-check admin-state enable
-> dhcp-snooping bypass option-82-check admin-state disable

Release History
Release 8.2.1; command introduced.

Related Commands

ip udp relay no statistics Globally enables or disables DHCP Snooping for the switch.
show ip helper Displays the current DHCP configuration for the switch.

MIB Objects
dhcpSnoopingTable
dhcpSnoopingBypassOpt82CheckStatus

page 21-72 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands dhcp-snooping option-82 format

dhcp-snooping option-82 format

Configures the type of information that is inserted into both the Circuit ID and Remote ID sub option
fields of the Option-82 field.
dhcp-snooping option-82 format [base-mac | system-name | user-string string | interface-alias | auto-
interface-alias | ascii [{ remote-id | circuit-id} {base-mac | cvlan | interface | interface-alias | system-
name | user-string string | vlan} {delimiter string}]]
no dhcp-snooping option-82 format [base-mac | system-name | user-string string | interface-alias |
auto-interface-alias | ascii [{ remote-id | circuit-id} {base-mac | cvlan | interface | interface-alias |
system-name | user-string string | vlan} {delimiter string}]]

Syntax Definitions

user-string A user defined text string. Supports up to 64 characters.

system-name The system name of the switch.
interface-alias The alias configured for the interface.
base-mac The base MAC address of the switch.
auto-interface-alias The switch automatically generates the interface-alias in the following
format: SystemName_slot_port.
asciiASCII format.
ascii ASCII format.
remote-id | circuit-id: Select the sub-id fields of option-82 to configure
ascii.
vlan: The VLAN ID of which the client is a member.
string: A user-defined text string.
system-name: The system name of the switch.
interface-alias: The alias configured for the interface.
interface: The interface name.
cvlan: The Customer VLAN ID.
base-mac: The base MAC address of the switch.
delimiter: The delimiter character that separates fields within the
Circuit ID and Remote ID ASCII string value. Valid characters are |
(pipe), \ (backward slash), / (forward slash), - (dash), _ (underscore),
and “ “ (space).

Defaults

parameter default
user-string string | system- base-mac
name | interface-alias | base-
mac | auto-interface-alias |
ascii
ascii base-mac

Platforms Supported
OmniSwitch 6860, 6860E

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-73
dhcp-snooping option-82 format DHCP Relay Commands

Usage Guidelines
• The string parameter specifies user-defined information to insert into the Circuit ID and Remote ID
fields.
• When entering a string for user-defined Option-82 information, quotes are required around ambiguous
characters, such as hex characters, spaces, etc, so they are interpreted as text. For example, the string
“Building B Server” requires quotes because of the spaces between the words.
• The interface-alias parameter will use the alias configured with the interfaces alias command. If no
alias is configured a NULL string will be inserted.
• A maximum of 63 characters can be inserted when using the interface-alias and auto-interface-alias
commands, remaining characters will be truncated.
• The Option-82 format option is a global setting, the format specified will be applied to all ports on the
switch.
• The data specified with this command is added to the Circuit ID and Remote ID fields only when
DHCP Option-82 data insertion is enabled for the switch.
• When DHCP Snooping is enabled at the switch level, Option-82 data insertion is enabled by default.

• The ASCII option is used to specify the type of information that is configured in ASCII text string
format and then inserted into the Option-82 Circuit ID sub option. Each parameter provided with this
command represents a different type of information.
• Configuring the Circuit ID or Remote ID sub option in ASCII format allows up to five fields (types) of
information within the ASCII string. However, if the contents of all the fields combined exceeds 127
characters, then the ASCII string is truncated.
• Specifying at least one parameter with ASCII option is required. If multiple parameters are selected,
then specifying one of the valid delimiter characters is also required.
• Use the no form of this command to remove the type of information that is inserted into both the
Circuit ID and Remote ID sub option fields of the Option-82 field.s option-82-check admin-state
disable.

Examples
-> dhcp-snooping option-82 format user-string “Building B Server”
-> dhcp-snooping option-82 format system-name
-> dhcp-snooping option-82 format base-mac
-> dhcp-snooping option-82 format interface-alias
-> dhcp-snooping option-82 format auto-interface-alias
-> no dhcp-snooping option-82 format user-string “Building B Server”

Release History
Release 8.2.1; command introduced.

page 21-74 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands dhcp-snooping option-82 format

Related Commands

dhcp-snooping option-82-data- Globally enables or disables DHCP Option-82 data insertion for DHCP
insertion packets..
ip udp relay no statistics Globally enables or disables DHCP Snooping for the switch
show ip helper Displays the current DHCP configuration for the switch.

MIB Objects
dhcpSnoopingOption82FormatType
dhcpOption82FormatInterfaceAliasAutoGen
dhcpSnoopingOption82StringValue
dhcpSnoopingOption82FormatASCIIConfigurableEntry
dhcpSnoopingOption82FormatASCIIConfigurableIndex
dhcpSnoopingOption82FormatASCIIConfigurableField1
dhcpSnoopingOption82FormatASCIIConfigurableField1StringValue
dhcpSnoopingOption82FormatASCIIConfigurableConfigurableField2
dhcpSnoopingOption82FormatASCIIConfigurableField2StringValue
dhcpSnoopingOption82FormatASCIIConfigurableField3
dhcpSnoopingOption82FormatASCIIConfigurableField3StringValue
dhcpSnoopingOption82FormatASCIIConfigurableField4
dhcpSnoopingOption82FormatASCIIConfigurableField4StringValue
dhcpSnoopingOption82FormatASCIIConfigurableField5
dhcpSnoopingOption82FormatASCIIConfigurableField5StringValue
dhcpSnoopingOption82FormatASCIIConfigurableDelimiter

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-75
dhcp-snooping vlan DHCP Relay Commands

dhcp-snooping vlan
Enables or disables DHCP Snooping on a per VLAN basis. When this feature is enabled, all DHCP
packets received on ports associated with the DHCP Snooping VLAN are filtered.
dhcp-snooping vlan vlan_id [mac-address-verification {enable | disable}] [option-82-data-insertion
{enable | disable}] [admin-state]
no dhcp-snooping vlan vlan_id

Syntax Definitions

vlan_id The VLAN identification number (1–4094).

mac-address verification Enables or disables verifying the source MAC address of DHCP packets
with the client MAC address contained in the same packet.
option-82 data-insertion Enables or disables inserting Option-82 information into DHCP packets.
admin-state Enables or disables DHCP snooping feature for specified VLAN.

Defaults
By default, DHCP Snooping is disabled. When this feature is enabled for the specified VLAN, the
following default parameter values apply:

parameter default
mac-address verification Enabled
option-82 data-insertion Enabled

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable DHCP Snooping for the specified VLAN.

• The MAC address verification and Option-82 data insertion are applied to packets received on ports
associated with the DHCP Snooping VLAN.
• If the DHCP relay agent Option-82 feature is enabled, DHCP Snooping is not available. These two
features are mutually exclusive.
• If the DHCP Snooping feature is globally enabled for the switch, then configuring snooping on a per-
VLAN basis is not allowed. The opposite is also true; invoking VLAN based snooping prevents the use
of switch level snooping.
• Note that disabling the Option-82 data insertion operation for a VLAN is not allowed when the binding
table functionality is enabled.

page 21-76 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands dhcp-snooping vlan

Examples
-> dhcp-snooping vlan 100 admin-state enable
-> dhcp-snooping vlan 100 admin-state disable
-> dhcp-snooping vlan 100 admin-state enable mac-address-verification enable

Release History
Release 8.2.1; command introduced.

Related Commands

ip udp relay no statistics Globally enables or disables DHCP Snooping for the switch.
dhcp-snooping ip-source-filter Enables or disables the DHCP Snooping binding table functionality

MIB Objects
dhcpSnoopingVlanTable
dhcpSnoopingVlanNumber
dhcpSnoopingVlanMacVerificationStatus
dhcpSnoopingVlanOpt82DataInsertionStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-77
dhcp-snooping port DHCP Relay Commands

dhcp-snooping port
Configures the DHCP Snooping trust mode for the port. The trust mode determines if the port will accept
all DHCP traffic, block all DHCP traffic, or accept only client DHCP traffic.
dhcp-snooping port chassis/slot1/port1[-port1a] {block | client-only | trust}

Syntax Definitions

chassis/slot1/port1[-port1a] Specifies the chassis ID, slot number for the module and the physical
port number on that module (e.g. 1/3/1 specifies chassis 1 of port 1 on
slot 3). Use a hyphen to specify a range of ports (e.g. 1/3/1-16).
block Blocks all DHCP traffic on the port.
client-only Allows only DHCP client traffic on the port.
trust Allows all DHCP traffic on the port. The port behaves as if DHCP
Snooping was not enabled.

Defaults
By default, the trust mode for a port is set to client-only when the DHCP Snooping feature is enabled for
the switch or for a VLAN.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The DHCP trust mode only applies when the DHCP Snooping feature is enabled for the switch or for a
VLAN.
• If DHCP Snooping is enabled at the switch level, the trust mode applies to all switch ports.

• If DHCP Snooping is enabled for a specific VLAN, then the trust mode applies to only those ports that
are associated with that VLAN.
• Use the show dhcp-snooping port command to display the current trust mode for a port and statistics
regarding the number of packets dropped due to DHCP Snooping violations.

Examples
-> dhcp-snooping port 1/1/24 trust
-> dhcp-snooping port 1/1/1-10 block
-> dhcp-snooping port 1/1/8 client-only

Release History
Release 8.2.1; command introduced.

page 21-78 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands dhcp-snooping port

Related Commands

ip udp relay no statistics Globally enables or disables DHCP Snooping for the switch.
dhcp-snooping vlan Enables or disables DHCP Snooping on a per-VLAN basis.

MIB Objects
dhcpSnoopingPortTable
dhcpSnoopingPortIfIndex
dhcpSnoopingPortTrustMode

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-79
dhcp-snooping linkagg DHCP Relay Commands

dhcp-snooping linkagg
Configures the DHCP Snooping trust mode for the link aggregate. The trust mode determines if the link
aggregate will accept all DHCP traffic, block all DHCP traffic, or accept only client DHCP traffic.
dhcp-snooping linkagg agg_id {block | client-only | trust}

Syntax Definitions

agg_id Specifies the link aggregate ID number.

block Blocks all DHCP traffic on the link aggregate.
client-only Allows only DHCP client traffic on the link aggregate.
trust Allows all DHCP traffic on the link aggregate. The port behaves as if
DHCP Snooping was not enabled.

Defaults
By default, the trust mode for a link aggregate is set to client-only when the DHCP Snooping feature is
enabled for the switch or for a VLAN.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The DHCP trust mode only applies when the DHCP Snooping feature is enabled for the switch or for a
VLAN.
• If DHCP Snooping is enabled at the switch level, the trust mode applies to all link aggregates.

• If DHCP Snooping is enabled for a specific VLAN, then the trust mode applies to only those link
aggregates that are associated with that VLAN.
• Use the show dhcp-snooping port command to display the current trust mode for a link aggregate and
statistics regarding the number of packets dropped due to DHCP Snooping violations.

Examples
-> dhcp-snooping linkagg 1 trust
-> dhcp-snooping linkagg 2 block
-> dhcp-snooping linkagg 3 client-only

Release History
Release 8.2.1; command introduced.

page 21-80 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands dhcp-snooping linkagg

Related Commands

ip udp relay no statistics Globally enables or disables DHCP Snooping for the switch.
dhcp-snooping vlan Enables or disables DHCP Snooping on a per-VLAN basis.

MIB Objects
dhcpSnoopingPortTable
dhcpSnoopingPortIfIndex
dhcpSnoopingPortTrustMode

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-81
dhcp-snooping ip-source-filter DHCP Relay Commands

dhcp-snooping ip-source-filter
Enables or disables the IP source filtering capability at a port, link aggregation, or VLAN level. When this
function is enabled, the switch allows the traffic that matches the client IP address, MAC address, port,
and VLAN combination obtained from the DHCP snooping binding table entry.
dhcp-snooping ip-source-filter {vlan vlan_id | port chassis/slot/port[-port2] | linkagg agg_id} admin-
state {enable | disable}

Syntax Definitions

vlan_id The VLAN identification number (1–4094).

chassis/slot1/port1[-port2] Specifies the chassis and slot number for the module and the physical
port number on that module. Use a hyphen to specify a range of ports.
agg_id Specifies the link aggregate identification number.
enable Enables IP source filtering for the specified port, link aggregation, or
VLAN.
disable Disables IP source filtering for the specified port, link aggregation, or
VLAN level.

Defaults
By default, IP source filtering is disabled for a port or link aggregate, or VLAN.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Source filtering can be enabled only on the VLANs on which the DHCP Snooping is enabled.

• Source filtering can be enabled

– on the ports that are associated with a VLAN on which DHCP Snooping is enabled.
– on all the ports when DHCP Snooping is globally enabled for the switch.

Examples
-> dhcp-snooping ip-source-filter port 1/1/1 enable
-> dhcp-snooping ip-source-filter linkagg 2 enable
-> dhcp-snooping ip-source-filter vlan 10 enable
-> dhcp-snooping ip-source-filter vlan 20 disable

Release History
Release 8.2.1; command introduced.

page 21-82 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands dhcp-snooping ip-source-filter

Related Commands

show ip udp relay Displays the ports or VLANs on which IP source filtering is enabled.

MIB Objects
dhcpSnoopingPortIpSourceFiltering
dhcpSnoopingPortIfIndex
dhcpSourceFilterVlanNumber
dhcpSourceFilterVlanFilteringStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-83
dhcp-snooping binding admin-state DHCP Relay Commands

dhcp-snooping binding admin-state

Enables or disables the DHCP Snooping binding table functionality. The binding table contains the MAC
address, IP address, lease time, binding type (dynamic or static), VLAN number, and the interface
information that corresponds to a local untrusted port on the switch.
dhcp-snooping binding admin-state {enable | disable}

Syntax Definitions

enable Enables the creation of binding table entries.

disable Disables the creation of binding table entries.

Defaults
By default, the binding table functionality is enabled when the DHCP Snooping feature is enabled for the
switch or for a VLAN.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Note that enabling the binding table functionality is not allowed if Option-82 data insertion is not enabled
at either the switch or VLAN level.

Examples
-> dhcp-snooping binding admin-state disable
-> dhcp-snooping binding admin-state enable

Release History
Release 8.2.1; command introduced.

Related Commands

dhcp-snooping binding timeout Configures the amount of time between each automatic save of the
binding table contents to a file on the switch.
dhcp-snooping binding action Synchronizes the contents of the DHCP Snooping binding table with the
contents of the dhcpBinding.db file saved on the switch.

MIB Objects
dhcpSnoopingBindingTable
dhcpSnoopingBindingStatus

page 21-84 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands dhcp-snooping binding timeout

dhcp-snooping binding timeout

Configures the amount of time between each automatic save of the DHCP Snooping binding table
contents maintained in memory to a file on the switch. This functionality preserves binding table contents
across switch reboots.
dhcp-snooping binding timeout seconds

Syntax Definitions

seconds The number of seconds (60 to 600) to wait before the next save.

Defaults
By default, the timeout value is set to 300 seconds.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The timeout value is only valid if the DHCP Snooping binding table functionality is enabled.

• The contents of the binding table is saved to the dhcpBinding.db file in the /flash/switch directory.

• The dhcpBinding.db file is time stamped when a save of the binding table contents is successfully
completed.

Examples
-> dhcp-snooping binding timeout 600
-> dhcp-snooping binding timeout 250

Release History
Release 8.2.1; command introduced.

Related Commands

dhcp-snooping ip-source-filter .Enables or disables the DHCP Snooping binding table functionality.
dhcp-snooping binding action Synchronizes the contents of the DHCP Snooping binding table with the
contents of the dhcpBinding.db file saved on the switch.

MIB Objects
dhcpSnoopingBindingTable
iphelperDhcpSnoopingBindingDatabaseSyncTimeout

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-85
dhcp-snooping binding action DHCP Relay Commands

dhcp-snooping binding action

Triggers a purge or renew action against the DHCP Snooping binding table. A purge action clears the
contents of the table. A renew action populates the table with entries saved in the dhcpBinding.db file.
dhcp-snooping binding action {purge | renew}

Syntax Definitions

purge Clears all binding table entries that are maintained in switch memory.
renew Populates the binding table with entries saved in the dhcpBinding.db
file located in the /flash/switch directory on the switch.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The DHCP Snooping binding table is maintained in the switch memory. Binding table entries are saved on
a periodic basis to the dhcpBinding.db file on the switch. Use the purge and renew options available
with this command to sync the binding table contents with the contents of the dhcpBinding.db file.

Examples
-> dhcp-snooping binding action purge
-> dhcp-snooping binding action renew

Release History
Release 8.2.1; command introduced.

Related Commands

dhcp-snooping ip-source-filter .Enables or disables the DHCP Snooping binding table functionality.
dhcp-snooping binding timeout Configures the amount of time between each automatic save of the
binding table contents to a file on the switch.

MIB Objects
dhcpSnoopingBindingDatabaseAction

page 21-86 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands dhcp-snooping binding persistency

dhcp-snooping binding persistency

Retains the entries in the DHCP Snooping binding table for the duration of the lease regardless of the
existence of the MAC address in the MAC address table.
dhcp-snooping binding persistency admin-state {enable | disable}

Syntax Definitions

enable Enables DHCP Snooping binding persistency.

disable Disables DHCP Snooping binding persistency.

Defaults
By default, DHCP Snooping binding persistency is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• With this option disabled, the entry will be removed if the MAC address is missing from the MAC
address table when the database is synchronized.
• Use the show ip helper command to display the current status.

Examples
-> dhcp-snooping binding persistency admin-state enable
-> dhcp-snooping binding persistency admin-state disable

Release History
Release 8.2.1; command introduced.

Related Commands

dhcp-snooping ip-source-filter Enables or disables the DHCP Snooping binding table functionality.
dhcp-snooping binding timeout Configures the amount of time between each automatic save of the
binding table contents to a file on the switch.

MIB Objects
dhcpSnoopingBindingPersistencyStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-87
dhcp-snooping binding DHCP Relay Commands

dhcp-snooping binding
Creates a static entry in the binding table.
dhcp-snooping binding mac_address port chassis/slot/port address ip_address vlan vlan_id
no dhcp-snooping binding mac_address port chassis/slot/port address ip_address vlan vlan_id

Syntax Definitions

mac_address The client MAC address.

chassis/slot/port The chassis, slot, and port number that received the DHCP request.
ip_address The IP address that the DHCP server offered to the client.
vlan_id The VLAN identification number (1–4094) of the VLAN to which the
client belongs.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Static binding table entries are created using this command. If DHCP Snooping binding table
functionality is not enabled, creating a static entry is not allowed.
• Dynamic binding table entries are created when the relay agent receives a DHCPACK packet.

• Use the no form of this command to remove a static entry from the DHCP Snooping binding table.

Examples
-> dhcp-snooping binding 00:2a:95:51:6c:10 port 1/1/15 address 17.15.3.10 vlan 200
-> no dhcp-snooping binding 00:2a:95:51:6c:10 port 1/1/15 address 17.15.3.10 vlan
200

Release History
Release 8.2.1; command introduced.

page 21-88 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands dhcp-snooping binding

Related Commands

dhcp-snooping binding timeout Configures the amount of time between each automatic save of the
binding table contents to a file on the switch.
dhcp-snooping binding action Synchronizes the contents of the DHCP Snooping binding table with the
contents of the dhcpBinding.db file saved on the switch.

MIB Objects
dhcpSnoopingBindingTable
dhcpSnoopingBindingMacAddress
dhcpSnoopingBindingIfIndex
dhcpSnoopingBindingIpAddress
dhcpSnoopingBindingVlan
dhcpSnoopingBindingRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-89
show dhcp-snooping ip-source-filter DHCP Relay Commands

show dhcp-snooping ip-source-filter

Displays the ports or VLANs on which IP source filtering is enabled.
show dhcp-snooping ip-source-filter {vlan | port}

Syntax Definitions

vlan Displays the VLANs on which IP source filtering is enabled.

port Displays the ports on which IP source filtering is enabled.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The show output displays only those ports or VLANs on which IP source filtering is enabled.

• This command also displays the status of the link aggregate ports when source filtering is enabled at
VLAN or port level.

Examples
-> show dhcp-snooping ip-source-filter port
Slot IP Src
Port Filtering
------+-----------
1/7 Enabled
1/12 Enabled

output definitions
Slot/Port Specifies the slot and port number.
IP Src Filtering Specifies if IP source filtering status. Enabled or Disabled.

-> show dhcp-snooping ip-source-filter vlan

Vlan ID IP Src Filtering
-------+-----------
10 Enabled
11 Enabled
12 Enabled
13 Enabled

output definitions
Vlan ID VLAN number.
IP Src Filtering Specifies if IP source filtering status. Enabled or Disabled.

page 21-90 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands show dhcp-snooping ip-source-filter

Release History
Release 8.2.1; command introduced.

Related Commands

dhcp-snooping ip-source-filter Enables or disables the IP source filtering at a port, link aggregation, or
VLAN level.

MIB Objects
dhcpSnoopingPortIpSourceFiltering
dhcpSnoopingPortIfIndex
dhcpSourceFilterVlanNumber
dhcpSourceFilterVlanFilteringStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-91
show dhcp-snooping vlan DHCP Relay Commands

show dhcp-snooping vlan

Displays a list of VLANs that have DHCP Snooping enabled and whether or not MAC address verification
and Option-82 data insertion is enabled for each VLAN.
show dhcp-snooping vlan

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command only applies if DHCP Snooping is enabled at the VLAN level.

• Use the show ip helper command to determine the status of DHCP Snooping at the switch level.

Examples
-> show dhcp-snooping vlan
VLAN Opt82 MAC Addr
ID Insertion Verification
------+----------+--------------
50 Enabled Enabled
60 Enabled Enabled
100 Disabled Enabled
200 Enabled Disabled
1500 Disabled Disabled

output definitions
VLAN ID The VLAN identification number for the DHCP Snooping VLAN.
MAC Address Verification Indicates whether or not MAC address verification is enabled for the
VLAN (Enabled or Disabled). Configured through the dhcp-snooping
vlan command.
Opt-82 Data Insertion Indicates whether or not Option-82 data insertion is enabled for the
VLAN (Enabled or Disabled). Configured through the dhcp-snooping
vlan command.

Release History
Release 8.2.1; command introduced.

page 21-92 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands show dhcp-snooping vlan

Related Commands

show ip helper Displays current DHCP Relay configuration information.

show dhcp-snooping port Displays the trust mode and DHCP violation statistics for all switch
ports that are filtered by DHCP Snooping.

MIB Objects
dhcpSnoopingVlanTable
dhcpSnoopingVlanNumber
dhcpSnoopingVlanMacVerificationStatus
dhcpSnoopingVlanOpt82DataInsertionStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-93
show dhcp-snooping port DHCP Relay Commands

show dhcp-snooping port

Displays the trust mode and DHCP Snooping violation statistics for all switch ports that are filtered by
DHCP Snooping.
show dhcp-snooping port

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If DHCP Snooping is operating at the switch level, then information for all switch ports is displayed.

• If DHCP Snooping is operating at the VLAN level, then information for only those ports that are
associated with a DHCP Snooping VLAN is displayed.
• The violation statistics displayed only apply to ports that are in the client only trust mode. When the
trust mode for a port is changed from client-only to trusted or blocked, the violation counters are set
to zero (0).

Examples
-> show dhcp-snooping port
Slot Trust IP Src Opt82 MAC Server Relay Binding
Port Mode Filtering Violation Violation Violation Violation Violation
-----+-------------+----------+----------+----------+----------+---------|---------
1/1 Blocked Disabled 0 0 0 0 0
1/2 Client-Only Enabled 0 0 0 0 0
1/3 Client-Only Enabled 0 0 0 0 0
1/4 Client-Only Enabled 0 0 0 0 0
1/5 Client-Only Enabled 0 0 0 0 0
1/6 Blocked Disabled 0 0 0 0 0
1/7 Client-Only Enabled 0 0 0 0 0
1/8 Client-Only Enabled 0 0 0 0 0
1/9 Client-Only Enabled 0 0 0 0 0
1/10 Trusted Disabled 0 0 0 0 0
1/11 Trusted Disabled 0 0 0 0 0
1/12 Trusted Disabled 0 0 0 0 0

page 21-94 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands show dhcp-snooping port

output definitions
Slot/Port The slot number for the module and the physical port number on that
module (e.g., 3/1 specifies port 1 on slot 3).
Trust Mode The DHCP Snooping trust mode for the port (Blocked, Client-Only, or
Trusted). Configured through the dhcp-snooping port command.
IP Src Filtering Indicates whether or not IP source filtering is enabled for the port
(Enabled or Disabled). Configured through the dhcp-snooping ip-
source-filter command.
Opt82 Violation The number of DHCP packets dropped due to a DHCP Snooping
Option-82 violation.
MAC Violation The number of DHCP packets dropped due to a mismatch between the
packet source MAC address and the client hardware address contained
within the packet.
Server Violation The number of DHCP server packets dropped because they originated
from outside the network or firewall.
Relay Violation The number of DHCP packets dropped because the packet included a
relay agent IP address that was not 0.0.0.0.
Binding Violation The number of DHCP packets dropped due to a mismatch between
packets received and binding table information.

Release History
Release 8.2.1; command introduced.

Related Commands

show ip helper Displays current DHCP Relay configuration information.

show dhcp-snooping vlan Displays a list of DHCP Snooping VLANs.

MIB Objects
dhcpSnoopingPortTable
dhcpSnoopingPortIfIndex
dhcpSnoopingPortTrustMode
dhcpSnoopingPortIpSourceFiltering
dhcpSnoopingPortOption82Violation
dhcpSnoopingPortMacAddrViolation
dhcpSnoopingPortDhcpServerViolation
dhcpSnoopingPortRelayAgentViolation
dhcpSnoopingPortBindingViolation

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-95
show dhcp-snooping binding DHCP Relay Commands

show dhcp-snooping binding

Displays the contents of the DHCP Snooping binding table (database).
show dhcp-snooping binding

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the dhcp-snooping ip-source-filter command to create a static entry in the binding table.

• Dynamic binding table entries are created when the relay agent receives a DHCPACK packet.

Examples
-> show dhcp-snooping binding
MAC Slot IP Lease VLAN Binding
Address Port Address Time ID Type
-------------------+------+---------------+---------+-------+-----------
00:ae:22:e4:00:08 1/4 10.255.11.23 2000 5 Dynamic
10:fe:a2:e4:32:08 2/15 10.255.91.53 2000 2 Dynamic

output definitions
MAC Address The MAC address of the client.
Slot/Port The slot/port designation for the switch port that received the DHCP
request
IP Address The IP address offered by the DHCP server.
Lease Time The IP address lease time assigned by the DHCP server. A value of 0
indicates a static entry.
VLAN ID The VLAN ID of the VLAN to which the client belongs.
Binding Type Indicates whether the binding table entry is dynamic or static. Static
entries are created using the dhcp-snooping binding command.

Release History
Release 8.2.1; command introduced.

page 21-96 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DHCP Relay Commands show dhcp-snooping binding

Related Commands

show ip helper Displays current DHCP Relay configuration information.

show dhcp-snooping vlan Displays a list of DHCP Snooping VLANs.
show dhcp-snooping port Displays the trust mode and DHCP violation statistics for all switch
ports that are filtered by DHCP Snooping.

MIB Objects
dhcpSnoopingBindingStatus
dhcpSnoopingBindingTable
dhcpSnoopingBindingMacAddress
dhcpSnoopingBindingIfIndex
dhcpSnoopingBindingIpAddress
dhcpSnoopingBindingLeaseTime
dhcpSnoopingBindingVlan
dhcpSnoopingBindingType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 21-97
show dhcp-snooping binding DHCP Relay Commands

page 21-98 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 22 VRRP Commands

The Virtual Router Redundancy Protocol (VRRP) eliminates the single point of failure in a default route
environment. VRRP specifies an election protocol that dynamically assigns responsibility for a virtual
router to one of the VRRP/VRRP3 routers on the LAN. The VRRP/VRRP3 router, which controls the IP/
IPv6 address associated with a virtual router is called the master router, and forwards packets to that IP/
IPv6 address. If the master router becomes unavailable, the highest priority backup router will transition to
the master state. The Alcatel-Lucent implementation of VRRP also supports the collective management of
virtual routers on a switch.

Note. VRRP3 does not support the collective management functionality in this release.

The VRRP and VRRP3 commands comply with RFC 2787 and RFC 3768, respectively.
MIB information is as follows:
Filename: IETF-VRRP.MIB
Module: VRRP-MIB
Filename: AlcatelIND1VRRP.MIB
Module: ALCATEL-IND1-VRRP-MIB
Filename: AlcatelIND1VRRP3.MIB
Module: ALCATEL-IND1-VRRP3-MIB

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-1
 VRRP Commands

A summary of the available VRRP commands is listed here:

vrrp
vrrp address
vrrp track
vrrp track-association
vrrp trap
vrrp delay
vrrp interval
vrrp priority
vrrp preempt
vrrp all
vrrp set
vrrp group
vrrp group all
vrrp group set
vrrp group-association
vrrp3
vrrp3 address
vrrp3 trap
vrrp3 track-association
show vrrp
show vrrp statistics
show vrrp track
show vrrp track-association
show vrrp group
show vrrp group-association
show vrrp3
show vrrp3 statistics
show vrrp3 track-association

page 22-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands vrrp

vrrp
Configures a new VRRP virtual router or modifies an existing one. Used to enable or disable a virtual
router.
vrrp vrid vlan_id admin-state [enable | disable] [priority priority] [preempt | no preempt]
[[advertising] interval seconds]
no vrrp vrid vlan_id

Syntax Definitions

vrid The virtual router ID, in the range from 1–255.

vlan_id The VLAN on which the virtual router is configured. The VLAN must
already be created and available on the switch.
enable Enables the virtual router. A virtual router may only be enabled if an IP
address is configured for the virtual router.
disable Disables the virtual router. Cannot be combined on the same line with
other parameters.
priority The priority for this virtual router to become the master router. The
range is 1 (lowest priority) to 255 (highest priority). The priority should
be set to 255 only if this router is the actual owner of the virtual router’s
IP address.
preempt Specifies that a higher priority router may preempt a lower priority mas-
ter router.
no preempt Specifies that a higher priority router may not preempt a lower priority
master router.
seconds The interval in seconds after which the master router will send VRRP
advertisements. The advertising interval must be same for all VRRP
routers configured with the same VRID. The valid range is 1–255 sec-
onds.

Defaults

parameter default
enable | disable disable
priority 100
preempt | no preempt preempt
seconds 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a virtual router from the configuration.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-3
vrrp VRRP Commands

• Use the vrrp address command to configure an IP address for the virtual router. This must be done
before the virtual router can be enabled.
• To disable the virtual router, rather than to remove it, use the disable. Note that disable cannot be used
with any other optional parameter.
• A virtual router must be disabled before it can be modified.

• Advertising is an optional command parameter. When prefaced before interval, it displays the same
information as vrrp vrid vlan_id intervaformation about configuring priority:
• A value of 255 indicates that the VRRP router owns the IP address; that is, the router contains the real
physical interface to which the IP address is assigned. The system automatically sets this value to 255
if it detects that this router is the IP address owner. If the priority is set to 255 and the virtual router is
not the IP address owner, then the priority will be set to the default value of 100. The IP address owner
will always be the master router if it is available.
• VRRP routers backing up a virtual router must use priority values from 1 to 255. The default priority
value for VRRP routers backing up a virtual router is 100. If you configure more than one backup, their
priority values should be different. The preempt or no preempt setting specifies whether or not a
higher priority router may preempt a lower priority master router.

Examples
-> vrrp 23 1 priority 75
-> vrrp 23 1 admin-state enable

Release History
Release 8.1.1; command was introduced.

Related Commands

vrrp address Configures an IP address for a virtual router.

show vrrp Displays the virtual router configuration for all virtual routers or for a
specific virtual router.

MIB Objects
alaVrrp3OperTable
alaVrrp3OperAdminState
alaVrrp3OperPriority
alaVrrp3OperPreemptMode
alaVrrp3OperAdvertisementinterval
alaVrrp3OperRowStatus

page 22-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands vrrp address

vrrp address
Configures an IP address for a virtual router.
vrrp vrid vlan_id address ip_address
vrrp vrid vlan_id no address ip_address

Syntax Definitions

vrid The virtual router ID, in the range from 1–255.

vlan_id The VLAN on which the virtual router is configured.
ip_address The virtual IP address associated with the specified virtual router.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• A virtual router IP address must be configured before the virtual router can be enabled.

• ip is an optional command parameter. It displays the same information as vrrp address.

Examples
-> vrrp 1 3 address 10.10.3.2
-> vrrp 1 3 no address 10.10.3.2

Release History
Release 8.1.1; command was introduced.

Related Commands

vrrp Configures a new VRRP virtual router or modifies an existing one. Used
to enable to disable a virtual router.
show vrrp statistics Displays statistics about VRRP packets for all virtual routers configured
on the switch or for a specific virtual router.

MIB Objects
alaVrrp3AssoIpAddrTable
alaVrrp3AssoIpAddrRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-5
vrrp track VRRP Commands

vrrp track
Creates a new tracking policy or modifies an existing tracking policy.
vrrp track track_id admin-state [enable | disable] [priority value] [ipv4-interface name | ipv6-inter-
face name | port chassis//slot/port | address address]
no vrrp track track_id

Syntax Definitions

track_id The ID of the tracking policy; the range is 1 to 255.

enable Enables the tracking policy.
disable Disables the tracking policy.
value The value to be decremented from the priority value of the virtual router
monitoring this tracking policy when the operational state of the track-
ing policy is down. The valid range is 0–255.
name The name of the IPv4 or IPv6 interface that this policy will track.
chassis The chassis identifier.
slot/port The slot/port number that this policy will track.
address The remote IP or IPv6 address that this policy will track.

Defaults

parameter default
enable | disable enable
value 25

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a tracking policy.

• Use the disable option to disable the tracking policy, rather than removing it from the switch.

page 22-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands vrrp track

Examples
-> vrrp track 2 admin-state enable priority 50 ipv4-interface Marketing
-> vrrp track 3 admin-state enable priority 60 ipv6-interface Sales
-> vrrp track 3 admin-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

vrrp track-association Associates a VRRP tracking policy with a virtual router.

show vrrp track Displays information about tracking policies on the switch.

MIB Objects
alaVRRPTrackTable
alaVrrpTrackState
alaVrrpTrackAdminState
alaVrrpTrackPriority
alaVrrpTrackEntityType
alaVrrpTrackEntityVlan
alaVrrpTrackEntityPort
alaVrrpTrackEntityIpAddress
alaVrrpTrackEntityIpv6Interface
alaVrrpTrackEntityInterface
alaVrrpTrackRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-7
vrrp track-association VRRP Commands

vrrp track-association
Associates a VRRP tracking policy with a virtual router.
vrrp vrid vlan_id track-association track_id
vrrp vrid vlan_id no track-association track_id

Syntax Definitions

vrid The virtual router ID, in the range from 1–255.

vlan_id The VLAN ID of the virtual router.
track_id The ID of the tracking policy associated with the virtual router; the
range is 1 to 255.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to remove a tracking policy from a virtual router.

Examples
-> vrrp 2 4 track-association 1
-> vrrp 2 4 no track-association 1

Release History
Release 8.1.1; command was introduced.

Related Commands

vrrp Configures a new VRRP virtual router or modifies an existing one. Used
to enable or disable a virtual router.
show vrrp track-association Displays the tracking policies associated with virtual routers.

MIB Objects
alaVrrpAssoTrackTable
alaVrrpAssoTrackId
alaVrrpTrackRowStatus

page 22-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands vrrp trap

vrrp trap
Enables or disables SNMP traps for VRRP.
vrrp trap
no vrrp trap

Syntax Definitions

N/A

Defaults
By default, SNMP traps for VRRP are enabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
SNMP traps must be enabled globally on the switch for VRRP traps to actually be sent.

Examples
-> vrrp trap
-> no vrrp trap

Release History
Release 8.1.1; command was introduced.

Related Commands

snmp-trap filter-ip Enables or disables SNMP trap filtering.

MIB Objects
vrrpOperGroup
vrrpNotificationCntl

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-9
vrrp delay VRRP Commands

vrrp delay
Configures the amount of time allowed for routing tables to stabilize before virtual routers are started.
vrrp delay seconds

Syntax Definitions

seconds The amount of time after a reboot that virtual routers will wait before
they go active; the range is 0 to 180 seconds.

Defaults

parameter default
seconds 45 seconds

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use this command to prevent loss of workstation connectivity before a virtual router becomes master.

Examples
-> vrrp delay 50

Release History
Release 8.1.1; command was introduced.

Related Commands

vrrp Configures a new VRRP virtual router or modifies an existing one. Used
to enable or disable a virtual router.
show vrrp Displays the virtual router configuration for all virtual routers or for a
specific virtual router.

MIB Objects
alaVRRPStartDelay

page 22-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands vrrp interval

vrrp interval
Modifies the default advertising interval value assigned to the virtual routers on the switch.
vrrp interval seconds

Syntax Definitions

seconds The default advertising interval for the virtual routers. The valid range is
1–255 seconds.

Defaults

parameter default
seconds 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Modifying the default advertising interval value will affect the value assigned by default to any new
virtual routers that are created.
• To apply the new default value to the existing virtual routers, you must first disable the virtual routers,
then apply the new default value using vrrp set command and enable the virtual routers again.
• If any of the virtual routers are running with their own configured value or group value, then that value
will take priority over the new default value. To override the configured value with the new default
value, you must first disable the virtual routers, then override the configured value using the vrrp set
command with the override option and enable the virtual routers again.

Examples
-> vrrp interval 50

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-11
vrrp interval VRRP Commands

Related Commands

vrrp all Changes the administrative status of all the virtual routers on the
switch.
vrrp set Sets the new default parameter values to existing virtual routers on
the switch.
show vrrp Displays the virtual router configuration for all virtual routers or for
a specific virtual router.

MIB Objects
alaVrrpv2Config
alaVrrpDefaultInterval

page 22-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands vrrp priority

vrrp priority
Modifies the default priority value assigned to the virtual routers on the switch.
vrrp priority priority

Syntax Definitions

priority The default priority value for the virtual routers. The valid range is 1–
255.

Defaults

parameter default
priority 100

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Modifying the default priority value will affect the value assigned by default to any new virtual routers
that are created.
• To apply the new default value to the existing virtual routers, you must first disable the virtual routers,
then apply the new default value using the vrrp set command and enable the virtual routers again.
• If any of the virtual routers are running with their own configured value or group value, then that value
will take priority over the new default value. To override the configured value with the new default
value, you must first disable the virtual routers, then override the configured value using the vrrp set
command with the override option and enable the virtual routers again.

Examples
-> vrrp priority 50

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-13
vrrp priority VRRP Commands

Related Commands

vrrp all Changes the administrative status of all the virtual routers on the
switch.
vrrp set Sets the new default parameter values to existing virtual routers on
the switch.
show vrrp Displays the virtual router configuration for all virtual routers or for
a specific virtual router.

MIB Objects
alaVrrpv2Config
alaVrrpDefaultPriority

page 22-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands vrrp preempt

vrrp preempt
Modifies the default preempt mode assigned to the virtual routers on the switch.
vrrp [preempt | no preempt]

Syntax Definitions

preempt Specifies that a higher priority router may preempt a lower priority
master router by default.
no preempt Specifies that a higher priority router may not preempt a lower priority
master router by default.

Defaults

parameter default
preempt | no preempt preempt

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Modifying the default preempt mode will affect the mode assigned by default to any new virtual
routers that are created.
• To apply the new default value to the existing virtual routers, you must first disable the virtual routers,
then apply the new default value using the vrrp set command and enable the virtual routers again.
• If any of the virtual routers are running with their own configured value or group value, then that value
will take priority over the new default value. To override the configured value with the new default
value, you must first disable the virtual routers, then override the configured value using the vrrp set
command with the override option and enable the virtual routers again.

Examples
-> vrrp preempt
-> vrrp no preempt

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-15
vrrp preempt VRRP Commands

Related Commands

vrrp all Changes the administrative status of all the virtual routers on the
switch.
vrrp set Sets the new default parameter values to existing virtual routers on
the switch.
show vrrp Displays the virtual router configuration for all virtual routers or for
a specific virtual router.

MIB Objects
alaVrrpv2Config
alaVrrpDefaultPreemptMode

page 22-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands vrrp all

vrrp all
Changes the administrative status of all the virtual routers on the switch.
vrrp admin-state [disable | enable | enable-all]

Syntax Definitions

disable Disables all the virtual routers on the switch.

enable Enables the virtual routers that have not previously been disabled
individually or collectively through the vrrp group all command.
enable-all Enables all the virtual routers on the switch including those virtual
routers that have been disabled individually or collectively through the
vrrp group all command.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command changes the administrative status of all the virtual routers on the switch by executing a
single command.
• This command will not affect the ability to change the administrative status of an individual virtual
router.

Examples
-> vrrp admin-state disable
-> vrrp admin-state enable
-> vrrp admin-state enable-all

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-17
vrrp all VRRP Commands

Related Commands

vrrp interval Modifies the default advertising interval value assigned to the vir-
tual routers on the switch.
vrrp priority Modifies the default priority value assigned to the virtual routers on
the switch.
vrrp preempt Modifies the default preempt mode assigned to the virtual routers on
the switch.
vrrp set Sets the new default parameter values to existing virtual routers on
the switch.
show vrrp Displays the virtual router configuration for all virtual routers or for
a specific virtual router.

MIB Objects
alaVrrpv2Config
alaVrrpAdminState

page 22-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands vrrp set

vrrp set
Sets the new default parameter values to existing virtual routers on the switch.
vrrp set [interval | priority | preempt | all | none] [ override]

Syntax Definitions

interval Sets the VRRP advertisement interval value to the new default value.
priority Sets the priority value to the new default value.
preempt Sets the preempt mode to the new default mode.
all Sets all the parameters value to the new default value.
none Resets all the parameter values to their default values.
override Overrides the specified parameters configured value with the new
default value.

Defaults

parameter default
interval | priority | preempt | all all

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• All the virtual routers must be disabled before using this command.

• To apply the new default value to the existing virtual routers, you must first disable the virtual routers,
then apply the new default value using the vrrp set command and enable the virtual routers again.
• If any of the virtual routers are running with their own configured value or group value, then that value
will take priority over the new default value. To override the configured value with the new default
value, you must first disable the virtual routers, then override the configured value using the vrrp set
command with the override option and enable the virtual routers again.

Examples
-> vrrp set priority
-> vrrp set priority override

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-19
vrrp set VRRP Commands

Related Commands

vrrp interval Modifies the default advertising interval value assigned to the
virtual routers on the switch.
vrrp priority Modifies the default priority value assigned to the virtual routers on
the switch.
vrrp preempt Modifies the default preempt mode assigned to the virtual routers on
the switch.
vrrp all Changes the administrative status of all the virtual routers on the
switch.
show vrrp Displays the virtual router configuration for all virtual routers or for
a specific virtual router.

MIB Objects
alaVrrpv2Config
alaVrrpSetParam
alaVrrpOverride

page 22-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands vrrp group

vrrp group
Creates a new virtual router group or modifies the configuration parameters of an existing virtual router
group.
vrrp group vrgid [interval seconds] [priority priority] [preempt | no preempt]
no vrrp group vrgid

Syntax Definitions

vrgid The virtual router group ID, in the range from 1–255.
seconds The default advertising interval for the virtual router group. The valid
range is 1–255 seconds.
priority The default priority value for the virtual router group. The valid range is
1–255.
preempt Specifies that a higher priority router may preempt a lower priority
master router by default.
no preempt Specifies that a higher priority router may not preempt a lower priority
master router by default.

Defaults

parameter default
seconds 1
priority 100
preempt | no preempt preempt

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete the virtual router group.

• The configuration parameters can be modified at any time, but will not have any effect on the virtual
routers in the group until the virtual routers are enabled again. To apply the group default value to the
virtual routers in a group, you must first disable the virtual router group, then apply the group default
value using the vrrp group set command and enable the virtual router group again.
• If any of the virtual routers in the group are running with their configured value, then that value will
take priority over the new default value. To override the configured value with the new default value,
you must first disable the virtual router group, then override the configured value by using the vrrp
group set command with the override option and enable the virtual router group again.
• When a virtual router group is deleted, the virtual routers assigned to the group become unassigned.
However, this does not have any impact on the virtual routers.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-21
vrrp group VRRP Commands

Examples
-> vrrp group 25 interval 50 priority 50 no preempt
-> no vrrp group 25

Release History
Release 8.1.1; command was introduced.

Related Commands

vrrp group all Changes the administrative status of all the virtual routers in a
virtual router group using a single command.
vrrp group set Sets the new modified default value to all the virtual routers in a
virtual router group.
vrrp group-association Adds a virtual router to a virtual router group.
show vrrp group Displays the default parameter values for all the virtual router
groups or a specific virtual router group.

MIB Objects
alaVrrpGroupTable
alaVrrpGroupInterval
alaVrrpGroupPriority
alaVrrpGroupPreemptMode
alaVrrpGroupRowStatus

page 22-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands vrrp group all

vrrp group all

Changes the administrative status of all the virtual routers in a virtual router group using a single
command.
vrrp group vrgid admin-state [disable | enable | enable-all]

Syntax Definitions

vrgid The virtual router group ID, in the range from 1–255.
disable Disables all the virtual routers in the group.
enable Enables those virtual routers that have not previously been disabled
individually in the group.
enable-all Enables all the virtual routers in the group including those virtual routers
that have been disabled individually.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If a virtual router in a group is disabled on an individual basis, it can only be reenabled by using the
enable-all option in this command.
• This command will not affect the ability to change the administrative status of an individual virtual
router.

Examples
-> vrrp group 25 admin-state disable
-> vrrp group 25 admin-state enable
-> vrrp group 25 admin-state enable-all

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-23
vrrp group all VRRP Commands

Related Commands

vrrp group Creates a new virtual router group or modifies the configuration
parameters of an existing virtual router group.
vrrp group set Sets the new modified default value to all the virtual routers in a vir-
tual router group.
show vrrp Displays the virtual router configuration for all virtual routers or for
a specific virtual router.
show vrrp group Displays the default parameter values for all the virtual router
groups or a specific virtual router group.

MIB Objects
alaVrrpGroupTable
alaVrrpGroupAdminState

page 22-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands vrrp group set

vrrp group set

Sets the new modified default value to all the virtual routers in a virtual router group.
vrrp group vrgid set [interval | priority | preempt | all] [override]

Syntax Definitions

vrgid The virtual router group ID, in the range from 1–255.
interval Sets the VRRP advertisement interval value to the new default value.
priority Sets the priority value to the new default value.
preempt Sets the preempt mode to the new default mode.
all Sets all the parameters’ value to the new default value.
override Overrides the parameter’s configured value with the group default
value.

Defaults

parameter default
interval | priority | preempt | all all

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• All the virtual routers must be disabled before using this command.

• To apply the group default value to the virtual routers in a group, you must disable the virtual router
group, then apply the group default value using the vrrp group set command and enable the virtual
router group again.
• If any of the virtual routers in the group are running with their own configured parameter value, then
that value will take priority over the group default value. To override the configured value with the
group default value, you must first disable the virtual router group, then override the configured value
by using the vrrp group set command with the override option and enable the virtual router group
again.

Examples
->vrrp group 10 set priority
->vrrp group 10 set priority override

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-25
vrrp group set VRRP Commands

Related Commands

vrrp group Creates a new virtual router group or modifies the configuration
parameters of an existing virtual router group.
vrrp group all Changes the administrative status of all the virtual routers in a vir-
tual router group using a single command.
show vrrp Displays the virtual router configuration for all virtual routers or for
a specific virtual router.
show vrrp group Displays the default parameter values for all the virtual router
groups or a specific virtual router group.

MIB Objects
alaVrrpGroupTable
alaVrrpGroupSetParam
alaVrrpGroupOverride

page 22-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands vrrp group-association

vrrp group-association
Adds a virtual router to a virtual router group.
vrrp vrid vlan_id group-association vrgid
vrrp vrid vlan_id no group-association vrgid

Syntax Definitions

vrid The virtual router ID, in the range from 1–255.

vlan_id The VLAN on which the virtual router is configured. The VLAN must
already be created and available on the switch.
vrgid The virtual router group ID, in the range from 1–255.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the virtual router from the virtual router group.

• A virtual router need not be disabled in order to be added to a virtual router group. However, the
virtual router will not adopt the group’s default parameter values until it is reenabled.
• A virtual router need not be disabled to be removed from a group.

Examples
-> vrrp 25 1 group-association 10
-> vrrp 25 1 no group-association 10

Release History
Release 8.1.1; command was introduced.

Related Commands

show vrrp group-association Displays the virtual routers that are associated with a group.

MIB Objects
alaVrrpAssoGroupTable
alaVrrpAssoGroupRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-27
vrrp3 VRRP Commands

vrrp3
Configures a new VRRP3 virtual router or modifies an existing one. Used to enable or disable a virtual
router.
vrrp3 vrid vlan_id admin-state [enable | disable] [priority priority] [preempt | no preempt][accept | no
accept] [[advertising] interval centiseconds]
no vrrp3 vrid vlan_id

Syntax Definitions

vrid The virtual router ID, in the range from 1–255.

vlan_id The VLAN on which the virtual router is configured. The VLAN must
already be created and available on the switch.
enable Enables the virtual router.
disable Disables the virtual router. Cannot be combined on the same line with
other parameters.
priority The priority for this virtual router to become the master router. The
range is 1 (lowest priority) to 255 (highest priority). The priority should
be set to 255 only if this router is the actual owner of the virtual router’s
IP address.
preempt Specifies that a higher priority router may preempt a lower priority mas-
ter router.
no preempt Specifies that a higher priority router may not preempt a lower priority
master router.
accept Specifies that the master router, which is not the IPv6 address owner
will accept the packets addressed to the IPv6 address owner as its own.
no accept Specifies that the master router, which is not the IPv6 address owner
will not accept the packets addressed to the IPv6 address owner as its
own.
centiseconds The interval in centiseconds after which the master router will send
VRRP3 advertisements. The advertising interval must be the same for
all VRRP3 routers configured with the same VRID. The valid range is
1–4096 centiseconds.

page 22-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands vrrp3

Defaults

parameter default
enable | disable disable
priority 100
preempt | no preempt preempt
accept | no accept accept
centiseconds 100

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a virtual router from the configuration.

• Use the vrrp3 address command to configure an IPv6 address for the virtual router.

• To disable the virtual router, rather than to remove it, use the disable option. Note that the disable
option cannot be used with any other optional parameter.
• A virtual router must be disabled before it can be modified.

• The maximum number of virtual routers supported is based on the 100 centisecond interval. A smaller
interval will result in a relatively lesser number of virtual routers.
• The advertising interval cannot be less than 10 centiseconds.

• Advertising is an optional command parameter. When prefaced before interval, it displays the same
information as vrrp3 vrid vlan_id interval.

Examples
-> vrrp3 23 1 priority 75
-> vrrp3 23 1 admin-state enable

Release History
Release 8.1.1; command was introduced.

Related Commands

vrrp3 address Configures an IPv6 address for a virtual router.

show vrrp3 Displays the virtual router configuration for all virtual routers or for a
specific virtual router.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-29
vrrp3 VRRP Commands

MIB Objects
alaVrrp3OperTable
alaVrrp3OperAdminState
alaVrrp3OperPriority
alaVrrp3OperPreemptMode
alaVrrp3OperAcceptMode
alaVrrp3OperAdvinterval
alaVrrp3OperRowStatus

page 22-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands vrrp3 address

vrrp3 address
Configures an IPv6 address for a virtual router.
vrrp3 vrid vlan_id address [ipv6Addr | ipv6v4Addr]
vrrp3 vrid vlan_id no address [ipv6Addr | ipv6v4Addr]

Syntax Definitions

vrid The virtual router ID, in the range from 1–255.

vlan_id The VLAN on which the virtual router is configured.
address The virtual IPv6 address associated with the specified virtual router.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
IP is an optional command parameter. It displays the same information as vrrp3 address.

Examples
-> vrrp3 1 3 address 213:100:1::56
-> vrrp3 1 3 no address 213:100:1::56

Release History
Release 8.1.1; command was introduced.

Related Commands

vrrp3 Configures a new VRRP3 virtual router or modifies an existing one.

Used to enable or disable a virtual router.
show vrrp3 statistics Displays statistics for all virtual routers configured on the switch or for a
specific virtual router.

MIB Objects
alaVrrp3AssoIpAddrTable
alaVrrp3AssoIpAddrRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-31
vrrp3 trap VRRP Commands

vrrp3 trap
Enables or disables SNMP traps for VRRP3.
vrrp3 trap
no vrrp3 trap

Syntax Definitions

N/A

Defaults
By default, SNMP traps for VRRP3 are enabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
SNMP traps must be enabled globally on the switch for VRRP3 traps to actually be sent.

Examples
-> vrrp3 trap
-> no vrrp3 trap

Release History
Release 8.1.1; command was introduced.

Related Commands

snmp-trap filter-ip SNMP traps must be enabled with this command.

MIB Objects
alaVrrp3OperGroup
alaVrrp3NotificationCntl

page 22-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands vrrp3 track-association

vrrp3 track-association
Associates a VRRP3 tracking policy with a virtual router.
vrrp3 vrid vlan_id track-association track_id
vrrp3 vrid vlan_id no track-association track_id

Syntax Definitions

vrid The virtual router ID, in the range from 1–255.

vlan_id The VLAN ID of the virtual router.
track_id The ID of the tracking policy associated with the virtual router; the
range is 1 to 255.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a tracking policy from a virtual router.

• Use the vrrp track command to create a tracking policy for an IPv6 interface.

Examples
-> vrrp3 2 4 track-association 1
-> vrrp3 2 4 no track-association 1

Release History
Release 8.1.1; command was introduced.

Related Commands

vrrp3 Configures a new VRRP3 virtual router or modifies an existing one.

Used to enable or disable a virtual router.
show vrrp3 track-association Displays the tracking policies associated with VRRP3 virtual routers.

MIB Objects
alaVrrp3AssoTrackTable
alaVrrp3AssoTrackId
alaVrrp3TrackRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-33
show vrrp VRRP Commands

show vrrp
Displays the virtual router configuration for all virtual routers or for a specific virtual router.
show vrrp [vrid]

Syntax Definitions

vrid The virtual router ID, in the range from 1–255.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the show vrrp command to display information about configuration parameters, which may be set
through the vrrp command. Use the show vrrp statistics command to get information about VRRP
packets.

Examples
The following is an example of the output display on an OmniSwitch 6860, 6860E:

-> show vrrp

VRRP trap generation: Enabled
VRRP startup delay: 75
IP Admin Adv.
VRID VLAN Address(es) Status Priority Preempt Interval
----+ ----+ -------------+----------+----------+----------+---------
1 1 192.168.170.1 Enabled 255 Yes 1
192.168.170.2
2 15 10.2.25.254 Disabled 100 No 1

The following is an example of the output display on an OmniSwitch 6860, 6860E:

-> show vrrp
VRRP default advertisement interval: 5 seconds
VRRP default priority: 100
VRRP default preempt: Yes
VRRP trap generation: Enabled
VRRP startup delay: 45 (expired)

IP Admin Adv.
VRID VLAN Address(es) Status Priority Preempt Interval
----+----+---------------+--------+--------+------+--------
1 101 192.60.245.240 Enabled 100 Yes 5
2 102 192.60.246.240 Enabled 100 Yes 5

page 22-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands show vrrp

-> show vrrp 1

Virtual Router VRID = 1 on VLAN = 1
Admin Status = Enabled
Priority = 255
Preempt = Yes
Adv. Interval = 1
Virtual MAC = 00-00-5E-00-02-01
IP Address(es)
192.168.170.1
192.168.170.2

output definitions
VRRP default advertisement The default advertising interval for all virtual routers on the switch.
interval
VRRP default priority The default priority value for all virtual routers on the switch.
VRRP default preempt The default preempt mode for all virtual routers on the switch.
VRRP trap generation Indicates whether or not the VRRP trap generation is enabled or
disabled; configured through the vrrp track command.
VRRP startup delay The amount of time after a reboot that virtual routers will wait before
they go active; allows time for routing tables to stabilize. Configured
through the vrrp delay command.
VRID Virtual router identifier. Configured through the vrrp command.
VLAN The VLAN associated with the VRRP instance. Configured through the
vrrp command.
IP Address(es) The assigned IP addresses. Configured through the vrrp address com-
mand.
Admin Status The administrative status of this virtual router instance; enabled allows
the virtual router instance to operate; disabled disables the virtual
router instance without deleting it.
Priority Indicates the VRRP router’s priority for the virtual router. For more
information about priority, see the vrrp command description on
page 22-3.
Preempt Controls whether a higher priority virtual router will preempt a lower
priority master router: preempt indicates that a higher priority virtual
router will preempt a lower priority master; no preempt indicates that
the first backup router to take over for the master will not be preempted
by a virtual router with a higher priority. In either case, the IP address
owner will always take over it if is available.
Virtual MAC Displays the virtual MAC address for the virtual router. The first 5
bytes are always 00-00-5E-00-02. The last byte indicates the VRID.
This field displays N/A when the virtual router is in the backup or ini-
tialize state.
Adv. Interval Indicates the time interval, in seconds, between sending advertisement
messages. Only the master router sends advertisements.

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-35
show vrrp VRRP Commands

Related Commands

vrrp Configures a new VRRP virtual router or modifies an existing one. Used
to enable or disable a virtual router.
vrrp address Configures an IP address for a virtual router.
vrrp interval Modifies the default advertising interval value assigned to the virtual
routers on the switch.
vrrp priority Modifies the default priority value assigned to the virtual routers on the
switch.
vrrp preempt Modifies the default preempt mode assigned to the virtual routers on the
switch.
show vrrp statistics Displays statistics for all virtual routers configured on the switch or for a
specific virtual router.

MIB Objects
alaDispVrpp3Config
alaVRRPDefaultInterval
alaVRRPDefaultPriority
alaVRRPDefaultPreemptMode
alaVrrp3AssoIpAddr
alaVrrp3OperAdminState
alaVrrp3OperPriority
alaVrrp3OperPreemptMode
alaVrrp3OperAcceptMode

page 22-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands show vrrp statistics

show vrrp statistics

Displays statistics about VRRP packets for all virtual routers configured on the switch or for a specific
virtual router.
show vrrp [vrid] statistics

Syntax Definitions

vrid The virtual router ID, in the range from 1–255.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the show vrrp statistics command to display information about VRRP packets. Use the show vrrp
command to display information about the virtual router configuration.

Examples
-> show vrrp statistics
Checksum Version VRID
Errors Errors Errors
----------+-----------+---------
0 0 0

VRID VLAN State UpTime Become Master Adv. Rcvd

----+ ----+ -------------+----------+--------------+------------
1 1 master 378890 1 0
2 15 backup 4483 0 44
7 2 initialize 0 0 0

output definitions
Checksum Errors The total number of VRRP packets received with an invalid checksum
value.
Version Errors The total number of VRRP packets received with an invalid version
number.
VRID Errors The total number of VRRP packets received with invalid VRIDs.
VRID The virtual router identifier.
VLAN The VLAN associated with the VRRP instance.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-37
show vrrp statistics VRRP Commands

output definitions (continued)

State The operational state of the VRRP router instance; initialize specifies
that the interface or VLAN is either disabled or down, or if the startup
delay timer has not expired; backup specifies that this instance is mon-
itoring the availability of the master router; master specifies that this
instance is functioning as the master router.
UpTime Time interval (in hundredths of a second) since this virtual router was
last initialized.
Become Master The total number of times this virtual router’s state has transitioned
from backup to master.
Adv. Rcvd The total number of VRRP advertisements received by this instance.

-> show vrrp 1 statistics

Virtual Router VRID = 1 on VLAN = 1
State = master
UpTime (1/100th second) = 378890
Become master = 1
Advertisements received = 0
Type errors = 0
Advertisement interval errors = 0
Authentication errors = 0
IP TTL errors = 0
IP address list errors = 0
Packet length errors = 0
Zero priority advertisements sent = 0
Zero priority advertisements received = 0

output definitions
VRID The virtual router identifier.
VLAN The VLAN associated with the VRRP instance.
State The operational state of this VRRP router instance; initialize specifies
that the interface or VLAN is either disabled or down, or the startup
delay timer has not expired; backup specifies that this instance is mon-
itoring the availability of the master router; master specifies that this
instance is functioning as the master router.
UpTime Time interval (in hundredths of a second) since this virtual router was
last initialized.
Become master The total number of times this virtual router’s state has transitioned
from backup to master.
Advertisements received The total number of VRRP advertisements received by this instance.
Type errors The total number of VRRP packets received with an invalid value in
the VRRP type field.
Advertisement interval errors The total number of VRRP packets received in which the advertisement
interval differs from the one configured for the virtual router.
Authentication errors The total number of VRRP packets received with an unknown or
invalid authentication type.
IP TTL errors The total number of VRRP packets received with a TTL value other
than 255.

page 22-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands show vrrp statistics

output definitions (continued)

IP address list errors The total number of VRRP packets in which the IP address list does not
match the configured list for the virtual router.
Packet length errors The total number of VRRP packets received with a length less than the
length of the VRRP header.
Zero priority advertisements The total number of VRRP advertisements with a priority of 0 sent by
sent the virtual router.
Zero priority advertisements The total number of VRRP advertisements with a priority of 0 received
received by the virtual router.

Release History
Release 8.1.1; command was introduced.

Related Commands

vrrp Configures a new VRRP virtual router or modifies an existing one. Used
to enable to disable a virtual router.
show vrrp Displays the virtual router configuration for all virtual routers or for a
specific virtual router.

MIB Objects
alaVrrp3RouterChecksumErrors
alaVrrp3RouterVersionErrors
alaVrrp3RouterVrIdErrors
alaVrrp3RouterStatsTable
alaVrrp3StatsBecomeMaster
alaVrrp3StatsAdvertiseRcvd
alaVrrp3StatsAdvIntervalErrors
alaVrrp3StatsIpTtlErrors
alaVrrp3StatsPriZeroPktsRcvd
alaVrrp3StatsPriZeroPktsSent
alaVrrp3StatsInvalidTypePktsRcvd
alaVrrp3StatsAddressListErrors
alaVrrp3StatsInvldAuthType
alaVrrp3StatsPacketLengthErrors
alaVrrp3OperTable
alaVrrp3OperUpTime
alaVrrp3OperGroup
alaVrrp3OperState

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-39
show vrrp track VRRP Commands

show vrrp track

Displays information about tracking policies on the switch.
show vrrp track [track_id]

Syntax Definitions

track_id The ID of the tracking policy for which you want to display information.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Enter the tracking ID to display information about a particular policy; if no tracking policy ID is entered,
information for all tracking policies is displayed.

Examples
-> show vrrp track
Track Admin Oper
ID Policy State State Pri
-----+-----------------+----------+------+-----
1 PORT 1/1 Enabled Up 25
2 192.10.150.42 Enabled Down 25

output definitions
Track ID The ID of the tracking policy.
Policy The slot/port, IP address, or VLAN tracked by the policy.
Admin State Whether the tracking policy is administratively enabled or disabled.
Oper State Indicates whether the operating state of the tracking policy is Up or
Down.
Pri The value to be decremented from the priority value of the virtual
router monitoring this tracking policy when the operational state of the
tracking policy is down.

Release History
Release 8.1.1; command was introduced.

page 22-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands show vrrp track

Related Commands

vrrp track Creates a new tracking policy or modifies an existing tracking policy.

MIB Objects
alaVRRPTrackTable
alaVrrpTrackState
alaVrrpTrackAdminState
alaVrrpTrackPriority
alaVrrpTrackEntityType
alaVrrpTrackEntityVlan
alaVrrpTrackEntityPort
alaVrrpTrackEntityIpAddress
alaVrrpTrackEntityIpv6Interface
alaVrrpTrackEntityInterface

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-41
show vrrp track-association VRRP Commands

show vrrp track-association

Displays the tracking policies associated with virtual routers.
show vrrp [vrid] track-association [track_id]

Syntax Definitions

vrid The virtual router ID, in the range from 1–255.

track_id The ID of the tracking policy for which you want to display information.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If a track ID is specified, only information about that track ID is displayed. If the virtual router ID and
track ID are not specified, information about all virtual routers and their associated tracking policies is
displayed.

Examples
-> show vrrp 2 track-association
Conf Cur Track Admin Oper Track
VRID VLAN Pri Pri ID Policy State State Pri
----+----+-----+-----+-----+-----------------+----------+-----+------
2 1 100 100 1 VLAN 1 Enabled Up 25
2 10.255.11.101 Enabled Up 25

output definitions
VRID The virtual router identifier.
VLAN The VLAN ID associated with the virtual router.
Conf Pri The priority configured for the virtual router through the vrrp
command.
Cur Pri The priority currently being used for the virtual router. If the tracking
policy is in effect because the tracked entity is down, the current
priority will be equal to the configured priority (Conf Pri) minus the
tracking priority (Track Pri). Otherwise the current priority will be
equal to the configured priority.
Track ID The ID of the tracking policy.
Policy The VLAN, IP address, or slot/port being tracked by this policy.
Admin State The administrative state of the tracking policy configured through the
vrrp track command.

page 22-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands show vrrp track-association

output definitions (continued)

Oper State Whether the tracking policy is operational (Up) or not (Down).
Track Pri The amount to be decremented from the configured virtual router prior-
ity when the tracking policy is applied.

Release History
Release 8.1.1; command was introduced.

Related Commands

vrrp track-association Associates a VRRP tracking policy with a virtual router.

vrrp track Creates a new tracking policy or modifies an existing tracking policy.

MIB Objects
alaVrrpAssoTrackTable
alaVrrpAssoTrackId
alaVRRPTrackTable
alaVrrpTrackState
alaVrrpTrackAdminState
alaVrrpTrackPriority
alaVrrpTrackEntityType
alaVrrpTrackEntityVlan
alaVrrpTrackEntityPort
alaVrrpTrackEntityIpAddress
alaVrrpTrackEntityInterface

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-43
show vrrp group VRRP Commands

show vrrp group

Displays the default parameter values for all the virtual router groups or for a specific virtual router group.
show vrrp group [vrgid]

Syntax Definitions

vrgid The virtual router group ID, in the range from 1–255.

Defaults
By default, the default parameter values are displayed for all the virtual router groups.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the vrgid parameter with this command to display the default values for a specific virtual router group.

Examples
-> show vrrp group 2
Virtual Router Group GROUPID = 2
Interval = 11
Priority = 250
Preempt Mode = Yes
3 Associated Virtual Routers

output definitions
Group ID The virtual router group identifier.
Adv Interval Indicates the time interval, in seconds, between the sending of
advertisement messages. Only the master router sends advertisements.
Priority Indicates the VRRP router’s priority for the virtual router group. For
more information about priority, see the vrrp command description on
page 22-3.
Preempt Mode Controls whether a higher priority virtual router will preempt a lower
priority master; preempt indicates that a higher priority virtual router
will preempt a lower priority master; no preempt indicates that the first
backup router to take over for the master will not be preempted by a
virtual router with a higher priority. In either case, the IP address owner
will always take over it if is available.

Release History
Release 8.1.1; command was introduced.

page 22-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands show vrrp group

Related Commands

vrrp group Creates a new virtual router group or modifies the configuration
parameters of an existing virtual router group.
vrrp group all Changes the administrative status of all the virtual routers in a virtual
router group using a single command.

MIB Objects
alaVrrpGroupTable
alaVrrpGroupInterval
alaVrrpGroupPriority
alaVrrpGroupPreemptMode

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-45
show vrrp group-association VRRP Commands

show vrrp group-association

Displays the virtual routers that are associated with a group.
show vrrp group-association [vrgid]

Syntax Definitions

vrgid The virtual router group ID, in the range from 1–255.

Defaults
By default, all virtual router group associations are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the vrgid parameter with this command to display the association details of a specific virtual router
group.

Examples
-> show vrrp group-association 2
GROUPID VRID VLAN
-------+----+-----+
2 3 2
4 2
5 2

output definitions
GROUPID The virtual router group identifier.
VRID The virtual router identifier.
VLAN The VLAN associated with the VRRP instance. Configured through the
vrrp command.

Release History
Release 8.1.1; command was introduced.

page 22-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands show vrrp group-association

Related Commands

vrrp group-association Adds a virtual router to a virtual router group.

MIB Objects
alaVrrpAssoGroupTable
alaVrrp3OperVrId

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-47
show vrrp3 VRRP Commands

show vrrp3
Displays the virtual router configuration for all virtual routers or for a specific virtual router.
show vrrp3 [vrid]

Syntax Definitions

vrid The virtual router ID, in the range from 1–255.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the show vrrp3 command to display information about configuration parameters, which may be set
through the vrrp3 command. Use the show vrrp3 statistics command to get information about VRRP3
packets.

Examples
-> show vrrp3
VRRP trap generation: Enabled
VRRP startup delay: 45 (expired)

Admin Adv.
VRID VLAN IPv6 Address(es) Status Priority Preempt Accept Interval
----+----+--------------------------+--------+--------+-------+------+--------
1 101 fe80::200:5eff:fe00:201 Enabled 200 No Yes 100
1010::30
2 102 fe80::200:5eff:fe00:202 Enabled 200 No Yes 100
1020::30
3 103 fe80::200:5eff:fe00:203 Enabled 200 No Yes 100
1030::30
4 104 fe80::200:5eff:fe00:204 Enabled 200 No Yes 100
1040::30
5 105 fe80::200:5eff:fe00:205 Enabled 200 No Yes 100
1050::30
6 106 fe80::200:5eff:fe00:206 Enabled 200 No Yes 100
1060::30
7 107 fe80::200:5eff:fe00:207 Enabled 200 No Yes 100
1070::30
8 108 fe80::200:5eff:fe00:208 Enabled 200 No Yes 100
1080::30
9 109 fe80::200:5eff:fe00:209 Enabled 200 No Yes 100
1090::30
10 110 fe80::200:5eff:fe00:20a Enabled 200 No Yes 100
1100::30

page 22-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands show vrrp3

output definitions
VRRP trap generation Whether or not VRRP trap generation is enabled or disabled.
VRRP startup delay The amount of time after a reboot that virtual routers will wait before
they go active; allows time for routing tables to stabilize.
VRID Virtual router identifier. Configured through the vrrp3 command.
VLAN The VLAN associated with the VRRP3 instance. Configured through
the vrrp3 command.
IPv6 Address(es) The assigned IPv6 addresses. Configured through the vrrp3 address
command.
Admin Status The administrative status of this virtual router instance; enabled allows
the virtual router instance to operate; disabled disables the virtual
router instance without deleting it.
Priority Indicates the VRRP3 router’s priority for the virtual router. For more
information about priority, see the vrrp3 command description on page
22-28.
Preempt Controls whether a higher priority virtual router will preempt a lower
priority master: preempt indicates that a higher priority virtual router
will preempt a lower priority master; no preempt indicates that the first
backup router to take over for the master will not be preempted by a
virtual router with a higher priority. In either case the IP address owner
will always take over it if is available.
Accept Displays whether the master router, which is not the IPv6 address
owner will accept the packets addressed to the IPv6 address owner as
its own.
Virtual MAC Displays the virtual MAC address for the virtual router when the router
is in the master state. The first 5 bytes are always 00-00-5E-00-02. The
last byte indicates the VRID. This field displays N/A when the virtual
router is in the backup or initialize state.
Adv. Interval Indicates the time interval, in seconds, between sending advertisement
messages. Only the master router sends advertisements.

Release History
Release 8.1.1; command was introduced.

Related Commands

vrrp3 Configures a new VRRP3 virtual router or modifies an existing one.

Used to enable or disable a virtual router.
vrrp3 address Configures an IPv6 address for a virtual router.
show vrrp3 statistics Displays statistics for all virtual routers configured on the switch or for a
specific virtual router.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-49
show vrrp3 VRRP Commands

MIB Objects
alaVrrp3OperTable
alaVrrp3OperAdminState
alaVrrp3OperPriority
alaVrrp3OperPreemptMode
alaVrrp3OperAcceptMode
alaVrrp3OperAdvinterval

page 22-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands show vrrp3 statistics

show vrrp3 statistics

Displays statistics about VRRP3 packets for all virtual routers configured on the switch or for a specific
virtual router.
show vrrp3 [vrid] statistics

Syntax Definitions

vrid The virtual router ID, in the range from 1–255.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the show vrrp3 statistics command to display information about VRRP3 packets. Use the show
vrrp3 command to display information about the virtual router configuration.

Examples
-> show vrrp3 statistics
Checksum Version VRID
Errors Errors Errors
----------+----------+----------
0 0 0

VRID VLAN State UpTime Become Master Adv. Rcvd

----+----+----------+----------+-------------+----------
1 101 Master 2983 1 0
2 102 Master 60675 1 0
3 103 Master 60675 1 0
4 104 Master 60675 1 0
5 105 Master 60675 1 0
6 106 Master 60675 1 0
7 107 Master 60675 1 0
8 108 Master 60675 1 0
9 109 Master 60675 1 0
10 110 Master 60675 1 0

output definitions
Checksum Errors The total number of VRRP3 packets received with an invalid checksum
value.
Version Errors The total number of VRRP3 packets received with an invalid version
number.
VRID Errors The total number of VRRP3 packets received with invalid VRIDs.
VRID The virtual router identifier.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-51
show vrrp3 statistics VRRP Commands

output definitions (continued)

VLAN The VLAN associated with the VRRP3 instance.
State The administrative state of the VRRP3 instance; initialize specifies that
the interface or vlan is either disabled or down and the startup delay
timer has not expired; backup specifies that this instance is monitoring
the availability of the master router; master specifies that this instance
is functioning as the master router.
UpTime Time interval (in hundredths of a second) since this virtual router was
last initialized.
Become Master The total number of times this virtual router’s state has transitioned
from backup to master.
Adv. Rcvd The total number of VRRP3 advertisements received by this instance.

Release History
Release 8.1.1; command was introduced.

Related Commands

vrrp3 Configures a new VRRP3 virtual router or modifies an existing one.

Used to enable or disable a virtual router.
show vrrp3 Displays the virtual router configuration for all virtual routers or for a
specific virtual router.

MIB Objects
alaVrrp3RouterChecksumErrors
alaVrrp3RouterVersionErrors
alaVrrp3RouterVrIdErrors
alaVrrp3RouterStatsTable
alaVrrp3StatsBecomeMaster
alaVrrp3StatsAdvertiseRcvd
alaVrrp3StatsAdvIntervalErrors
alaVrrp3StatsIpTtlErrors
alaVrrp3StatsPriZeroPktsRcvd
alaVrrp3StatsPriZeroPktsSent
alaVrrp3StatsInvalidTypePktsRcvd
alaVrrp3StatsAddressListErrors
alaVrrp3StatsInvldAuthType
alaVrrp3StatsPacketLengthErrors
alaVrrp3OperTable
alaVrrp3OperUpTime
alaVrrp3OperGroup
alaVrrp3OperState

page 22-52 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VRRP Commands show vrrp3 track-association

show vrrp3 track-association

Displays the tracking policies associated with VRRP3 virtual routers.
show vrrp3 [vrid] track-association [track_id]

Syntax Definitions

vrid The virtual router ID, in the range from 1–255.

track_id The ID of the tracking policy for which you want to display information.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If a track ID is specified, only information about that track ID is displayed. If the virtual router ID and
track ID are not specified, information about all virtual routers and their associated tracking policies is
displayed.

Examples
-> show vrrp3 track-association
Conf Cur Track Admin Oper Track
VRID VLAN Pri Pri ID Policy State State Pri
----+----+-----+-----+-----+--------------------+--------+-----+------
1 101 200 200 1 PORT 1/37 Enabled Up 25

output definitions
VRID The virtual router identifier.
VLAN The VLAN ID associated with the virtual router.
Conf Pri The priority configured for the virtual router through the vrrp3
command.
Cur Pri The priority currently being used for the virtual router. If the tracking
policy is in effect because the tracked entity is down, the current
priority will be equal to the configured priority (Conf Pri) minus the
tracking priority (Track Pri). Otherwise the current priority will be
equal to the configured priority.
Track ID The ID of the tracking policy.
Policy The VLAN, IPv6 address, or slot/port being tracked by this policy.
Admin State The administrative state of the tracking policy.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 22-53
show vrrp3 track-association VRRP Commands

output definitions (continued)

Oper State Indicates whether the tracking policy is operational (Up) or not
(Down).
Track Pri The amount to be decremented from the configured virtual router prior-
ity when the tracking policy is applied.

Release History
Release 8.1.1; command was introduced.

Related Commands

vrrp3 track-association Associates a VRRP3 tracking policy with a virtual router.

MIB Objects
alaVrrpTrackTable
alaVrrpTrackState
alaVrrpTrackAdminState
alaVrrpTrackPriority
alaVrrpTrackEntityType
alaVrrpTrackEntityVlan
alaVrrpTrackEntityPort
alaVrrpTrackEntityIpAddress
alaVrrpTrackEntityIpv6Interface
alaVrrpTrackEntityInterface
alaVrrpTrackRowStatus
alaVrrp3AssoTrackTable
alaVrrp3AssoTrackId
alaVrrp3TrackRowStatus

page 22-54 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 23 OSPF Commands

Open Shortest Path First routing (OSPF) is a shortest path first (SPF) or link-state protocol. OSPF is an
interior gateway protocol (IGP) that distributes routing information between routers in a single
autonomous system (AS). OSPF chooses the least-cost path as the best path.
Each participating router distributes its local state (for example, the router’s usable interfaces and
reachable neighbors) throughout the AS by flooding. In a link-state protocol, each router maintains a
database describing the entire AS topology. This database is built from the collected link state
advertisements of all routers. Each multi-access network that has at least two attached routers has a
designated router and a backup designated router. The designated router floods a link state advertisement
for the multi-access network and has other special responsibilities.
OSPF allows collections of contiguous networks and hosts to be grouped together. A group, together with
the routers having interfaces to any one of the included networks, is called an area. Each area runs a
separate copy of the basic link-state routing algorithm. This means that each area has its own topological
database, as explained in the previous section.
Alcatel-Lucent’s version of OSPF complies with RFCs 1370, 1850, 2328, 2370, 3101, and 3623.
MIB information for OSPF is as follows:
Filename: AlcatelIND1DrcTm.mib
Module: ALCATEL-IND1-DRCTM-MIB
Filename: AlcatelIND1Ospf.mib
Module: ALCATEL-IND1-OSPF-MIB
Filename: IETF_OSPF.MIB
Module: OSPF-MIB

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-1
 OSPF Commands

The following is a list of the commands for configuring OSPF:

Global OSPF Commands ip ospf admin-state

ip load ospf
ip ospf asbr
ip ospf exit-overflow-interval
ip ospf extlsdb-limit
ip ospf host
ip ospf mtu-checking
ip ospf default-originate
ip ospf default-originate
ip ospf default-originate
ip ospf route-tag
ip ospf spf-timer
ip ospf virtual-link
ip ospf neighbor
show ip ospf
show ip ospf border-routers
show ip ospf ext-lsdb
show ip ospf host
show ip ospf lsdb
show ip ospf neighbor
show ip ospf routes
show ip ospf routes
show ip ospf routes
show ip ospf virtual-link
show ip ospf virtual-neighbor
OSPF Area Commands ip ospf area
ip ospf area default-metric
ip ospf area range
show ip ospf area
show ip ospf area range
show ip ospf area stub
OSPF Interface Commands ip ospf interface
ip ospf interface admin-state
ip ospf interface area
ip ospf interface auth-key
ip ospf interface auth-type
ip ospf interface dead-interval
ip ospf interface hello-interval
ip ospf interface md5
ip ospf interface md5 key
ip ospf interface type
ip ospf interface cost
ip ospf interface poll-interval
ip ospf interface priority
ip ospf interface retrans-interval
ip ospf interface transit-delay
show ip ospf interface
OSPF Graceful Restart ip ospf restart-support
Commands ip ospf restart-interval
ip ospf restart-helper admin-state
ip ospf restart-helper strict-lsa-checking admin-state
ip ospf restart initiate
show ip ospf restart

page 23-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf admin-state

ip ospf admin-state
Enables or disables the administration status of OSPF on the router.
ip ospf admin-state {enable | disable}

Syntax Definitions

enable Enables OSPF.

disable Disables OSPF.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The OSPF protocol must be enabled for it to route traffic.

Examples
-> ip ospf admin-state enable
-> ip ospf admin-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf Displays OSPF status and general configuration parameters.

MIB Objects
ospfGeneralGroup
ospfAdminStat

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-3
ip load ospf OSPF Commands

ip load ospf
Loads the OSPF software on the router.
ip load ospf

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Example
-> ip load ospf

Release History
Release 8.1.1; command was introduced.

Related Commands
N/A

MIB Objects
ALADRCTMCONFIG
alaDrcTmIPOspfStatus

page 23-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf asbr

ip ospf asbr
Configures the router as an Autonomous System Border Router (ASBR). A router running multiple
protocols or acting as a gateway to other exterior routers is an ASBR. This command is currently not
supported.
ip ospf asbr
no ip ospf asbr

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Autonomous System Border Routers (ASBRs) are routers that exchange information with routers from
another autonomous system (AS).
• The no variant of this command removes the ASBR classification of the selected router.

Examples
-> ip ospf asbr
-> no ip ospf asbr

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf Displays OSPF status and general configuration parameters.

MIB Objects
alaProtocolOspf
alaOspfAsBdRtr

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-5
ip ospf exit-overflow-interval OSPF Commands

ip ospf exit-overflow-interval
This command sets the overflow interval value.
ip ospf exit-overflow-interval seconds

Syntax Definitions

seconds The number of seconds the router waits before attempting to leave the
overflow state.

Defaults

parameter default
seconds 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The overflow interval is the time whereby the routing router will wait before attempting to leave the
database overflow state; the interval begins upon the routing router’s arrival into this state.
• When the routing router leaves the overflow state, it can once again create non-default and external link
state advertisements (LSAs) for autonomous systems (AS).
• Note that the router will not leave the overflow state (until it is restarted) when the overflow interval
value is set to 0.

Example
-> ip ospf exit-overflow-interval 10

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf Displays the OSPF status and general configuration parameters.

MIB Objects
ospfGeneralGroup
ospfExitOverflowInterval

page 23-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf extlsdb-limit

ip ospf extlsdb-limit
Assigns a limit to the number of External Link-State Database (LSDB) entries that can be learned.
ip ospf extlsdb-limit limit

Syntax Definitions

limit The maximum number of LSDB entries allowed on the router. The
accepted value is any number greater than or equal to 1. If 0 is entered,
there is no limit.

Defaults

parameter default
limit -1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command allows you to set a limit to the number of external LSDBs learned by the router. An
external LSDB is created when the router learns a link address that exists outside of its Autonomous
System (AS).
• When the limit is set, and it is exceeded, older addresses that were previously learned are removed
from the routing table to make room for the new external LSDB.

Example
-> ip ospf extlsdb-limit 25

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf Displays OSPF status and general configuration parameters.

MIB Objects
ospfGeneralGroup
ospfExtLsdbLimit

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-7
ip ospf host OSPF Commands

ip ospf host
Creates and deletes an OSPF entry for directly attached hosts. Allows for the modification of the host
parameters of Type of Service (ToS) and metric.
ip ospf host ip_address tos tos [metric metric]
no ip ospf host ip_address tos tos

Syntax Definitions

ip_address The 32-bit IP address in dotted decimal format of the OSPF host. See
the example below for more information.
tos The type of service (ToS) of the specified OSPF host. The valid range is
0- 15. Only ToS value 0 is supported at this time.
metric The cost metric value assigned to the specified host. The valid range is 0
and up.

Defaults

parameter default
metric 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The no variant of this command removes the record of the OSPF host.

• Use this command when multiple paths exist to a host. The specified host must be directly attached to
the router. ToS routing is the ability to make a forwarding decision based on a destination address and a
desired Quality of Service (QoS). ToS routing allows link selection based on QoS when more than one
path exists between a source and a destination.A metric value is the cost of all the hops necessary for a
packet to reach its destination. Routers use the metric to determine the best possible path.

Examples
-> ip ospf host 172.22.2.115 tos 1 metric 10
-> no ip ospf host 172.22.2.115 tos 1

Release History
Release 8.1.1; command was introduced.

page 23-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf host

Related Commands

show ip ospf host Displays information on configured OSPF hosts.

MIB Objects
ospfHostTable
ospfHostStatus
ospfHostIpAddress
ospfHostTOS
ospfHostMetric

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-9
ip ospf mtu-checking OSPF Commands

ip ospf mtu-checking
Enables or disables the use of Maximum Transfer Unit (MTU) checking. The MTU limits the size of a
transmitted or received packet.
ip ospf mtu-checking
no ip ospf mtu-checking

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The no form of this command disables MTU checking.

• This command is used to disable the checking for mismatch of the interface MTU while establishing a
neighbor adjacency with a router. MTU mismatch occurs when a router receives packets that contain a
larger MTU value than that of the interface on which adjacency is being established. The interface
MTU is the largest IP datagram size (in bytes) that the interface can accept.

Examples
-> ip ospf mtu-checking
-> no ip ospf mtu-checking

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf Displays the OSPF status and general configuration parameters.

MIB Objects
alaProtocolOspf
alaOspfMTUCheck

page 23-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf default-originate

ip ospf default-originate
Configures a default external route into the OSPF routing domain.
ip ospf default-originate {only | always} [metric-type {type1 | type2}] [metric value]
no ip ospf default-originate

Syntax Definitions

only Advertises only when there is a default route in the routing table.
always Advertises the default route regardless of whether the routing table has a
default route.
type1 Sets the external route as type1.
type2 Sets the external route as type2.
value The metric value.The valid range is 1-65535.

Defaults

parameter default
type1 | type2 type2
value 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of the command to delete redistributed default routes.

Examples
-> ip ospf default-originate always
-> ip ospf default-originate only metric 10
-> ip ospf default-originate always metric-type type1 metric 5
-> no ip ospf default-originate

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-11
ip ospf default-originate OSPF Commands

Related Commands

ip ospf asbr Configures the router as an Autonomous System Border Router

(ASBR). This command is currently not supported.

MIB Objects
alaProtocolOspf
alaOspfDefaultOriginate
alaOspfDefaultOriginateMetricType
alaOspfDefaultOriginateMetric

page 23-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf route-tag

ip ospf route-tag
Configures a tag value that is applied to internal routes for potential redistribution.
ip ospf route-tag tag

Syntax Definitions

tag The set tag value. The valid range is 0–2,147,483,647.

Defaults

parameter default
tag 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
A 32-bit value tagged to each OSPF internal route that is redistributed into other routing protocol domains.
The lower 16-bits typically indicate the autonomous system number.

Example
-> ip ospf route-tag 2

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf Displays OSPF status and general configuration parameters.

MIB Objects
alaProtocolOspf
alaOspfRedistRouteTag

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-13
ip ospf spf-timer OSPF Commands

ip ospf spf-timer
Configures timers for Shortest Path First (SPF) calculation.
ip ospf spf-timer [delay delay_seconds] [hold hold_seconds]

Syntax Definitions

delay_seconds Specifies time (from 0 to 65535 seconds) between the reception of an

OSPF topology change and the start of an SPF calculation.
hold_seconds Specifies the minimum time (from 0 to 65535 seconds) between consec-
utive SPF calculations.

Defaults

parameter default
delay_seconds 5
hold_seconds 10

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command allows you to configure the time between SPF calculations. Using the delay timer, you
can determine how much time to postpone an SPF calculation after the router receives a topology
change. Using the hold timer, you can configure the amount of time that must elapse between
consecutive SPF calculations.
• Note that if either of these values is set to 0, there will be no delay in the SPF calculation. This means
that SPF calculations will occur immediately upon the reception of a topology change and/or that back-
to back SPF calculations can take place with no break in-between the two.

Example
-> ip ospf spf-timer delay 20 hold 35

Release History
Release 8.1.1; command was introduced.

page 23-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf spf-timer

Related Commands

show ip ospf Displays the OSPF status and general configuration parameters.

MIB Objects
alaProtocolOspf
alaOspfTimerSpfDelay
alaOspfTimerSpfHold

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-15
ip ospf virtual-link OSPF Commands

ip ospf virtual-link
Creates or deletes a virtual link. A virtual link is used to restore backbone connectivity if the backbone
is not physically contiguous.
ip ospf virtual-link area_id router_id [auth-type {none | simple | md5}] [auth-key key_string] [dead-
interval seconds] [hello-interval seconds] [retrans-interval seconds] [transit-delay seconds]
no ip ospf virtual-link area_id router_id

Syntax Definitions

area_id A unique 32-bit value in IP address format.

router_id A unique 32-bit value, such as an IP address, that identifies a neighbor-
ing router in the Autonomous System.
none Sets the virtual link authorization type to no authentication.
simple Sets the virtual link authorization type to simple authentication. If sim-
ple is selected, a key must be specified as well.
md5 Sets the virtual link authorization type to MD5 authentication.
key_string Sets the virtual link authorization key. The key can be up to 8 ASCII
characters. See the example for more details.
dead-interval seconds Sets the virtual link dead interval. If no hello packets on this link for the
set number of seconds have been received, the virtual neighbor is
declared dead. The valid range is 1–2147483647.
hello-interval seconds Sets the virtual link hello interval, which is the time interval between
OSPF hellos sent on this virtual link. The valid range is 1–65535.
retrans-interval seconds Sets the virtual link retransmit interval. The router waits the set number
of seconds before retransmitting OSPF packets. The valid range is 0–
3600.
transit-delay seconds Sets the virtual link transit delay, which is the number of seconds to
transmit OSPF packets over this link. The valid range is 0–3600.

Defaults

parameter default
none | simple | md5 none
key_string null string
dead-interval seconds 40
hello-interval seconds 10
retrans-interval seconds 5
transit-delay seconds 1

Platforms Supported
OmniSwitch 6860, 6860E

page 23-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf virtual-link

Usage Guidelines
• The no form of the command deletes the virtual link.

• It is possible to define areas in such a way that the backbone is no longer contiguous. In this case the
system administrator can ensure backbone connectivity physically.
• Virtual links can be configured between any two backbone routers that have an interface to a common
non-backbone area. Virtual links belong to the backbone. The protocol treats two routers joined by a
virtual link as if they were connected by an unnumbered point-to-point network. The routing protocol
traffic that flows along the virtual link uses intra-area routing only.
• If authentication is enabled, both routers at either end of the virtual link must share the same password.
Simple authentication refers to the use of only clear-text passwords as an authentication method. MD5
authentication refers to the usage of message digests.
• The dead-interval value should be the same for all routers on the same network. This value should be
some multiple of the value given for the hello interval.

Examples
-> ip ospf virtual-link 0.0.0.1 172.22.2.115
-> ip ospf virtual-link 0.0.0.1 172.22.2.115 auth-key "techpubs"
-> ip ospf virtual-link 0.0.0.1 172.22.2.115 auth-type simple
-> ip ospf virtual-link 0.0.0.1 172.22.2.115 dead-interval 50
-> ip ospf virtual-link 0.0.0.1 172.22.2.115 hello-interval 20
-> ip ospf virtual-link 0.0.0.1 172.22.2.115 retrans-interval 20
-> ip ospf virtual-link 0.0.0.1 172.22.2.115 transit-delay 50
-> no ip ospf virtual-link 0.0.0.1 172.22.2.115

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf virtual-link Displays the virtual link information.

MIB Objects
ospfVirtIfTable
ospfVirtIfAreaId
ospfVirtIfNeighbor
ospfVirtIfAuthKey
ospfVirtIfStatus
ospfVirtIfAuthType
ospfVirtIfRtrDeadInterval
ospfVirtIfHelloInterval
ospfVirtIfRetransInterval
ospfVirtIfTransitDelay

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-17
ip ospf neighbor OSPF Commands

ip ospf neighbor
Creates a static neighbor on a non-broadcast interface.
ip ospf neighbor neighbor_id {eligible | non-eligible}
no ip ospf neighbor neighbor_id

Syntax Definitions

neighbor_id A unique 32-bit IP address identical to the neighbor’s interface address.

eligible Sets this router as eligible to be the DR.
non-eligible Sets this router as not eligible to be the DR.

Defaults

parameter default
eligible | non-eligible eligible

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• NBMA (Non Broadcast Multi Access), PMP (Point-to-Multipoint), and P2P (Point-to-Point) OSPF
non-broadcast modes are supported over Ethernet interfaces (broadcast media).
• Neighboring routers on non-broadcast OSPF networks must be statically configured, because lack of
OSPF multicast capabilities prevents using normal OSPF Hello protocol discovery.
• In the case of NBMA interface the static neighbor eligibility for becoming a DR can be configured
while it is not necessary for point-to-multipoint and point-to-point interfaces.
• An interface connected to this neighbor must also be configured as a non-broadcast interface, which
can be either point-to-multipoint or point-to-point, by using the ip ospf interface type command.
• For the correct working of an OSPF NBMA network, a fully meshed network is mandatory. Also, the
neighbor eligibility configuration for a router on every other router should match the routers interface
priority configuration.

Examples
-> ip ospf neighbor 1.1.1.1 non-eligible
-> no ip ospf neighbor 1.1.1.1

Release History
Release 8.1.1; command was introduced.

page 23-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf neighbor

Related Commands

ip ospf interface type Configures the OSPF interface type.

show ip ospf neighbor Displays information on OSPF non-virtual neighbor routers.

MIB Objects
ospfNbrTable
ospfNbrPriority
ospfNbmaNbrStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-19
ip ospf area OSPF Commands

ip ospf area
Assigns an OSPF interface to a specified area.
ip ospf area area_id [summary {enable | disable}] | [type {normal | stub | nssa}]
no ip ospf area area_id

Syntax Definitions

area_id A unique 32-bit value in IP address format.

enable Enables summarization.
disable Disables summarization.
normal Sets the area as a regular OSPF area.
stub Configures an OSPF area as a stub area.
nssa Configures an OSPF area as a Not So Stubby Area (NSSA)

Defaults

parameter default
enable | disable enable
normal | stub | nssa normal

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The no form deletes the area.

• The summary options are used to enable or disable route summarization for stub and NSSA areas.
Stub and NSSA areas will not receive LSA type 3 unless summary is enabled.
• The type command allows you to chose what type of area this is going to be.

Examples
-> ip ospf area 0.0.0.1
-> ip ospf area 0.0.0.1 type stub
-> ip ospf area 0.0.0.1 type normal
-> no ip ospf area 0.0.0.1

Release History
Release 8.1.1; command was introduced.

page 23-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf area

Related Commands

ip ospf area default-metric Creates or deletes an OSPF default metric.

ip ospf area range Creates a route summarization instance whereby a range of
addresses will be advertised as a single route.
show ip ospf area Displays either all OSPF areas, or a specified OSPF area.

MIB Objects
ospfAreaTable
ospfImportAsExtern
ospfAreaSummary
ospfAreaId

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-21
ip ospf area default-metric OSPF Commands

ip ospf area default-metric

Creates or deletes a default metric for stub or Not So Stubby Area (NSSA) areas. The default metric
configures the type of cost metric that a default area border router (ABR) will advertise in the default
summary Link State Advertisement (LSA).
ip ospf area area_id default-metric tos [[cost cost] | [type {ospf | type 1 | type 2}]
no ip ospf area area_id default-metric tos

Syntax Definitions

area_id A unique 32-bit value in IP address format.

tos Type of service. The valid range is 0–15. Only ToS value 0 is supported
at this time.
cost The numerical cost of this area and ToS. Only 0 is supported in the cur-
rent release.
ospf Advertises external routes as OSPF autonomous system external (ASE)
routes.
type1 Advertises external routes as a Type 1 (non-OSPF) metric.
type2 Advertises external routes as a Type 2 (calculated weight value from
non-OSPF protocol) metric.

Defaults

parameter default
tos 0
ospf | type 1 | type 2 ospf

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The no form deletes the default metric from the specified area.

• The type command configures the type of cost metric for the specified ToS.To ensure that internal
routers receiving external route advertisements choose the correct route, all border routers advertising a
particular external network should be configured to advertise the route using the same metric type. That
is, they must all advertise the route using an OSPF, Type 1, or Type 2 metric.

Examples
-> ip ospf area 1.1.1.1 default-metric 0
-> no ip ospf area 1.1.1.1 default-metric 0

page 23-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf area default-metric

Release History
Release 8.1.1; command was introduced.

Related Commands

ip ospf area Creates or deletes an OSPF area.

ip ospf area range Creates a route summarization instance whereby a range of
addresses will be advertised as a single route.
show ip ospf area Displays either all OSPF areas, or a specified OSPF area.

MIB Objects
ospfStubAreaTable
ospfStubAreaId
ospfStubTOS
ospfStubStatus
ospfStubMetric
ospfStubMetricType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-23
ip ospf area range OSPF Commands

ip ospf area range

Creates a route summarization instance whereby a range of addresses assigned for the route at the area
border router will be advertised.
ip ospf area area_id range {summary | nssa} ip_address subnet_mask [effect {admatching |
noMatching}]
no ip ospf area area_id range {summary | nssa} ip_address subnet_mask

Syntax Definitions

area_id A unique 32-bit value in IP address format.

summary Advertises the address range as a summary link state advertisement
(LSA).
nssa Advertises the address range of Not So Stubby Area (NSSA) routes as a
Type 5 advertisement.
ip_address A 32-bit IP address for the range’s area.
subnet_mask A 32-bit subnet mask that determines how many bits of the IP address
denote the network number.
admatching Determines that routes specified falling within the specified range will
be advertised.
noMatching Determines that any route falling within the specified range will not be
advertised.

Defaults

parameter default
summary | nssa summary
admatching | noMatching admatching

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Route summarization is the consolidation of addresses within an area which are advertised as a single
route. When network numbers in an area are assigned consecutively, the area border router can be
configured, using this command, to advertise a route that aggregates all the individual networks within
the range.
• Using this command causes a single route to be advertised, for an address range in the specified area, to
other areas.
• An NSSA (Not So Stubby Area) is similar to a stub area. However, where autonomous system (AS)
external routes cannot be imported into a stub area, an NSSA will allow the importing of some AS
external routes.

page 23-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf area range

• Area ranges, once created, are enabled by default. Classless Inter-Domain Routing (CIDR) can work
with OSPF to make route summarization more efficient. This is especially true for the summarization
of routes in the global database. OSPF area address ranges can be configured on area border routers

Examples
-> ip ospf area 1.1.1.1 range summary 172.22.2.0 255.255.255.0
-> no ip ospf area 1.1.1.1 range summary 172.22.2.0 255.255.255.0

Release History
Release 8.1.1; command was introduced.

Related Commands

ip ospf area Creates or deletes an OSPF area.

ip ospf area default-metric Creates or deletes an OSPF default metric.
show ip ospf area range Displays all or specified route summaries in a given area.

MIB Objects
ospfAreaAggregateTable
ospfAreaAggregateAreaId
ospfAreaAggregateLsdbType
ospfAreaAggregateNet
ospfAreaAggregateMask
ospfAreaAggregateEffect
ospfAreaAggregateStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-25
ip ospf interface OSPF Commands

ip ospf interface
Creates and deletes an OSPF interface.
ip ospf interface {interface_name}
no ip ospf interface {interface_name}

Syntax Definitions

interface_name The name of the interface.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to delete an OSPF interface.

• The interface name cannot contain spaces.

Examples
-> ip ospf interface vlan-101
-> no ip ospf interface vlan-101

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf interface Displays the status and statistics of an OSPF interface.

MIB Objects
ospfIfTable
ospfIfIpAddress
alaOspfIfAugTable
alaOspfIfIntfName

page 23-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf interface admin-state

ip ospf interface admin-state

Enables or disables the administrative status on an OSPF interface.
ip ospf interface {interface_name} admin-state {enable | disable}
no ip ospf interface {interface_name} admin-state {enable | disable}

Syntax Definitions

interface_name The name of the interface.

enable Enables the OSPF interface.
disable Disables the OSPF interface.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to delete an OSPF interface.

• The OSPF interface must be enabled for it to participate in the OSPF protocol.

Examples
-> ip ospf interface vlan-101 admin-state enable
-> ip ospf interface vlan-101 admin-state disable
-> no ip ospf interface vlan-101 admin-state enable
-> no ip ospf interface vlan-101 admin-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf interface Displays the status and statistics of an OSPF interface.

MIB Objects
ospfIfTable
ospfIfAdminStat

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-27
ip ospf interface area OSPF Commands

ip ospf interface area

Configures an OSPF area identifier for this interface.
ip ospf interface {interface_name} area area_id

Syntax Definitions

interface_name The name of the interface.

area_id A unique 32-bit value in IP address format.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
An interface must be assigned to an area to become operational.

Examples
-> ip ospf interface vlan-101 area 0.0.0.1

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf area Displays either all the OSPF areas, or a specified OSPF area.
show ip ospf interface Displays the status and statistics of an OSPF interface.

MIB Objects
ospfIfTable
ospfIfAreaId

page 23-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf interface auth-key

ip ospf interface auth-key

Configures an OSPF authentication key for simple authentication on an interface.
ip ospf interface {interface_name} auth-key key_string

Syntax Definitions

interface_name The name of the interface.

key_string An authentication key (8 characters maximum).

Defaults
The default for the authentication key string is a null string.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Sets a password as a simple text string of 8 ASCII characters.

• Must be used in conjunction with the auth-type command, described on page 23-30, set to simple.

Examples
-> ip ospf interface vlan-101 auth-key pass

Release History
Release 8.1.1; command was introduced.

Related Commands

ip ospf interface auth-type Sets the authentication type.

show ip ospf interface Displays the status and statistics of an OSPF interface.

MIB Objects
ospfIfTable
ospfIfAuthKey

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-29
ip ospf interface auth-type OSPF Commands

ip ospf interface auth-type

Sets the OSPF interface authentication type. Authentication allows the router to only respond to other
routers that have the correct authentication information.
ip ospf interface {interface_name} auth-type [none | simple | md5]

Syntax Definitions

interface_name The name of the interface.

none No authentication.
simple Simple, clear text authentication.
md5 MD5 encrypted authentication.

Defaults

parameter default
none | simple | md5 none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use this command to set the type of authentication that the OSPF interface uses to validate requests for
route information from other OSPF neighbors on this interface.
• Simple authentication is authentication that uses only a text string as the password. The authentication
type simple is used in conjunction with the auth-key keyword described, on page 23-29.
• MD5 authentication is encrypted authentication that uses an encryption key string and a key
identification number. Both of these are necessary as the password. The authentication type md5 is
used in conduction with the commands described on page 23-34 and page 23-36. One command
enables MD5 and the other sets the key identification number.

Examples
-> ip ospf interface vlan-101 auth-type-simple

Release History
Release 8.1.1; command was introduced.

page 23-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf interface auth-type

Related Commands

ip ospf interface auth-key Sets the password for simple authentication.

show ip ospf interface Displays the status and statistics of an OSPF interface.

MIB Objects
ospfIfTable
ospfIfAuthType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-31
ip ospf interface dead-interval OSPF Commands

ip ospf interface dead-interval

Configures the OSPF interface dead interval.
ip ospf interface {interface_name} dead-interval seconds

Syntax Definitions

interface_name The name of the interface.

seconds The dead interval, in seconds. The valid range is 1–65535.

Defaults

parameter default
seconds 40
(broadcast and point-to-point)
seconds 120
(NBMA and point-to-multipoint)

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This is the interval, in seconds, after which a neighbor on this interface is considered dead if no hello
packets have been received from this neighbor.
• This interval should be greater than the hello interval or the multiple of the hello interval.

Examples
-> ip ospf interface vlan-101 dead-interval 50

Release History
Release 8.1.1; command was introduced.

Related Commands

ip ospf interface hello-interval Configures the OSPF interface hello interval.

show ip ospf interface Displays the status and statistics of an OSPF interface.

MIB Objects
ospfIfTable
ospfIfRtrDeadInterval

page 23-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf interface hello-interval

ip ospf interface hello-interval

Configures the OSPF interface hello interval.
ip ospf interface {interface_name} hello-interval seconds

Syntax Definitions

interface_name The name of the interface.

seconds The hello interval, in seconds. The valid range is 0–65535. A value of 0
creates a passive OSPF interface.

Defaults

parameter default
seconds 10
(broadcast and point-to-point)
seconds 30
(NBMA and point-to-multipoint)

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This is the interval between two consecutive hello packets sent out on this interface.

Examples
-> ip ospf interface vlan-101 hello-interval 50

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf interface Displays the status and statistics of an OSPF interface.

MIB Objects
ospfIfTable
ospfIfHelloInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-33
ip ospf interface md5 OSPF Commands

ip ospf interface md5

Creates and deletes the OSPF interface MD5 key identification number.
ip ospf interface {interface_name} md5 key_id [enable | disable]

Syntax Definitions

interface_name The name of the interface.

key_id A key identification number. The key identification number specifies a
number that allows MD5 encrypted routers to communicate. Both
routers must use the same key ID. The valid range is 1–255.
enable Enables the interface key.
disable Disables the interface key.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• MD5 authentication can be used to encrypt information sent over the network. MD5 authentication
works by using shared secret keys. Keys are used to sign the packets with an MD5 checksum, and they
cannot be forged or tampered with. Since the keys are not included in the packet, snooping the key is
not possible.
• This command is used in conjunction with the commands described on page 23-30 and page 23-36.

• The no variant deletes the key ID number.

Examples
-> ip ospf interface vlan-101 md5 100
-> ip ospf interface vlan-101 md5 10 disable
-> ip ospf interface vlan-101 md5 10 enable

Release History
Release 8.1.1; command was introduced.

page 23-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf interface md5

Related Commands

ip ospf interface auth-type Sets the OSPF interface authentication type.

ip ospf interface md5 key Configures the OSPF key ID and key.
show ip ospf interface Displays the status and statistics of an OSPF interface.

MIB Objects
alaOspfIfMd5Table
alaOspfIfMd5IpAddress
alaOspfIfMd5KeyId

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-35
ip ospf interface md5 key OSPF Commands

ip ospf interface md5 key

Configures the OSPF key string. This interface MD5 string, along with the key identification number,
enables the interface to encode MD5 encryption.
ip ospf interface {interface_name} md5 key_id key key_string

Syntax Definitions

interface_name The name of the interface.

key_id The key ID. The valid range is 1–255.
key_string A key string.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used in conjunction with the commands described above on page 23-30 and page
23-34.
• For MD5 authentication to function properly the same key string must be configured on the neighbor-
ing router for that interface.

Examples
-> ip ospf interface vlan-101 md5 100 key 1

Release History
Release 8.1.1; command was introduced.

Related Commands

ip ospf interface auth-type Sets the OSPF interface authentication type.

ip ospf interface md5 Creates and deletes the OSPF interface MD5 key identification
number.
show ip ospf interface Displays the status and statistics of an OSPF interface.

MIB Objects
alaOspfIfMd5Table
alaOspfIfMd5IpAddress
alaOspfIfMd5KeyId
alaOspfIfMd5Key

page 23-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf interface type

ip ospf interface type

Configures the OSPF interface type.
ip ospf interface {interface_name} type {point-to-point | point-to-multipoint | broadcast | non-
broadcast}

Syntax Definitions

interface_name The name of the interface.

point-to-point Sets the interface to be a point-to-point OSPF interface.
point-to-multipoint Sets the interface to be a point-to-multipoint OSPF interface.
broadcast Sets the interface to be a broadcast OSPF interface.
non-broadcast Sets the interface to be NBMA (Non Broadcast Multi Access) OSPF
interface.

Defaults

parameter default
broadcast | non-broadcast | broadcast
point-to-point| point-to-
multipoint

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command sets an interface to be broadcast, non-broadcast, point-to-point, or point-to-multipoint.

• If the type is non-broadcast or point-to-multipoint, static neighbors should be configured.

Examples
-> ip ospf interface vlan-101 type non-broadcast

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-37
ip ospf interface type OSPF Commands

Related Commands

ip ospf neighbor Creates a static neighbor on a Non Broadcast Multi Access

(NBMA) interface.
show ip ospf interface Displays the status and statistics of an OSPF interface.

MIB Objects
ospfIfTable
ospfIfType

page 23-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf interface cost

ip ospf interface cost

Configures the OSPF interface cost.
ip ospf interface {interface_name} cost cost

Syntax Definitions

interface_name The name of the interface.

cost The interface cost. The valid range is 0 to 65535.

Defaults

parameter default
cost 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The configured interface cost, if any, is used during OSPF route calculations.

Examples
-> ip ospf interface vlan-101 cost 10

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf interface Displays the status and statistics of an OSPF interface.

MIB Objects
ospfIfMetricTable
ospfIfMetricIpAddress
ospfIfMetricValue

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-39
ip ospf interface poll-interval OSPF Commands

ip ospf interface poll-interval

Configures the OSPF poll interval for a Non Broadcast Multi Access (NBMA) interface.
ip ospf interface {interface_name} poll-interval seconds

Syntax Definitions

interface_name The name of the interface.

seconds The poll interval, in seconds. The valid range is 1–2147483647.

Defaults

parameter default
seconds 120

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This parameter configures the larger time interval, in seconds, between hello packets sent to an inactive
neighbor.

Examples
-> ip ospf interface vlan-101 poll-interval 500

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf interface Displays the status and statistics of an OSPF interface.

MIB Objects
ospfIfTable
ospfIfPollInterval

page 23-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf interface priority

ip ospf interface priority

Configures the OSPF interface priority. The priority number helps determine the eligibility of this router
to become the designated router on the network.
ip ospf interface {interface_name} priority priority

Syntax Definitions

interface_name The name of the interface.

priority The interface priority. The valid range is 0–255.

Defaults

parameter default
priority 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
When two routers attached to a network both attempt to become the designated router, the one with the
highest priority becomes the designated router. A router whose router priority is set to 0 is ineligible to
become the designated router.

Examples
-> ip ospf interface vlan-101 priority 100

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf interface Displays the status and statistics of an OSPF interface.

MIB Objects
ospfIfTable
ospfIfRtrPriority

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-41
ip ospf interface retrans-interval OSPF Commands

ip ospf interface retrans-interval

Configures the OSPF interface retransmit interval.
ip ospf interface {interface_name} retrans-interval seconds

Syntax Definitions

interface_name The name of the interface.

seconds The retransmit interval, in seconds. The valid range 0–3600.

Defaults

parameter default
seconds 5

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The number of seconds between link retransmission of OSPF packets on this interface.

Examples
-> ip ospf interface vlan-101 retrans-interval 500

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf interface Displays the status and statistics of an OSPF interface.

MIB Objects
ospfIfTable
ospfIfRetransInterval

page 23-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf interface transit-delay

ip ospf interface transit-delay

Configures the OSPF interface transit delay.
ip ospf interface {interface_name} transit-delay seconds

Syntax Definitions

interface_name The name of the interface.

seconds The transit delay, in seconds. The valid range is 0–3600.

Defaults

parameter default
seconds 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The estimated number of seconds required to transmit a link state update over this interface. This
command takes into account transmission and propagation delays and must be greater than 0.

Examples
-> ip ospf interface vlan-101 transit-delay 100

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf interface Displays the status and statistics of an OSPF interface.

MIB Objects
ospfIfTable
ospfIfTransitDelay

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-43
ip ospf restart-support OSPF Commands

ip ospf restart-support
Configures support for the graceful restart feature on an OSPF router.
ip ospf restart-support {planned-unplanned | planned-only}
no ip ospf restart-support

Syntax Definitions

planned-unplanned Specifies support for planned and unplanned restarts.

planned-only This parameter is currently not supported.

Defaults
Graceful restart is disabled be default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to disable support for the graceful restart feature on an OSPF router.

• The minimum hardware configuration for this command is a redundant CMM configuration.

Examples
-> ip ospf restart-support planned-unplanned
-> no ip ospf restart-support

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf restart Displays the OSPF graceful restart related configuration and status.

MIB Objects
alaProtocolOspf
alaOspfRestartSupport

page 23-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf restart-interval

ip ospf restart-interval
Configures the grace period for achieving a graceful OSPF restart.
ip ospf restart-interval [seconds]

Syntax Definitions

seconds The hitless restart timeout interval, in seconds. The valid range is 0–
1800.

Defaults

parameter default
seconds 120

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The minimum hardware configuration for this command is a redundant CMM configuration. This
command is not supported on OmniSwitch 10K switches with a single CMM.

Example
-> ip ospf restart-interval 600

Release History
Release 8.1.1; command was introduced.

Related Commands

ip ospf restart-support Administratively enables and disables support for the graceful
restart feature on an OSPF router.
show ip ospf restart Displays the OSPF graceful restart related configuration and status.

MIB Objects
alaProtocolOspf
alaOspfRestartInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-45
ip ospf restart-helper admin-state OSPF Commands

ip ospf restart-helper admin-state

Administratively enables and disables the capability of an OSPF router to operate in helper mode in
response to a router performing a graceful restart.
ip ospf restart-helper [admin-state {enable | disable}]

Syntax Definitions

enable Enables the capability of an OSPF router to operate in helper mode.

disable Disables the capability of an OSPF router to operate in helper mode.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The minimum hardware configuration for this command is a redundant CMM configuration. This
command is not supported on OmniSwitch 10K switches with a single CMM.

Examples
-> ip ospf restart-helper admin-state disable
-> ip ospf restart-helper admin-state enable

Release History
Release 8.1.1; command was introduced.

Related Commands

ip ospf restart-support Administratively enables and disables support for the graceful
restart feature on an OSPF router.
ip ospf restart-helper strict-lsa- Administratively enables and disables whether or not a changed
checking admin-state Link State Advertisement (LSA) will result in termination of grace-
ful restart by a helping router.
show ip ospf restart Displays the OSPF graceful restart related configuration and status.

MIB Objects
alaProtocolOspf
alaOspfRestartHelperSupport

page 23-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf restart-helper strict-lsa-checking admin-state

ip ospf restart-helper strict-lsa-checking admin-state

Administratively enables and disables whether or not a changed Link State Advertisement (LSA) will
result in termination of graceful restart by a helping router.
ip ospf restart-helper strict-lsa-checking admin-state {enable | disable}

Syntax Definitions

enable Enables whether or not a changed LSA will result in termination of

graceful restart by a helping router.
disable Disables whether or not a changed LSA will result in termination of
graceful restart by a helping router.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The minimum hardware configuration for this command is a redundant CMM configuration. This
command is not supported on OmniSwitch 10K switches with a single CMM.

Examples
-> ip ospf restart-helper strict-lsa-checking admin-state disable
-> ip ospf restart-helper strict-lsa-checking admin-state enable

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-47
ip ospf restart-helper strict-lsa-checking admin-state OSPF Commands

Related Commands

ip ospf restart-support Administratively enables and disables support for the graceful
restart feature on an OSPF router.
ip ospf restart-helper admin- Administratively enables and disables the capability of an OSPF
state router to operate in helper mode in response to a router performing a
graceful restart.
show ip ospf restart Displays the OSPF graceful restart related configuration and status.

MIB Objects
alaProtocolOspf
alaOspfRestartHelperSupport

page 23-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands ip ospf restart initiate

ip ospf restart initiate

Initiates a planned graceful restart.
ip ospf restart initiate

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• You must execute this command on the primary CMM before executing a takeover command.

• The minimum hardware configuration for this command is a redundant CMM configuration. This
command is not supported on OmniSwitch 10K switches with a single CMM.

Example
-> ip ospf restart initiate

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf restart Displays the OSPF graceful restart related configuration and status.

MIB Objects
alaProtocolOspf
alaOspfRestartInitiate

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-49
show ip ospf OSPF Commands

show ip ospf
Displays the OSPF status and general configuration parameters.
show ip ospf

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used to display the general configuration parameters of the OSPF router.

• See the Related Commands section below to modify the displayed parameters.

Examples
-> show ip ospf

Router Id = 10.255.11.242,
OSPF Version Number = 2,
Admin Status = Enabled,
Area Border Router? = No,
AS Border Router Status = Disabled,
Route Redistribution Status = Disabled,
Route Tag = 0,
SPF Hold Time (in seconds) = 10,
SPF Delay Time (in seconds) = 5,
MTU Checking = Disabled,
# of Routes = 0,
# of AS-External LSAs = 0,
# of self-originated LSAs = 0,
# of LSAs received = 0,
External LSDB Limit = -1,
Exit Overflow Interval = 0,
# of SPF calculations done = 0,
# of Incr SPF calculations done = 0,
# of Init State Nbrs = 0,
# of 2-Way State Nbrs = 0,
# of Exchange State Nbrs = 0,
# of Full State Nbrs = 0,
# of attached areas = 1,
# of Active areas = 0,
# of Transit areas = 0,
# of attached NSSAs = 0

page 23-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands show ip ospf

output definitions
Router Id The unique identification for the router.
OSPF Version Number The version of OSPF the router is running.
Admin Status Whether OSPF is currently enabled or disabled on the router.
Area Border Router? Whether the router status is an area router or not.
AS Border Router Status Whether the area Autonomous System Border Router status of this
router is enabled or disabled.
Route Redistribution Status Whether route redistribution is enabled or disabled on the router. This is
set using the ip ospf default-originate command.
Route Tag Shows the route tag for this router.
SPF Hold Time Shows the time in seconds between the reception of an OSPF topology
change and the start of a SPF calculation.
SPF Delay Time Shows the time in seconds between consecutive SPF calculations.
MTU Checking Shows whether Maximum Transfer Unit checking is enabled or dis-
abled. This is set using the ip ospf mtu-checking command.
# of routes The total number of OSPF routes known to this router.
# of AS-External LSAs The number of external routes learned from outside the router’s Auton-
omous System (AS).
# of self-originated LSAs The number of times a new Link State Advertisement has been sent
from this router.
# of LSAs received The number of times a new Link State Advertisement has been received
by this router.
External LSDB Limit The maximum number of entries allowed in the external Link State
Database.
Exit Overflow Interval The number of seconds the router remains in the overflow state before
attempting to leave it. This is set using the ip ospf exit-overflow-
interval command.
# of SPF calculations done The number of SPF calculations that have occurred.
# of Incr SPF calculations The number of incremental SPF calculations done.
done
# of Init State Nbrs The number of neighbors in the initialization state.
# of 2-Way State Nbrs The number of OSPF 2-way state neighbors on this router.
# of Exchange State Nbrs The number of neighbors in the exchange state.
# of Full State Nbrs The number of neighbors in the full state.
# of attached areas The number of areas that are configured on the router.
# of Active areas The number of areas that are active.
# of Transit areas The number of transit areas that are configured on the router.
# of attached NSSAs The number of Not So Stubby Areas that are configured on the router.

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-51
show ip ospf OSPF Commands

Related Commands

ip ospf admin-state Enables or disables the administration of OSPF on the router.

ip ospf mtu-checking Enables or disables the use of Maximum Transfer Unit (MTU)
checking.
ip ospf spf-timer Configures timers for SPF calculation.
ip ospf default-originate Enables or disables OSPF redistribution
ip ospf asbr Configures the router as an Autonomous System Border Router
(ASBR). This command is currently not supported.
ip ospf extlsdb-limit Assigns a limit to the number of External Link-State Database
(LSDB) entries that can be learned.
ip ospf exit-overflow-interval This command sets the overflow interval value.
ip ospf route-tag Configures a tag value for Autonomous System External (ASE)
routes created.
ip router router-id Configures the router ID for the router.

MIB Objects
ospfGeneralGroup
ospfRouterId
ospfAdminStat
ospfVersionNumber
ospfAreaBdrRtrStatus
ospfASBdrRtrStatus
ospfExternLsaCount
ospfExternLsaCksumSum
ospfTOSSupport
ospfOriginateNewLsas
ospfRxNewLsas
ospfExtLsdbLimit
ospfExitOverflowInterval
alcatelIND1Ospf
alaOspfRedistAdminStatus
alaOspfRedistRouteTag
alaOspfTimerSpfDelay
alaOspfTimerSpfHold
alaOspfRouteNumber
alaOspfMTUCheck

page 23-52 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands show ip ospf border-routers

show ip ospf border-routers

Displays information regarding all or specified border routers.
show ip ospf border-routers [area_id] [router_id] [tos] [gateway]

Syntax Definitions

area_id A unique 32-bit value in IP address format.

router_id A unique 32-bit value, such as an IP address, that identifies a neighbor-
ing router in the Autonomous System.
tos The Type of Service. The valid range is 0–15. Only ToS value 0 is sup-
ported at this time.
gateway The 32-bit IP address of the gateway for the border router being dis-
played.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used to display a list of border routers known by this OSPF router.

• By using the optional parameters, you can display the border routers using the specified parameter. For
example, to find a router using a router ID of 1.1.1.1, enter the command using the router ID of 1.1.1.1
as a search criteria.
• See the related commands sections below to modify the list.

Examples
-> show ip ospf border-routers 10.0.0.0

Router Id Area Id Gateway TOS Metric

-----------------+------------------+--------------------+------+--------
10.0.0.0 1.0.0.1 143.209.92.71 1 1

output definitions
Router ID The unique identification for the router.
Area ID A unique 32-bit value, such as an IP address, that identifies a neighbor-
ing router in the Autonomous System.
Gateway The next hop interface on which the border router has been learned.
ToS The Type of Service. Only ToS value 0 is supported at this time.
Metric The cost to the border router.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-53
show ip ospf border-routers OSPF Commands

Release History
Release 8.1.1; command was introduced.

Related Commands
N/A

MIB Objects
alaOspfBdrRouterAreaId
alaOspfBdrRouterId
alaOspfBdrRouterTos
alaOspfBdrRouterMetric

page 23-54 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands show ip ospf ext-lsdb

show ip ospf ext-lsdb

Displays external Link State Advertisements known by this router.
show ip ospf ext-lsdb [linkstate-id ls_id] [router-id router_id]

Syntax Definitions

ls_id The Link state ID. The ID is a unique 32-bit value such as an IP address.
This number is used as a record in the link state database.
router_id The Router ID. The ID is a unique 32-bit value such as an IP address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used to display the external link state database (LSDB) for the OSPF router.

• This command can be used for OSPF debugging purposes, specifically to narrow down sections of
attached areas to determine which sections are receiving the specified external LSAs. You may specify
only the parameters from the area LSDB in which you are interested using the optional command
parameters.
• See the Related Commands section below to modify the list.

Examples
-> show ip ospf ext-lsdb

LS Id Orig Router-Id SeqNo Age Protocol

-----------------+------------------+----------+--------+----------
198.168.100.100 198.168.100.100 10 100 STATIC

output definitions
LS Id The Link state ID. The ID is a unique 32-bit value, such as an IP
address. This number is used as a record in the link state database.
Orig Router-Id The router ID of the router that originated the external LSDB.
SeqNo The advertisement sequence number (i.e., a value used to identify old
and duplicate link state advertisements).
Age The age of the LSA in seconds. That is, the duration for which this
entry has existed in the external database.
Protocol The type of protocol, if any.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-55
show ip ospf ext-lsdb OSPF Commands

Release History
Release 8.1.1; command was introduced.

Related Commands

ip ospf extlsdb-limit Assigns a limit to the number of External Link-State Database

(LSDB) entries that can be learned.

MIB Objects
ospfExtLsdbTable
ospfExtLsdbLsid
ospfExtLsdbRouterId
ospfExtLsdbSequence
ospfExtLsdbAge
ospfExtLsdbType

page 23-56 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands show ip ospf host

show ip ospf host

Displays information on the configured OSPF hosts.
show ip ospf host [ip_address]

Syntax Definitions

ip_address A 32-bit IP address for a directly attached host.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used to display general information for OSPF hosts directly attached to this router.

• See the Related Commands section below to modify the list.

Examples
-> show ip ospf host 172.22.2.115

Host Address TOS Metric Status AreaId

-----------------+-------+-----------+--------+-----------------
143.209.92.12 1 0 Up 0.0.0.0

output definitions
Host Address A 32-bit IP address for a directly attached host. This can be set using
the ip ospf host command.
ToS The Type of Service traffic from the host is labeled as. ToS is set using
the ip ospf host command.
Metric The metric assigned to the host. Metric is set using the ip ospf host
command.
Status Whether the host is enabled or disabled.
AreaId The area identification for the host’s area.

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-57
show ip ospf host OSPF Commands

Related Commands

ip ospf host Creates and deletes an OSPF entry for directly attached hosts.

MIB Objects
ospfHostTable
ospfHostIpAddress
ospfHostTOS
ospfHostMetric
ospfHostStatus
ospfHostAreaID

page 23-58 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands show ip ospf lsdb

show ip ospf lsdb

Displays LSAs in the Link State Database associated with each area.
show ip ospf lsdb [area_id] [rtr | net | netsum | asbrsum] [linkstate-id ls_id] [router-id router_id]

Syntax Definitions

area_id A unique 32-bit value in IP address format.

rtr Specifies router LSAs.
net Specifies network LSAs.
netsum Specifies network summary LSAs.
asbrsum Specifies Autonomous System Border Router summary LSAs.
ls_id The Link state ID. The ID is a unique 32-bit value, such as an IP
address. This number is used as a record in the link state database.
router_id The Router ID. The ID is a unique 32-bit value such as an IP address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used to display the Link State Database (LSDB) of the OSPF router. This command
can be used for OSPF debugging purposes, specifically to narrow down sections of an area to deter-
mine which sections are receiving the specified link state advertisements. You may specify only the
parameters from the area LSDB in which you are interested using the optional command parameters.
• You can view link state advertisements by specifying either a link state identifier or a router identifier.
However, when specifying a router ID, you must also supply a valid link state ID.

Examples
-> show ip ospf lsdb
Area Id Type LS Id Orig Router-Id SeqNo Age
----------------+-------+----------------+----------------+------------+-----
0.0.0.1 OSPF 198.168.100.100 198.168.100.100 1 100

output definitions
Area Id The area identification for the area to which the record belongs.
Type The protocol type from where the route was learned.
LS Id The Link state ID. The ID is a unique 32-bit value such as an IP
address. This number is used as a record in the link state database.
Orig Router-Id The router ID of the router that originated the external LSDB.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-59
show ip ospf lsdb OSPF Commands

output definitions (continued)

SeqNo The advertisement sequence number (i.e., a value used to identify old
and duplicate link state advertisements).
Age The age of the LSA in seconds. That is, the duration for which this
entry has existed in the external database.

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf Displays the OSPF status and general configuration parameters.

MIB Objects
ospfLsdbTable
ospfLsdbAreaId
ospfLsdbType
ospfLsdbLsid
ospfLsdbRouterId
ospfLsdbSequence
ospfLsdbAge

page 23-60 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands show ip ospf neighbor

show ip ospf neighbor

Displays information on OSPF non-virtual neighbor routers.
show ip ospf neighbor [ip_address]

Syntax Definitions

ip_address A 32-bit IP address of the neighboring router.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used to display all non-virtual neighbors of the OSPF router.

• See the Related Commands section below to modify the list.

Examples
-> show ip ospf neighbor

IP Address Area Id Router Id Vlan State Mode

----------------+----------------+----------------+----+-------+--------
1.1.1.1 255.255.255.255 0.0.0.0 0 Down Static

output definitions
IP Address The IP address of the neighbor.
Area Id A unique 32-bit value, such as an IP address, that identifies the
neighboring router in the Autonomous System.
Router Id The unique identification for the neighboring router.
VlanId The VLAN corresponding to this interface on which the neighbor is
reachable.
State The state of the OSPF neighbor adjacency.
Mode What type of neighbor, either Dynamic (learned) or Static.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-61
show ip ospf neighbor OSPF Commands

-> show ip ospf neighbor 1.1.1.1

Neighbor's IP Address = 1.1.1.1,
Neighbor's Router Id = 0.0.0.0,
Neighbor's Area Id = 255.255.255.255,
Neighbor's DR Address = 0.0.0.0,
Neighbor's BDR Address = 0.0.0.0,
Neighbor's Priority = 1,
Neighbor's State = Down,
Hello Suppressed ? = No,
Neighbor's type = Static,
DR Eligible = Yes,
# of State Events = 0,
Mode = Slave,
MD5 Sequence Number = 0,
Time since Last Hello = 0 sec,
# of Outstanding LS Requests = 0,
# of Outstanding LS Acknowledgements = 0,
# of Outstanding LS Retransmissions = 0,
Restart Helper Status = Not Restarting,
Restart Age (in seconds) = 0 sec,
Last Restart Helper Exit Reason = None

output definitions
Neighbor’s IP Address The IP address of the neighbor.
Neighbor’s Router Id The identification number for the selected host’s record. It is most often
the router’s IP address.
Neighbor’s Area Id Identifier of the OSPF Area to which the neighbor is attached.
255.255.255.255 shows that this neighbor is not attached to any area.
Neighbor's DR Address The address of the neighbors Designated Router.
Neighbor's BDR Address The address of the neighbors Backup Designated Router.
Neighbor's Priority The priority value for this neighbor becoming the DR.
Neighbor's State The condition of the OSPF neighbor’s state machine.
Hello Suppressed Whether sending hello messages to this neighbor is suppressed.
Neighbor’s type What type of neighbor this is, either dynamic or static.
DR Eligible Shows the eligibility status of the static neighbor. If it is configured as
“ineligible” during creation of the neighbor, it shows up as No. Other-
wise, if configured as Eligible (the default), it shows up as Yes.
# of State Events The number of state events restricted for this neighbor and the local
router.
Mode The role the neighbor has with the local router during DD Exchange,
which can be Master or Slave.
MD5 Sequence Number The sequence number of the MD5 authorization key.
Time since Last Hello The amount of time (in seconds) since the last HELLO messages was
received from this neighbor.
# of Outstanding LS The number of Link State requests to this neighbor that have not
Requests received a response from this neighbor.
# of Outstanding LS Number of Link state Acknowledgements queued up by the local router
Acknowledgements to be sent to the neighbor.

page 23-62 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands show ip ospf neighbor

output definitions (continued)

# of Outstanding LS The number of Link State updates to the neighbor that need to be
Retransmissions retransmitted by the OSPF router.
Restart Helper Status Indicates whether the router is acting as a hitless restart helper for the
neighbor.
Restart Age The remaining time, in seconds, for the current OSPF hitless restart
interval if the router is acting as a restart helper for the neighbor.
Last Restart Helper Exit The outcome of the last attempt at acting as a hitless restart helper for
Reason the neighbor.

Release History
Release 8.1.1; command was introduced.

Related Commands

ip ospf neighbor Creates a static neighbor on a Non Broadcast Multi Access

(NBMA) interface.

MIB Objects
ospfNbrTable
ospfNbrIpAddr
ospfNbrRtrId
ospfNbrOptions
ospfNbrPriority
ospfNbrState
ospfNbrEvents
ospfNbrHelloSuppressed
alaOspfNbrAugTable
alaOspfNbrRestartHelperStatus
alaOspfNbrRestartHelperAge
alaOspfNbrRestartHelperExitReason

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-63
show ip ospf routes OSPF Commands

show ip ospf routes

Displays the OSPF routes known to the router.
show ip ospf routes [ip_addr mask tos gateway]

Syntax Definitions

ip_addr The 32-bit IP address of the route destination in dotted decimal format.
mask The IP subnet mask of the route destination.
tos The Type of Service of the route.
gateway The next hop IP address for this router.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If no variables are entered, all routes are displayed. If the variables are entered, then only routes matching
the specified criteria are shown. All the variables described above must be entered for a route match. If all
of the variables are not entered, an error message is returned.

Examples
-> show ip ospf routes

Destination/Mask Gateway Metric Vlan Type

---------------------+-----------------+--------+------+----------
198.168.100.100 195.5.2.8 0 5 AS-Ext

output definitions
Destination/Mask The destination address of the route. This can also display the destina-
tion IP address mask if it is known.
Gateway The gateway address of the route.
Metric The cost of the route.
Vlan The VLAN number on which the gateway can be routed.
Type The type of OSPF route.

Release History
Release 8.1.1; command was introduced.

page 23-64 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands show ip ospf routes

Related Commands

show ip ospf Displays the OSPF status and general configuration parameters.

MIB Objects
Alcatel1INDOspf
alaOspfRouteDest
alaOspfRouteMask
alaOspfRouteNextHop
alaOspfRouteMetric1

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-65
show ip ospf virtual-link OSPF Commands

show ip ospf virtual-link

Displays virtual link information. A virtual link is used to connect OSPF backbone routers that are not
physically contiguous.
show ip ospf virtual-link [router_id]

Syntax Definitions

router_id The router ID of the remote end of the virtual link that is to be viewed.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
See the Related Commands section below to modify the list.

Examples
-> show ip ospf virtual-link
State
Transit AreaId Router-id Link / Adjacency AuthType OperStatus
----------------+----------------+----------------+----------+------------
1.1.1.1 172.17.1.1 P2P / Full none up

output definitions
Transit AreaId The area identification for the area assigned to the virtual link.
Router-Id The destination router identification for the virtual link.
State Link The state of the virtual link with regards to the local router.
State Adjacency The state of the virtual link adjacency.
AuthType The type of authorization employed by the virtual link.
OperStatus Displays whether the virtual link is enabled or disabled.

Release History
Release 8.1.1; command was introduced.

page 23-66 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands show ip ospf virtual-link

Related Commands

ip ospf virtual-link Creates or deletes a virtual link.

show ip ospf virtual-neighbor Displays OSPF virtual neighbors.

MIB Objects
ospfVirtIfTable
ospfVirtIfAreaId
ospfVirtIfNeighbor
ospfVirtIfState
ospfVirtIfAuthType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-67
show ip ospf virtual-neighbor OSPF Commands

show ip ospf virtual-neighbor

Displays OSPF virtual neighbors. A virtual neighbor is connected to the router through a virtual link rather
than a physical one.
show ip ospf virtual-neighbor area_id router_id

Syntax Definitions

area_id A unique 32-bit value in IP address format.

router_id A unique 32-bit value, such as an IP address, that identifies the config-
ured OSPF area in the AS.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used to display all virtual neighbors for the OSPF router.

• See the Related Commands section below to modify the list.

Examples
-> show ip ospf virtual-neighbor 0.0.0.0 10.0.0.1

AreaId RouterId Priority Events RxmtQLen LastHello State

-----------------+----------------+--------+------+--------+---------+-------
0.0.0.0 10.0.0.0 1 10 100 323 INIT

output definitions
AreaId The area identification for the area of which the virtual neighbor is a
part.
RouterId The router identification of the virtual neighbor.
Priority The number used to determine whether the virtual neighbor will
become the designated router for its area.
Events The number of OSPF control message sent by the neighbor to the
router.
RxmtQlen The length (in number of packets) of the retransmit queue.
LastHello The last Hello message sent by the neighbor
State The current state the virtual neighbor is in relative to the router; this
will be INIT, Exchange, or Full.

page 23-68 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands show ip ospf virtual-neighbor

-> show ip ospf virtual-neighbor 0.0.0.1 2.0.0.254

Neighbor's IP Address = 2.0.0.254,
Neighbor's Router Id = 2.0.0.254,
Neighbor's Area Id = 0.0.0.1,
Neighbor's DR Address = 2.0.0.1,
Neighbor's BDR Address = 2.0.0.254,
Neighbor's Priority = 1,
Neighbor's State = Full,
Hello Suppressed ? = No,
Neighbor's type = Dynamic,
# of State Events = 6,
Mode = Master,
MD5 Sequence Number = 0,
Time since Last Hello = 5 sec,
Last DD I_M_MS =
# of Outstanding LS Requests = 0,
# of Outstanding LS Acknowledgements= 0,
# of Outstanding LS Retransmissions = 0,
Restart Helper Status = Not Restarting,
Restart Age (in seconds) = 0 sec,
Last Restart Helper Exit Reason = None

output definitions
Neighbor’s IP Address The IP address of the virtual neighbor.
Neighbor’s Router Id The identification number for the selected host’s record. It is most often
the router’s IP address.
Neighbor’s Area Id Identifier of the OSPF Area to which the virtual neighbor is attached.
255.255.255.255 shows that this virtual neighbor is not attached to any
area.
Neighbor's DR Address The address of the virtual neighbor’s Designated Router.
Neighbor's BDR Address The address of the virtual neighbor’s Backup Designated Router.
Neighbor's Priority The priority value for this virtual neighbor becoming the DR.
Neighbor's State The condition of the OSPF virtual neighbor’s state machine.
Hello Suppressed Whether sending hello messages to this virtual neighbor is suppressed.
Neighbor’s type What type of virtual neighbor this is, either dynamic or static.
DR Eligible Shows the eligibility status of the virtual neighbor. If it is configured as
“ineligible” during creation of the neighbor, it shows up as No.
Otherwise, if configured as Eligible (the default), it shows up as Yes.
# of State Events The number of state events restricted for this virtual neighbor and the
local router.
Mode The role the virtual neighbor has with the local router during DD
Exchange, which can be Master or Slave.
MD5 Sequence Number The sequence number of the MD5 authorization key.
Time since Last Hello The amount of time (in seconds) since the last HELLO messages was
received from this virtual neighbor.
Last DD I_M_MS The initialize (I), more (M) and master (MS) bits, and Options field
Data Description (DD) packet received from the virtual neighbor. This
parameter is used to determine whether the next DD packet has been
received or not.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-69
show ip ospf virtual-neighbor OSPF Commands

output definitions (continued)

# of Outstanding LS The number of Link State requests to this virtual neighbor that have not
Requests received a response from this virtual neighbor.
# of Outstanding LS Number of Link state Acknowledgements queued up by the local router
Acknowledgements to be sent to the virtual neighbor.
# of Outstanding LS The number of Link State updates to the virtual neighbor that need to be
Retransmissions retransmitted by the OSPF router.
Restart Helper Status Indicates whether the router is acting as a hitless restart helper for the
virtual neighbor.
Restart Age The remaining time, in seconds, for the current OSPF hitless restart
interval if the router is acting as a restart helper for the virtual neighbor.
Last Restart Helper Exit The outcome of the last attempt at acting as a hitless restart helper for
Reason the virtual neighbor.

Release History
Release 8.1.1; command was introduced.

Related Commands

ip ospf virtual-link Creates or deletes a virtual link.

MIB Objects
ospfVirtNbrTable
ospfVirtNbrArea
ospfVirtNbrRtrId
ospfVirtNbrState
alaOspfVirtNbrAugTable
alaOspfVirtNbrRestartHelperStatus
alaOspfVirtNbrRestartHelperAge
alaOspfVirtNbrRestartHelperExitReason

page 23-70 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands show ip ospf area

show ip ospf area

Displays either all OSPF areas, or a specified OSPF area.
show ip ospf area [area_id]

Syntax Definitions

area_id A unique 32-bit value in IP address format.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Allows you to view the details of a specified OSPF area.

• Not specifying an OSPF area will display all known areas for the OSPF router.

• See the Related Commands section below for information on modifying an area.

Examples
-> show ip ospf area

Area Id AdminStatus Type OperStatus

---------------+-------------+-------------+------------
1.1.1.1 disabled normal down
0.0.0.1 disabled normal down

-> show ip ospf area 0.0.0.0

Area Identifier = 1.1.1.1,

Admin Status = Disabled,
Operational Status = Down,
Area Type = normal,
Area Summary = Enabled,
Time since last SPF Run = 00h:00m:27s,
# of Area Border Routers known = 0,
# of AS Border Routers known = 0,
# of LSAs in area = 0,
# of SPF Calculations done = 0,
# of Incremental SPF Calculations done = 0,
# of Neighbors in Init State = 0,
# of Neighbors in 2-Way State = 0,
# of Neighbors in Exchange State = 0,
# of Neighbors in Full State = 0,
# of Interfaces attached = 0
Attached Interfaces = vlan-213

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-71
show ip ospf area OSPF Commands

output definitions
Area Identifier The unique 32-bit value, such as IP address, that identifies the OSPF
area in the AS.
Admin Status Whether the area is enabled or disabled.
Operational Status Whether the area is active.
Area Type The area type. This field will be normal, stub, or NSSA.
Area Summary Whether Area Summary is enabled or disabled.
Time since last SPF Run The last time the Shortest Path First calculation was performed.
# of Area Border Routers The number of Area Border Routers in the area.
known
# of AS Border Routers known The number of Autonomous System Border Routers in the area.
# of LSAs The total number of Link State Advertisements for the Area.
# of SPF Calculations The number of times the area has calculated the Shortest Path.
# of Incremental SPF Calcula- The number of incremental Shortest Path First calculations that have
tions been performed in the area.
# of Neighbors in Init State The number of OSPF neighbors that are in initialization.
# of Neighbors in 2-Way State The number of OSPF 2-way state neighbors in this area.
# of Neighbors in Exchange The number of OSPF neighbors that are currently establishing their sta-
State tus.
# of Neighbors in Full State The number of OSPF neighbors.
# of Interfaces attached The number of OSPF interfaces.
Attached Interfaces The names of the OSPF interfaces attached to this area.

Release History
Release 8.1.1; command was introduced.

Related Commands

ip ospf area Creates or deletes an OSPF area, assigning default metric, cost, and
type.
ip ospf area range Creates a route summarization instance whereby a range of
addresses will be advertised as a single route.
show ip ospf interface Displays OSPF interface information.

page 23-72 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands show ip ospf area

MIB Objects
ospfAreaTable
ospfAreaId
ospfImportAsExtern
ospfSpfRuns
ospfAreaBdrRtrCount
ospfAsBdrRtrCount
ospfAreaLsaCount
ospfAreaSummary
ospfAreaStatus
alaOspfIfAugTable
alaOspfIfIntfName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-73
show ip ospf area range OSPF Commands

show ip ospf area range

Displays all or specified route summaries in a given area.
show ip ospf area area_id range [{summary | nssa} ip_address ip_mask]

Syntax Definitions

area_id A unique 32-bit value in IP address format.

summary Specifies that routes are summarized.
nssa Specifies the Not So Stubby Area (NSSA) routers are summarized.
ip_address A 32-bit IP address.
ip_mask A 32-bit subnet mask.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Allows you to view the details of a specified OSPF area range.

• See the Related Commands section below for information on modifying an area.

Examples
-> show ip ospf area 0.0.0.0 range

AreaId Type Destination Advertise

---------------+---------+------------------+-----------
0.0.0.0 Summary 192.168.12.1/24 Matching
0.0.0.0 NSSA 143.209.92.71/24 noMatching

output definitions
AreaId The area identification for the area range.
Type The type of area the range is associated with.
Destination The destination address of the range.
Advertise Shows the filter effect of the range. LSAs in the range are either
advertised (Matching) or not advertised (noMatching).

Release History
Release 8.1.1; command was introduced.

page 23-74 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands show ip ospf area range

Related Commands

ip ospf area range Creates a route summarization instance whereby a range of

addresses assigned for the route at the area border router will be
advertised.

MIB Objects
ospfAreaRangeTable
ospfAreaRangeAreaId
ospfAreaRangeNet
ospfAreaRangeMask
ospfAreaRangeStatus
ospfAreaRangeEffect

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-75
show ip ospf area stub OSPF Commands

show ip ospf area stub

Displays stub default area metrics, if configured.
show ip ospf area area_id stub

Syntax Definitions

area_id A unique 32-bit value in IP address format.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip ospf area 0.0.0.1 stub

Area Id TOS Metric MetricType

---------------+-------+----------+------------
0.0.0.1 1 1 ospf

output definitions
Area Id The identification number of the stub area.
TOS The Type of Service assignment.
Metric The metric assignment of the default router in the stub area.
MetricType The metric type of the stub area. It will be either ospf, type1, or type2.

Release History
Release 8.1.1; command was introduced.

Related Commands

ip ospf area Creates or deletes an OSPF area.

page 23-76 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands show ip ospf area stub

MIB Objects
ospfStubAreaTable
ospfStubAreaId
ospfStubTOS
ospfStubMetric
ospfStubStatus
ospfStubMetricType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-77
show ip ospf interface OSPF Commands

show ip ospf interface

Displays OSPF interface information.
show ip ospf interface [interface_name]

Syntax Definitions

interface_name The name of the interface.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Not specifying an interface name displays all known interfaces for the OSPF router.

Examples
No interface name is specified:
-> show ip ospf interface
Interface DR Backup DR Admin Oper
Name Address Address Status Status State
---------------------+----------------+----------------+--------+------+-------
vlan-213 213.10.10.1 213.10.10.254 enabled up DR
vlan-215 215.10.10.254 215.10.10.1 enabled up BDR

output definitions
Interface Name The name of the interface.
DR Address The designated router IP address on this network segment. Make sure
you configure a VLAN for the router IP. (See Chapter 5, “VLAN Man-
agement Commands,” for more information.)
Backup DR Address The IP address of the backup designated router.
Vlan The VLAN to which the interface is assigned.
Admin Status The current administration status of the interface, either enabled or
disabled.
Oper Status Whether the interface is an active OSPF interface.
State The current state of the OSPF interface. It will be down, up, dp, dr, or
other.

page 23-78 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands show ip ospf interface

The following is an example of MD5 authentication (an interface name is used in this example).
-> show ip ospf interface vlan-3
Interface IP Name = vlan-3
VLAN Id = 3,
Interface IP Address = 100.10.10.2,
Interface IP Mask = 255.255.255.0,
Admin Status = Enabled,
Operational Status = Up,
OSPF Interface State = BDR,
Interface Type = Broadcast,
Area Id = 0.0.0.2,
Designated Router IP Address = 100.10.10.88,
Designated Router RouterId = 100.10.10.88,
Backup Designated Router IP Address = 100.10.10.2,
Backup Designated Router RouterId = 192.169.1.2,
MTU (bytes) = 1500,
Metric Cost = 1,
Priority = 1,
Hello Interval (seconds) = 10,
Transit Delay (seconds) = 1,
Retrans Interval (seconds) = 5,
Dead Interval (seconds) = 40,
Poll Interval (seconds) = 120,
Link Type = Broadcast,
Authentication Type = md5,
# Id Key Status StartAccept StopAccept StartGen StopGen
--+----+-----+----------+-----------+-----------+---------+--------
1 1 Set Enabled 0 0 0 0
# of Events = 2,
# of Init State Neighbors = 0,
# of 2-Way State Neighbors = 0,
# of Exchange State Neighbors = 0,
# of Full State Neighbors = 1
BFD status = Disabled,
DR-Only Option for BFD = Disabled

Note. See the table on the following page for output definitions.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-79
show ip ospf interface OSPF Commands

The following is an example of simple authentication (an interface name is used in this example):
-> show ip ospf interface vlan-3
Interface IP Name = vlan-3
VLAN Id = 3,
Interface IP Address = 100.10.10.2,
Interface IP Mask = 255.255.255.0,
Admin Status = Enabled,
Operational Status = Up,
OSPF Interface State = DR,
Interface Type = Broadcast,
Area Id = 0.0.0.2,
Designated Router IP Address = 100.10.10.2,
Designated Router RouterId = 192.169.1.2,
Backup Designated Router IP Address = 0.0.0.0,
Backup Designated Router RouterId = 0.0.0.0,
MTU (bytes) = 1500,
Metric Cost = 1,
Priority = 1,
Hello Interval (seconds) = 10,
Transit Delay (seconds) = 1,
Retrans Interval (seconds) = 5,
Dead Interval (seconds) = 40,
Poll Interval (seconds) = 120,
Link Type = Broadcast,
Authentication Type = simple,
Authentication Key = Set,
# of Events = 3,
# of Init State Neighbors = 0,
# of Exchange State Neighbors = 0,
# of 2-Way State Neighbors = 0,
# of Full State Neighbors = 0
BFD Status = Disabled,
DR-Only Option for BFD = Disabled

Output fields when an interface name is specified are described below:

output definitions
Interface IP Name The name of the VLAN to which the interface is assigned.
VLAN Id The VLAN to which the interface is assigned.
Interface IP Address The IP address assigned to the interface.
Interface IP Mask The IP mask associated with the IP address assigned to the interface.
Admin Status The current administration status of the interface, either enabled or
disabled.
Operational Status Whether the interface is an active OSPF interface.
OSPF Interface State The current state of the OSPF interface. It will be down, up, dp, dr, or
other.
Interface Type The OSPF interface type, which can be Broadcast, NBMA, Point-to-
Point, or Point-to-Multipoint.
Area Id The area identification number to which the interface is assigned. This
field is not applicable if an interface has not yet been assigned to an
area.
Designated Router IP Address The designated router IP address.

page 23-80 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands show ip ospf interface

output definitions (continued)

Designated Router RouterId The identification number of the designated router.
Backup Designated Router IP The IP address of the backup designated router.
Address
Backup Designated Router The identification number of the backup designated router.
RouterId
MTU The Maximum Transfer Unit (in bytes) for the interface.
Metric Cost The cost added to routes learned on this interface.
Priority The priority of the interface with regards to becoming the designated
router. The higher the number, the higher the priority.
Hello Interval The number of seconds between hello messages sent out on the
interface.
Transit Delay The estimated number of seconds required to transmit a link state
update over this interface.
Retrans Interval The number of seconds the interface waits before resending hello
messages.
Dead Interval The number of seconds the interface waits for hello messages received
from a neighbor before declaring the neighbor as dead.
Poll Interval The larger time interval, in seconds, between hello messages sent to
inactive neighbors.
Link Type The IP interface type, either broadcast or non broadcast.
Authentication Type The type of authentication used by this interface, either none, simple,
or md5.
# The indexing of the MD5 key. (This field is only displayed for MD5
authentication.)
Id A key identifier that identifies the algorithm and MD5 secret key
associated with this interface. (This field is only displayed for MD5
authentication.)
Key Indicates whether the MD5 key has been set or not. (This field is only
displayed for MD5 authentication.)
Status The status of the configured MD5 authentication key. (This field is only
displayed for MD5 authentication.)
StartAccept The time that the OSPF router will start accepting packets that have
been created with this key. (This field is only displayed for MD5
authentication.)
StopAccept The time that the OSPF router will stop accepting packets that have
been created with this key. (This field is only displayed for MD5
authentication.)
StartGen The time that the OSPF router will start using this key for packet
generation. (This field is only displayed for MD5 authentication.)
StopGen The time that the OSPF router will stop using this key for packet
generation. (This field is only displayed for MD5 authentication.)
Authentication Key This field displays whether the authentication key has been configured
or not. (This field is only displayed for simple and no authentication.)
# of Events The number of interface state machine events.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-81
show ip ospf interface OSPF Commands

output definitions (continued)

# of Init State Neighbors The number of OSPF neighbors in the initialization state.
# of 2-Way State Neighbors The number of OSPF 2-way state neighbors on this interface.
# of Exchange State Neighbors The number of OSPF neighbors in the exchange state.
# of Full State Neighbors The number of OSPF neighbors in the full state. The full state is a
neighbor that is recognized and passing data between itself and the
interface.
BFD Status The status of BFD on this interface.
DR-Only Option for BFD The BFD setting for this interface. If DR-Only only is disabled then the
setting is All Neighbors.

Release History
Release 8.1.1; command was introduced.

Related Commands

ip ospf interface Creates and deletes an OSPF interface.

ip ospf interface auth-key Configures an OSPF authentication key for simple authentication
on an interface.
ip ospf interface dead-interval Configures the OSPF interface dead interval.
ip ospf interface hello-interval Configures the OSPF interface hello interval.
ip ospf interface md5 Creates and deletes the OSPF interface MD5 key identification
number.
ip ospf interface md5 key Configures the OSPF key string.
ip ospf interface cost Configures the OSPF interface cost.
ip ospf interface poll-interval Configures the OSPF poll interval for a Non Broadcast Multi
Access (NBMA) interface.
ip ospf interface priority Configures the OSPF interface priority.
ip ospf interface retrans- Configures the OSPF interface retransmit interval.
interval
ip ospf interface transit-delay Configures the OSPF interface transit delay.
ip ospf interface auth-type Sets the OSPF interface authentication type.
ip ospf interface area Configures an OSPF interface area.
ip ospf interface type Configures the OSPF interface type.
ip ospf interface admin-state Enables or disables the administration status on an OSPF interface.

page 23-82 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands show ip ospf interface

MIB Objects
ospfIfTable
ospfIfIpAddress
ospfIfAreaId
ospfIfType
ospfIfAdminStat
ospfIfRtrPriority
ospfIfTransitDelay
ospfIfRetransInterval
ospfIfHelloInterval
ospfIfRtrDeadInterval
ospfIfPollInterval
ospfIfState
ospfIfDesignatedRouter
ospfIfBackupDesignatedRouter
ospfIfEvents
ospfIfAuthType
ospfIfStatus
ospfIfAuthKey
alaOspfIfMd5Table
alaOspfIfMd5IpAddress
alaOspfIfMd5KeyId
alaOspfIfMd5Key
alaOspfIfMd5EncryptKey
alaOspfIfMd5KeyStartAccept
alaOspfIfMd5KeyStopAccept
alaOspfIfMd5KeyStartGenerate
alaOspfIfMd5KeyStopGenerate
alaOspfIfAugTable
alaOspfIfIntfName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-83
show ip ospf restart OSPF Commands

show ip ospf restart

Displays the OSPF graceful restart related configuration and status.
show ip ospf restart

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The minimum hardware configuration for this command is a redundant CMM configuration. This
command is not supported on OmniSwitch 10K switches with a single CMM.

Examples
-> show ip ospf restart
Restart Support = Enabled,
Restart Interval (in seconds) = 120,
Restart Status = Not Restarting,
Restart Age (in seconds) = 0,
Last Restart Exit Reason = None,
Restart Helper Support = Enabled,
Restart Helper Strict Checking = Enabled,
Restart Helper Mode = NotHelping

output definitions
Restart Support The administrative status of OSPF graceful restart, which can be
Enabled or Disabled.
Restart Interval The configured OSPF hitless restart timeout interval, in seconds. Use
the ip ospf restart-interval command to modify this parameter.
Restart Status The current status of OSPF graceful restart, which can be Not
Restarting, Unplanned Restart (after a CMM takeover), or Planned
Restart (before CMM takeover).
Restart Age The remaining time, in seconds, for the current OSPF graceful restart
interval.
Last Restart Exit Reason The outcome of the last attempt at a graceful restart. If the value is
None, then no restart has yet been attempted. If the value is In
Progress, then a restart attempt is currently underway. Other possible
values include Completed (successfully completed), Timed Out
(timed out), and Topology Changed (aborted due to topology change).

page 23-84 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPF Commands show ip ospf restart

output definitions (continued)

Restart Helper Support The administrative status of the capability of an OSPF router to operate
in helper mode in response to a router performing a graceful restart,
which can be Enabled or Disabled. Use the ip ospf restart-helper
admin-state command to modify this parameter.
Restart Helper Strict The administrative status of whether or not a changed Link State
Checking Advertisement (LSA) will result in termination of graceful restart by a
helping router, which can be Enabled or Disabled. Use the ip ospf
restart-helper strict-lsa-checking admin-state command to modify
this parameter.
Restart Helper Mode Whether this OSPF router is operating as a helper to a restarting router.

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip ospf Displays the OSPF status and configuration.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 23-85
show ip ospf restart OSPF Commands

page 23-86 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 24 OSPFv3 Commands

Open Shortest Path First version 3 (OSPFv3) routing is a shortest path first (SPF) or link-state protocol.
This protocol is compatible with 128-bit IPv6 address space, while OSPF is compatible with 32-bit IPv4
address space. OSPFv3 is an interior gateway protocol (IGP) that distributes routing information between
routers in a single autonomous system (AS). OSPFv3 chooses the least-cost path as the best path.
Each participating router distributes its local state (i.e., the router’s usable interfaces and reachable neigh-
bors) throughout the AS by flooding. In a link-state protocol, each router maintains a database describing
the entire AS topology. This database is built from the collected link state advertisements of all routers.
Each multi-access network that has at least two attached routers has a designated router and a backup
designated router. The designated router floods a link state advertisement for the multi-access network and
has other special responsibilities.
OSPFv3 allows collections of contiguous networks and hosts to be grouped together. A group, together
with the routers having interfaces to any one of the included networks, is called an area. Each area runs a
separate copy of the basic link-state routing algorithm. This means that each area has its own topological
database, as explained in the previous section.
Alcatel-Lucent’s version of OSPFv3 complies with RFCs 2740, 1826, 1827, 2553, 2373, 2374, and 2460.
MIB information for OSPFv3 is as follows:
Filename: AlcatelIND1DrcTm.mib
Module: ALCATEL-IND1-DRCTM-MIB
Filename: AlcatelIND1Ospf3.mib
Module: ALCATEL-IND1-OSPF3-MIB
Filename: IETF-OSPF-OSPFv3.MIB
Module: OSPF-OSPFv3-MIB

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-1
 OSPFv3 Commands

The following is a list of the commands for configuring OSPFv3:

Global OSPFv3 Commands ipv6 ospf admin-state

ipv6 load ospf
ipv6 ospf host
ipv6 ospf mtu-checking
ipv6 ospf route-tag
ipv6 ospf spf-timer
ipv6 ospf virtual-link
show ipv6 ospf
show ipv6 ospf border-routers
show ipv6 ospf host
show ipv6 ospf lsdb
show ipv6 ospf neighbor
show ipv6 ospf routes
show ipv6 ospf virtual-link
OSPFv3 Area Commands ipv6 ospf area
show ipv6 ospf area
OSPFv3 Interface Commands ipv6 ospf interface
ipv6 ospf interface suppress-link-lsa
ipv6 ospf interface type
ipv6 ospf neighbor
ipv6 ospf interface area
ipv6 ospf interface dead-interval
ipv6 ospf interface hello-interval
ipv6 ospf interface cost
ipv6 ospf interface priority
ipv6 ospf interface retrans-interval
ipv6 ospf interface transit-delay
show ipv6 ospf interface

page 24-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands ipv6 ospf admin-state

ipv6 ospf admin-state

Enables or disables the OSPFv3 administrative status for the router.
ipv6 ospf admin-state {enable | disable}

Syntax Definitions

enable Enables OSPFv3.

disable Disables OSPFv3.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The OSPFv3 protocol should be enabled to route traffic.

Examples
-> ipv6 ospf admin-state enable
-> ipv6 ospf admin-state disable

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 ospf Displays OSPFv3 status and general configuration parameters.

MIB Objects
ospfv3GeneralGroup
ospfv3AdminStat

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-3
ipv6 load ospf OSPFv3 Commands

ipv6 load ospf

Loads the OSPFv3 software on the router.
ipv6 load ospf

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Example
-> ipv6 load ospf

Release History
Release 8.1.1; command introduced.

Related Commands
N/A

MIB Objects
ALADRCTMCONFIG
alaDrcTmIPOspf3Status

page 24-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands ipv6 ospf host

ipv6 ospf host

Creates or deletes an OSPFv3 entry for directly attached hosts.
ipv6 ospf host ipv6_address [area area_id] [metric metric]
no ipv6 ospf host ipv6_address area area_id

Syntax Definitions

ipv6_address The 128-bit IP address of the OSPF host.

area_id Area to which the host route belongs.
metric The cost metric value assigned to the specified host. The valid range is
0–65535.

Defaults

parameter default
metric 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove the record of the OSPFv3 host.

• Use this command when multiple paths exist to a host. The specified host must be directly attached to
the router. A metric value is the cost of all the hops necessary for a packet to reach its destination.
Routers use the metric to determine the best possible path.
• This command allows you to modify the host parameter metric.

Examples
-> ipv6 ospf host 2001::1/64 metric 10
-> no ipv6 ospf host 2001::1/64 metric 10

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 ospf host Displays information on the configured OSPFv3 hosts.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-5
ipv6 ospf host OSPFv3 Commands

MIB Objects
ospfv3HostTable
ospfv3HostStatus
ospfv3HostAreaID
ospfv3HostAddress
ospfv3HostMetric

page 24-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands ipv6 ospf mtu-checking

ipv6 ospf mtu-checking

Enables or disables Maximum Transfer Unit (MTU) checking. The MTU limits the size of a transmitted or
received packet.
ipv6 ospf mtu-checking
no ipv6 ospf mtu-checking

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to disable MTU checking.

• This command is used to disable the checking for mismatch of the interface MTU while establishing a
neighbor adjacency with a router. MTU mismatch occurs when a router receives packets that contain a
larger MTU value than that of the interface on which adjacency is being established. The interface
MTU is the largest IP datagram size (in bytes) that the interface can accept.

Examples
-> ipv6 ospf mtu-checking
-> no ipv6 ospf mtu-checking

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 ospf Displays the OSPFv3 status and general configuration parameters.

MIB Objects
alaProtocolOspf3
alaOspf3MTUCheck

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-7
ipv6 ospf route-tag OSPFv3 Commands

ipv6 ospf route-tag

Configures a tag value for the Autonomous System External (ASE) routes created.
ipv6 ospf route-tag tag

Syntax Definitions

tag The set tag value. The valid range is 0–2, 147, 483, 647.

Defaults

parameter default
tag 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command allows you to set a tag value for ASE routes that are learned by this OSPF router. The
tag value allows for quick identification.
• OSPF ASE route advertisements contain a tag value field. This field allows the exchange of informa-
tion between autonomous system border routers (ASBRs).

Examples
-> ipv6 ospf route-tag 2

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 ospf Displays OSPFv3 status and general configuration parameters.

MIB Objects
alaProtocolOspf3
alaOspf3RedistRouteTag

page 24-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands ipv6 ospf spf-timer

ipv6 ospf spf-timer

Configures timers for Shortest Path First (SPF) calculation.
ipv6 ospf spf-timer [delay delay_seconds] [hold hold_seconds]

Syntax Definitions

delay_seconds Specifies time (from 0 to 65535 seconds) between the reception of an

OSPF topology change and the start of an SPF calculation.
hold_seconds Specifies the minimum time (from 0 to 65535 seconds) between consec-
utive SPF calculations.

Defaults

parameter default
delay_seconds 5
hold_seconds 10

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command allows you to configure the time interval between SPF calculations.

• Use the delay timer to determine how much time to postpone an SPF calculation after the router
receives a topology change.
• Use the hold timer to configure the amount of time that must elapse between consecutive SPF calcula-
tions.
• There will be no delay in the SPF calculation if either the delay timer or hold timer is set to 0. The SPF
calculations will occur immediately upon the reception of a topology change and/or that back-to back
SPF calculations can take place with no break in-between the two.

Examples
-> ipv6 ospf spf-timer delay 20 hold 35

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-9
ipv6 ospf spf-timer OSPFv3 Commands

Related Commands

show ipv6 ospf Displays the OSPFv3 status and general configuration parameters.

MIB Objects
alaProtocolOspf3
alaOspf3TimerSpfDelay
alaOspf3TimerSpfHold

page 24-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands ipv6 ospf virtual-link

ipv6 ospf virtual-link

Creates or deletes a virtual link. A virtual link restores the backbone connectivity if the backbone is not
physically contiguous.
ipv6 ospf virtual-link area area_id router router_id [dead-interval seconds] [hello-interval seconds]
[retrans-interval seconds] [transit-delay seconds]
no ipv6 ospf virtual-link area area_id router router_id

Syntax Definitions

area_id A unique 32-bit value in IP address format.

router_id A unique 32-bit value, such as an IP address, that identifies a
neighboring router in the Autonomous System.
dead-interval seconds Sets the virtual link dead interval. If no hello packets on this link for the
set number of seconds have been received, the virtual neighbor is
declared dead. The valid range is 1–2147483647.
hello-interval seconds Sets the virtual link hello interval, which is the time interval between
OSPF hellos sent on this virtual link. The valid range is 1–65535.
retrans-interval seconds Sets the virtual link retransmit interval. The router waits the set number
of seconds before retransmitting OSPF packets. The valid range is
0–3600.
transit-delay seconds Sets the virtual link transit delay, which is the number of seconds to
transmit OSPF packets over this link. The valid range is 0–3600.

Defaults

parameter default
dead-interval seconds 40
hello-interval seconds 10
retrans-interval seconds 5
transit-delay seconds 1

Platforms Supported
OmniSwitch 6860, 6860E

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-11
ipv6 ospf virtual-link OSPFv3 Commands

Usage Guidelines
• Use the no form of the command to delete the virtual link.

• You can define areas in such a way that the backbone is no longer contiguous. In this case, the system
administrator can ensure backbone connectivity physically.
• Virtual links can be configured between any two backbone routers that have an interface to a common
non-backbone area. Virtual links belong to the backbone. The protocol treats two routers joined by a
virtual link as if they were connected by an unnumbered point-to-point network. The routing protocol
traffic that flows along the virtual link uses intra-area routing only.
• If authentication is enabled, both routers at either end of the virtual link must share the same password.
Simple authentication refers to the use of only clear-text passwords as an authentication method. MD5
authentication refers to the usage of message digests.
• The dead-interval value should be the same for all the routers on the same network. This value should
be a multiple of the value provided for the hello-interval.

Examples
-> ipv6 ospf virtual-link area 0.0.0.1 router 172.22.2.115
-> ipv6 ospf virtual-link area 0.0.0.1 router 172.22.2.115 dead-interval 50
-> ipv6 ospf virtual-link area 0.0.0.1 router 172.22.2.115 hello-interval 20
-> ipv6 ospf virtual-link area 0.0.0.1 router 172.22.2.115 retrans-interval 20
-> ipv6 ospf virtual-link area 0.0.0.1 router 172.22.2.115 transit-delay 50
-> no ipv6 ospf virtual-link area 0.0.0.1 router 172.22.2.115

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 ospf virtual-link Displays the virtual link information.

MIB Objects
ospfv3VirtIfTable
ospfv3VirtIfAreaId
ospfv3VirtIfNeighbor
ospfv3VirtIfStatus
ospfv3VirtIfRtrDeadInterval
ospfv3VirtIfHelloInterval
ospfv3VirtIfRetransInterval
ospfv3VirtIfTransitDelay

page 24-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands ipv6 ospf area

ipv6 ospf area

Assigns an OSPFv3 interface to a specified area.
ipv6 ospf area area_id [type {normal | stub [default-metric metric]} | [summarize range [filter]
[cost cost]]
no ipv6 ospf area area_id

Syntax Definitions

area_id A unique 32-bit value in IPv4 address format.

normal Sets the area as a regular OSPFv3 area.
stub Configures an OSPFv3 area as a stub area.
metric Defines the metric to be used for default routes injected into the stub.
summarize Configures the inter-area route summarization for range.
range Aggregate range in IPv6 Address/PrefixLength format.
filter Filter routes described by summarization range.
cost Cost to use for summarized route (transferred in cost parameter).

Defaults

parameter default
normal | stub normal

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to delete the OSPFv3 area. It can also be used to deactivate
summarization.
• The default-metric parameter defines the metric to be used for default routes injected into the stub
area.

Examples
-> ipv6 ospf area 0.0.0.1
-> ipv6 ospf area 0.0.0.1 stub
-> ipv6 ospf area 0.0.0.1 type normal
-> no ipv6 ospf area 0.0.0.1

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-13
ipv6 ospf area OSPFv3 Commands

Related Commands

show ipv6 ospf area Displays either all the OSPFv6 areas, or a specified OSPFv6 area.

MIB Objects
ospfv3AreaTable
ospfv3ImportAsExtern
ospf3AreaStatus
ospfv3AreaSummary
ospfv3StubMetricospfv3AreaId
ospfv3AreaTable
ospfv3AreaAggregateAreaId
ospfv3Prefix
ospfv3PrefixRange
ospfv3AreaAggregateEffect
ospfv3AreaAggreateAugTable
alaOspf3AreaAggregateCost

page 24-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands ipv6 ospf interface

ipv6 ospf interface

Creates or deletes an OSPFv3 interface.
ipv6 ospf interface interface_name
no ipv6 ospf interface interface_name

Syntax Definitions

interface_name The name of the interface.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to delete an OSPFv3 interface.

• The interface name cannot contain spaces.

Examples
-> ipv6 ospf interface vlan-101
-> no ipv6 ospf interface vlan-101

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 ospf interface Displays the status and statistics of an OSPFv3 interface.

MIB Objects
ospfv3IfTable
ospfv3IfIndex

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-15
ipv6 ospf interface suppress-link-lsa OSPFv3 Commands

ipv6 ospf interface suppress-link-lsa

Allows to suppress the announcements of the Link State Advertisements (LSAs).
ipv6 ospf interface interface_name suppress-link-lsa
no ipv6 ospf interface interface_name suppress-link-lsa

Syntax Definitions

interface_name The name of the interface.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of the command to disable LSA suppression.

Examples
-> ipv6 ospf interface vlan-101 suppress-link-lsa
-> no ipv6 ospf interface vlan-101 suppress-link-lsa

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 ospf interface Displays the status and statistics of an OSPFv3 interface.

MIB Objects
ospfv3IfTable
ospfv3IfIndex
alaOspf3SuppressLinkLsa

page 24-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands ipv6 ospf interface type

ipv6 ospf interface type

Allows to configure the type of OSPFv3 interface.
ipv6 ospf interface interface_name type {broadcast | point-to-point | point-to-multipoint | nbma}

Syntax Definitions

interface_name The name of the interface.

broadcast The interface is a broadcast interface.
point-to-point The interface is a point-to-point interface.
point-to-multipoint The interface is a point-to-multipoint interface.
nbma The interface is a nbma interface.

Defaults

parameter default
broadcast | point-to-point | broadcast
point-to-multipoint | nbma

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The OSPFv3 interface must be enabled to participate in the OSPFv3 protocol.

Examples
-> ipv6 ospf interface vlan-101 type nbma
-> ipv6 ospf interface vlan-101 type point-to-point
-> ipv6 ospf interface vlan-101 type point-to-multipoint
-> ipv6 ospf interface vlan-101 type broadcast

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 ospf interface Displays the status and statistics of an OSPFv3 interface.

MIB Objects
ospfv3IfTable
ospfv3IfStatus
ospfv3IfType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-17
ipv6 ospf neighbor OSPFv3 Commands

ipv6 ospf neighbor

Allows to configure OSPFv3 neighbor on non-broadcast interface type. The neighbor configuration is
required on NBMA and point-to-multipoint interface to run OSPFv3.
ipv6 ospf neighbor nbr_ipv6_address interface interface_name {eligible | ineligible}
no ipv6 ospf neighbor nbr_ipv6_address

Syntax Definitions

nbr_ipv6_address Local ipv6 address of the neighbor to be linked.

interface_name The name of the interface on which the neighbor is reachable.
eligible Indicates the neighbor is eligible to become the designated router.
ineligible Indicates the neighbor is ineligible to become the designated router.

Defaults

parameter default
eligible | ineligible eligible

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to delete the neighbor configuration.

• The OSPFv3 interface must be configured before configuring the OSPFv3 neighbor.

• This command is not applicable for broadcast interface type and is optional for point-to-point interface
type.

Examples
-> ipv6 ospf neighbor fe80::2e0:b1ff:fe7e:5f1e interface vlan-101 eligible
-> ipv6 ospf neighbor fe80::2e0:b1ff:fe7e:5f1e interface vlan-101 ineligible
-> no ipv6 ospf neighbor fe80::2e0:b1ff:fe7e:5f1e interface vlan-101

Release History
Release 8.1.1; command introduced.

page 24-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands ipv6 ospf neighbor

Related Commands

show ipv6 ospf interface Displays the status and statistics of an OSPFv3 interface.
ipv6 ospf interface suppress- Allows to configure the type of OSPFv3 interface.
link-lsa

MIB Objects
ospfv3NbrTable
ospfv3NbrPriority
ospfv3NbmaNbrStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-19
ipv6 ospf interface admin-state OSPFv3 Commands

ipv6 ospf interface admin-state

Enables or disables the administration status on an OSPFv3 interface.
ipv6 ospf interface interface_name admin-state {enable | disable}
no ipv6 ospf interface interface_name

Syntax Definitions

interface_name The name of the interface.

enable Enables the OSPFv3 interface.
disable Disables the OSPFv3 interface.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to delete an OSPFv3 interface.

• The OSPFv3 interface must be enabled to participate in the OSPFv3 protocol.

Examples
-> ipv6 ospf interface vlan-101 admin-state enable
-> ipv6 ospf interface vlan-101 admin-state disable
-> no ipv6 ospf interface vlan-101
-> no ipv6 ospf interface vlan-101

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 ospf interface Displays the status and statistics of an OSPFv3 interface.

MIB Objects
ospfv3IfTable
ospfv3IfIndex
ospfv3IfAdminStat

page 24-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands ipv6 ospf interface area

ipv6 ospf interface area

Configures an OSPFv3 area identifier for this interface.
ipv6 ospf interface interface_name area area_id

Syntax Definitions

interface_name The name of the interface.

area_id A unique 32-bit value in IP address format.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
An interface must be assigned to an area to become operational.

Examples
-> ipv6 ospf interface vlan-101 area 0.0.0.1

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 ospf area Displays either all the OSPFv3 areas, or a specified OSPFv3 area.
show ipv6 ospf interface Displays the status and statistics of an OSPFv3 interface.

MIB Objects
ospfv3IfTable
ospfv3IfIndex
ospfv3IfAreaId

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-21
ipv6 ospf interface dead-interval OSPFv3 Commands

ipv6 ospf interface dead-interval

Configures the OSPFv3 interface dead interval.
ipv6 ospf interface interface_name dead-interval seconds

Syntax Definitions

interface_name The name of the interface.

seconds The dead interval, in seconds. The valid range is 1–65535.

Defaults

parameter default
seconds 40
(broadcast and point-to-point)
seconds 120
(NBMA and point-to-multi-
point)

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• After the dead interval, a neighbor on this interface is considered dead if no hello packets have been
received from this neighbor.
• This interval should be greater than the hello interval or multiples of the hello interval.

Examples
-> ipv6 ospf interface vlan-101 dead-interval 50

Release History
Release 8.1.1; command introduced.

page 24-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands ipv6 ospf interface dead-interval

Related Commands

ipv6 ospf interface hello- Configures the OSPFv3 interface hello interval.
interval
show ipv6 ospf interface Displays the status and statistics of an OSPFv3 interface.

MIB Objects
ospfv3IfTable
ospfv3IfIndex
ospfv3IfRtrDeadInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-23
ipv6 ospf interface hello-interval OSPFv3 Commands

ipv6 ospf interface hello-interval

Configures the OSPFv3 interface hello interval.
ipv6 ospf interface interface_name hello-interval seconds

Syntax Definitions

interface_name The name of the interface.

seconds The hello interval, in seconds. The valid range is 0–65535. A value of 0
creates a passive OSPF interface.

Defaults

parameter default
seconds 10
(broadcast and point-to-point)
seconds 30
(NBMA and point-to-multi-
point)

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This is the interval between two consecutive hello packets sent out on this interface.

Examples
-> ipv6 ospf interface vlan-101 hello-interval 50

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 ospf interface dead- Configures the OSPFv3 interface dead interval.
interval
show ipv6 ospf interface Displays the status and statistics of an OSPFv3 interface.

MIB Objects
ospfv3IfTable
ospfv3IfIndex
ospfv3IfHelloInterval

page 24-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands ipv6 ospf interface cost

ipv6 ospf interface cost

Configures the OSPFv3 interface cost.
ipv6 ospf interface interface_name cost cost

Syntax Definitions

interface_name The name of the interface.

cost The interface cost. The valid range is 0–65535.

Defaults

parameter default
cost 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The configured interface cost (if any) is used during OSPFv3 route calculations.

Examples
-> ipv6 ospf interface vlan-101 cost 10

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 ospf interface Displays the status and statistics of an OSPFv3 interface.

MIB Objects
ospfv3IfTable
ospfv3IfIndex
ospfv3IfMetricValue

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-25
ipv6 ospf interface priority OSPFv3 Commands

ipv6 ospf interface priority

Configures the OSPFv3 interface priority. The priority number helps determine the eligibility of this router
to become the designated router on the network.
ip ospf interface interface_name priority priority

Syntax Definitions

interface_name The name of the interface.

priority The interface cost. The valid range is 0–65535.

Defaults

parameter default
priority 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
When two routers attached to a network both attempt to become the designated router, the one with the
highest priority becomes the designated router. A router whose router priority is set to 0 is ineligible to
become the designated router.

Examples
-> ipv6 ospf interface vlan-101 priority 100

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 ospf interface Displays the status and statistics of an OSPFv3 interface.

MIB Objects
ospfv3IfTable
ospfv3IfIndex
ospfv3IfRtrPriority

page 24-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands ipv6 ospf interface retrans-interval

ipv6 ospf interface retrans-interval

Configures the OSPFv3 interface retransmit time interval.
ipv6 ospf interface interface_name retrans-interval interval

Syntax Definitions

interface_name The name of the interface.

interval The retransmit interval, in seconds. The valid range 0–3600.

Defaults

parameter default
interval 5

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The number of seconds between link retransmission of OSPFv3 packets on this interface.

Examples
-> ipv6 ospf interface vlan-101 retrans-interval 500

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 ospf interface Displays the status and statistics of an OSPFv3 interface.

MIB Objects
ospfv3IfTable
ospfv3IfIndex
ospfv3IfRetransInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-27
ipv6 ospf interface transit-delay OSPFv3 Commands

ipv6 ospf interface transit-delay

Configures the OSPFv3 interface transit time delay.
ipv6 ospf interface interface_name transit-delay delay

Syntax Definitions

interface_name The name of the interface.

delay The transit delay, in seconds. The valid range is 0–3600.

Defaults

parameter default
seconds 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The estimated number of seconds required to transmit a link state update over this interface. This
command takes into account transmission and propagation delays and must be greater than 0.

Examples
-> ipv6 ospf interface vlan-101 transit-delay 100

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 ospf interface Displays the status and statistics of an OSPFv3 interface.

MIB Objects
ospfv3IfTable
ospfv3IfIndex
ospfv3IfTransitDelay

page 24-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands show ipv6 ospf

show ipv6 ospf

Displays the OSPFv3 status and general configuration parameters.
show ipv6 ospf

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used to display the general configuration parameters of the OSPFv3 router.

• See the Related Commands section below to modify the displayed parameters.

Examples
-> show ipv6 ospf

Status = Enabled,
Router ID = 5.5.5.5,
# Areas = 2,
# Interfaces = 4,
Area Border Router = Yes,
AS Border Router = No,
External Route Tag = 0,
SPF Hold (seconds) = 10,
SPF Delay (seconds) = 5,
MTU checking = Enabled,
# SPF calculations performed = 3,
Last SPF run (seconds ago) = N/A,
# of neighbors that are in:
Full state = 3,
Loading state = 0,
Exchange state = 0,
Exstart state = 0,
2way state = 0,
Init state = 0,
Attempt state = 0,
Down state = 0,

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-29
show ipv6 ospf OSPFv3 Commands

page 24-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands show ipv6 ospf

output definitions
Status Displays whether OSPFv3 is currently enabled or disabled on the
router.
Router Id The unique identification for the router.
# Areas Number of areas to which the router belongs.
# Interface Number of interfaces participating in OSPF
Area Border Router Displays whether the router status is an area router or not.
AS Border Router Displays whether the area Autonomous System Border Router status of
this router is enabled or disabled.
External Route Tag Displays the route tag for this router.
SPF Hold (seconds) Displays the time in seconds between the reception of an OSPFv3
topology change and the start of a SPF calculation.
SPF Delay (seconds) Displays the time in seconds between consecutive SPF calculations.
MTU Checking Displays whether Maximum Transfer Unit checking is enabled or dis-
abled. This is set using the ipv6 ospf mtu-checking command.
# SPF calculations performed Displays the number of SPF calculation performed.
Last SPF run (seconds ago) N/A
Full state Displays the number of neighbor routers that are in Full state.
Loading state Displays the number of neighbor routers that are in Loading state.
Exchange state Displays the number of neighbor routers that are in Exchange state.
Exstart state Displays the number of neighbor routers that are in Exstart state.
2way state Displays the number of neighbor routers that are in 2way state.
Init state Displays the number of neighbor routers that are in Init state.
Attempt state Displays the number of neighbor routers that are in Attempt state.
Down state Displays the number of neighbor routers that are in Down state.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-31
show ipv6 ospf OSPFv3 Commands

Related Commands

ipv6 ospf admin-state Enables or disables the administration of OSPFv3 on the router.
ipv6 ospf mtu-checking Enables or disables the use of Maximum Transfer Unit (MTU)
checking.
ipv6 ospf spf-timer Configures timers for SPF calculation.
ipv6 ospf route-tag Configures a tag value for Autonomous System External (ASE)
routes created.
ip router router-id Configures the router ID for the router.

MIB Objects
ospfv3GeneralGroup
ospfv3RouterId
ospfv3AdminStat
ospfv3VersionNumber
ospfv3AreaBdrRtrStatus
ospfv3ASBdrRtrStatus
ospfv3OriginateNewLsas
ospfv3RxNewLsas
ospfv3ExitOverflowInterval
alaProtocolOspf3
alaOspf3RedistAdminStatus
alaOspf3RedistRouteTag
alaOspf3TimerSpfDelay
alaOspf3TimerSpfHold
alaOspf3MTUCheck

page 24-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands show ipv6 ospf border-routers

show ipv6 ospf border-routers

Displays information regarding all or specified border routers.
show ipv6 ospf border-routers [area area_id] [router router_id]

Syntax Definitions

area_id A unique 32-bit value in IP address format.

router_id A unique 32-bit value, such as an IP address, that identifies a neighbor-
ing router in the Autonomous System.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used to display a list of border routers known by this OSPFv3 router.

• By using the optional parameters, you can display the border routers using the specified parameter. For
example, to find a router using a router ID of 1.1.1.1, enter the command using the router ID of 1.1.1.1
as a search criteria.
• See the Related Commands sections below to modify the list.

Examples
-> show ipv6 ospf border-routers

Router ID Area Metric Type

----------------+---------------+--------+---------
6.6.6.6 0.0.0.0 2 INTRA
6.6.6.6 0.0.0.1 2 INTRA
fe80::2d0:95ff:fee2:6bda -> pseudo1
fe80::2d0:95ff:fee2:6bda -> pseudo2

output definitions
Router ID The unique identification for the router.
Area A unique 32-bit value, such as an IP address, that identifies a
neighboring router in the Autonomous System.
Metric The metric used by the routes.
Type The type of routes specified (intra or inter).

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-33
show ipv6 ospf border-routers OSPFv3 Commands

Release History
Release 8.1.1; command introduced.

Related Commands
N/A

MIB Objects
N/A

page 24-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands show ipv6 ospf host

show ipv6 ospf host

Displays information on the configured OSPFv3 hosts.
show ipv6 ospf host [ipv6_address]

Syntax Definitions

ipv6_address A 128-bit IP address for a directly attached host.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used to display general information for OSPFv3 hosts directly attached to this router.

• See the Related Commands section below to modify the list.

Examples
-> show ipv6 ospf host

Area Metric Address

---------------+-------+-----------
0.0.0.1 1 2001::1/64

output definitions
Area A 32-bit IP address for a directly attached host. This can be set using
the ipv6 ospf host command.
Metric The metric assigned to the host. Metric is set using the ipv6 ospf host
command.
Address IPV6 address of the host.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-35
show ipv6 ospf host OSPFv3 Commands

Related Commands

ipv6 ospf host Creates or deletes an OSPFv3 entry for directly attached hosts.

MIB Objects
ospfv3HostTable
ospfv3HostIpAddress
ospfv3HostMetric
ospfHostStatus
ospfv3HostAreaID

page 24-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands show ipv6 ospf lsdb

show ipv6 ospf lsdb

Displays Link State Advertisements (LSAs) in the Link State Database (LSDB) associated with each area.
show ipv6 ospf lsdb [area area_id] [rtr | net | netsum | asbrsum] [linkstate-id ls_id] [router-id
router_id]

Syntax Definitions

area_id A unique 32-bit value in IP address format.

rtr Specifies router LSAs.
net Specifies network LSAs.
netsum Specifies network summary LSAs.
asbrsum Specifies Autonomous System Border Router summary LSAs.
ls_id The Link state ID. The ID is a unique 32-bit value, such as an IP
address. This number is used as a record in the link state database.
router_id The Router ID. The ID is a unique 32-bit value such as an IP address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used to display the LSDB of the OSPF router. It can be used for OSPF debugging,
specifically to narrow down sections of an area to determine which sections are receiving the specified
LSAs. You can specify the parameters of only the area LSDB using the optional command parameters.
• You can view LSAs by specifying either a link state identifier or a router identifier. However, when
specifying a router ID, you also need to supply a valid link state ID.

Examples
-> show ipv6 ospf lsdb

Area Type Link ID Advertising Rtr Sequence # Age

----------------+----------+------------+-----------------+----------+----------
0.0.0.0 Router 0 1.1.1.1 8000020f 1117
0.0.0.0 Router 0 3.3.3.3 80000208 1121
0.0.0.0 Router 0 5.5.5.5 800001f1 1117
0.0.0.0 Router 0 30.30.30.30 800000da 1115

output definitions
Area The identification of the area to which the router belongs.
Type The protocol type from where the route was learned.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-37
show ipv6 ospf lsdb OSPFv3 Commands

output definitions (continued)

Link Id The Link state ID. The ID is a unique 32-bit value expressed as an IPv6
address. This number is used as a record in the link state database.
Advertising Rtr The ID of the router that advertises the routes.
Sequence # The advertisement sequence number (i.e., a value used to identify old
and duplicate link state advertisements).
Age The age of the LSA in seconds. That is, the duration for which this
entry has existed in the external database.

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 ospf admin-state Displays the OSPFv3 status and general configuration parameters.

MIB Objects
ospfv3AsLsdbTable
ospfv3AsLsdbAreaId
ospfv3AsLsdbType
ospfv3AsLsdbLsid
ospfv3AsLsdbRouterId
ospfv3AsLsdbAdvertisement
ospfv3AsLsdbSequence
ospfv3AsLsdbAge

page 24-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands show ipv6 ospf neighbor

show ipv6 ospf neighbor

Displays information on OSPFv3 non-virtual neighbors.
show ipv6 ospf neighbor [router ipv4_address][interface interface_name]

Syntax Definitions

ipv4_address A 32-bit router ID of the neighboring router.

interface_name The name of the interface.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used to display all non-virtual neighbors of the OSPF router.

• See the Related Commands section below to modify the list.

Examples
-> show ipv6 ospf neighbor
Router ID Area/Transit Area State Interface
----------------+--------------------+-----+----------------------------------
1.1.1.1 0.0.0.0 FULL vlan-2071
3.3.3.3 0.0.0.0 FULL vlan-2071
5.5.5.5 0.0.0.0 FULL vlan-2071
23.23.23.23 0.0.0.1 FULL vlan-2055
23.23.23.23 0.0.0.1 FULL vlan-2056
24.24.24.24 0.0.0.1 FULL vlan-2065
24.24.24.24 0.0.0.1 FULL vlan-2066

output definitions
Router ID The unique identification for the router.
Area/Transit Area The area identifier.
State The state of the OSPF neighbor adjacency.
Interface The name of the interface.

-> show ipv6 ospf neighbor router 24.24.24.24

Router ID Area/Transit Area State Interface
----------------+--------------------+-----+--------------
24.24.24.24 0.0.0.1 FULL vlan-2070
24.24.24.24 0.0.0.1 FULL vlan-2073

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-39
show ipv6 ospf neighbor OSPFv3 Commands

output definitions
Router ID The unique identification for the router.
Area/Transit Area The area identifier.
State The state of the OSPF neighbor adjacency.
Interface The name of the interface.

-> show ipv6 ospf neighbor router 10.135.37.23 interface ospf

Details for Neighbor 10.135.37.23

State = FULL,
Interface = ospf,
Neighbor i/f index = 35,
Priority = 1,
Address = fe80::2e0:b1ff:fe7e:5f1e,
Neighbor's type = Static,
Neighbor is reporting DR as = 10.135.38.37,
Neighbor is reporting BDR as = 10.135.37.23,
Neighbor is Master/Slave = Master,
Seconds since last Hello seen = 2,
# of LSAs on retransmit list = 0,
# of LSAs on request list = 0,
# of State Changes = 6,
Neighbor options:
V6 bit is set
E bit is set
MC bit is not set
N bit is not set
R bit is set
DC bit is not set

output definitions
State The state of the OSPF neighbor adjacency.
Interface The name of the interface.
Neighbor i/f index The unique value assigned to the neighbor.
Priority The priority of the interface with regards to becoming the designated
router. The higher the number, the higher the priority.
Address The IPV6 address of the host.
Neighbor’s type Specifies the type of neighbor.
Neighbor is reporting DR as The address of the neighbors designated router.
Neighbor is reporting BDR as The address of the neighbors Backup Designated Router.
Neighbor is Master/Slave The role the neighbor has with the local router during DD Exchange,
which can be Master or Slave.
Seconds since last Hello seen The amount of time (in seconds) since the last HELLO messages was
received from this neighbor.
# of LSAs on retransmit list The number of Link State updates to the neighbor that need to be
retransmitted by the OSPF router.
# of LSAs on request list The number of Link State requests to this neighbor that have not
received a response from this neighbor.

page 24-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands show ipv6 ospf neighbor

output definitions (continued)

# of State Changes The number of times this OSPF interface has changed its state.
Neighbor options If set:
EA - External attribute LSA support
DC - Demand circuit support
R - If clear, a node can participate in OSPF topology distribution
without being used to forward transit traffic
N - Type 7 LSA support
MC - Multicast support
E - External routes support
V6 - V6 support

Release History
Release 8.1.1; command introduced.

Related Commands
N/A

MIB Objects
ospfv3NbrTable
ospfNbrAddress
ospfv3NbrRtrId
ospfv3NbrOptions
ospfv3NbrPriority
ospfv3NbrState
ospfv3NbrEvents
ospfv3NbrHelloSuppressed

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-41
show ipv6 ospf routes OSPFv3 Commands

show ipv6 ospf routes

Displays the OSPFv3 routes known to the router.
show ipv6 ospf routes [prefix ipv6_address_prefix][gateway gateway]

Syntax Definitions

ipv6_address_prefix The 128-bit IPv6 address of the route destination in hexadecimal format.
gateway The next hop IPv6 address for this router.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If no variables are entered, all routes are displayed.

• If the variables are entered, then only routes matching the specified criteria are shown.

• All the variables described above must be entered for a route match. If all of the variables are not
entered, an error message is returned.

Examples
-> show ipv6 ospf routes
Metric
Prefix Path Type 1 : 2
------------------------------------------+----------+-------------------
::/ 0 INTER 2 : -
fe80::2d0:95ff:fee0:710c -> vlan-2071
2051::/64 INTRA 2 : -
fe80::2d0:95ff:feac:a59f -> vlan-2055
fe80::2d0:95ff:feac:a59f -> vlan-2056
fe80::2d0:95ff:fed7:747e -> vlan-2065
fe80::2d0:95ff:fed7:747e -> vlan-2066

output definitions
Prefix The destination address of the IPv6 route in the hexadecimal format.
Path Type The type of routes specified (intra or inter).
Metric The cost of the route.

Release History
Release 8.1.1; command introduced.

page 24-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands show ipv6 ospf routes

Related Commands

ipv6 ospf admin-state Displays the OSPFv3 status and general configuration parameters.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-43
show ipv6 ospf virtual-link OSPFv3 Commands

show ipv6 ospf virtual-link

Displays virtual link information. A virtual link is used to connect OSPFv3 backbone routers that are not
physically contiguous.
show ipv6 ospf virtual-link [router_id]

Syntax Definitions

router_id The router ID of the remote end of the virtual link.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 ospf virtual-link
Intf Nbr
Transit Area Peer Router ID State State Cost
----------------+----------------+------+-------+------+
0.0.0.1 6.6.6.6 P2P FULL 2

output definitions
Transit Area The area identification for the area assigned to the virtual link.
Peer Router ID The destination router identification for the virtual link.
Intf State The state of the virtual link with regards to the local router.
Nbr State The state of the virtual link adjacency.
Cost The cost metric of the route.

Release History
Release 8.1.1; command introduced.

page 24-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands show ipv6 ospf virtual-link

Related Commands

ipv6 ospf virtual-link Creates or deletes a virtual link.

MIB Objects
ospfv3VirtIfTable
ospfv3VirtIfAreaId
ospfv3VirtIfNeighbor
ospfv3VirtIfState

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-45
show ipv6 ospf area OSPFv3 Commands

show ipv6 ospf area

Displays either all OSPFv3 areas, or a specified OSPFv3 area.
show ipv6 ospf area [area_id]

Syntax Definitions

area_id A unique 32-bit value in IP address format.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Allows you to view the details of a specified OSPFv3 area.

• If an OSPF area is not specified, all known areas for the OSPFv3 router will be displayed.

• See the Related Commands section below for information on modifying an area.

Examples
-> show ipv6 ospf area

Stub Number of
Area ID Type Metric Interfaces
----------------+-------+-------+-------------
0.0.0.0 Normal NA 2
0.0.0.1 Normal NA 2

-> show ipv6 ospf area 0.0.0.0

Area Type = Normal,
Area Stub Metric = 0,
# of SPF calculations = 52,
# Interfaces = 3,
# Router LSAs = 2,
# Network LSAs = 3,
# Intra-area-prefix LSAs = 4,
# Inter-area-prefix LSAs = 15,
# Inter-area-router LSAs = 0,
# hosts = 0,

output definitions
Area Type The area type. This field will be normal or stub.
Area Stub Metric Indicates whether the area is enabled or disabled.
# Router LSAs The total number of Link State Advertisements for the Area.
# Network LSAs The total number of inter-area Link State Advertisements.

page 24-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands show ipv6 ospf area

output definitions (continued)

# of SPF calculations The number of times the area has calculated the Shortest Path.
# Interfaces The number of OSPF interfaces.
# Intra-area-prefix LSAs The number of intra-area-prefix LSAs, which associates a list of IPv6
address prefixes with a router by referencing a router-LSA.
# Inter-area-prefix LSAs The number of inter-area-prefix LSAs.Corresponds to Type 3
summary-LSA of OSPF.
# Inter-area-router LSAs The number of inter-area-router LSAs. Corresponds to Type 4
summary-LSA of OSPF.
# hosts The number of directly attached hosts.

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 ospf area Creates or deletes an OSPFv3 area, assigning default metric, cost,
and type.
show ipv6 ospf interface Displays OSPFv3 interface information.

MIB Objects
ospfv3AreaTable
ospfv3AreaId
ospfv3ImportAsExtern
ospfv3SpfRuns
ospfv3AreaBdrRtrCount
ospfv3AreaSummary
ospfv3AreaStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-47
show ipv6 ospf interface OSPFv3 Commands

show ipv6 ospf interface

Displays OSPFv3 interface information.
show ipv6 ospf interface [interface_name]

Syntax Definitions

interface_name The name of the interface.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Not specifying the interface name displays all known interfaces for the OSPFv3 router.

Examples
-> show ipv6 ospf interface
IPv6
Admin Intf Intf Intf
Name DR Router ID BDR Router ID Status Status Type State
---------+----------------+-----------------+-------+------+-------+------
ospf 10.135.38.37 10.135.37.23 Enabled Up DR NBMA

output definitions
Name The name of the interface.
DR Router ID The designated router address on this network segment. Make sure you
configure a VLAN for the router IP. (See Chapter 5, “VLAN
Management Commands,” for more information.)
BDR Router ID The IP address of the backup designated router.
Vlan The VLAN to which the interface is assigned.
Admin Status The current administration status of the interface, either enabled or
disabled.
Oper Status Indicates whether the interface is an active OSPF interface.
State The current state of the OSPF interface. It will be DR, BDR, other.
Type Displays the OSPFv3 interface type.

page 24-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
OSPFv3 Commands show ipv6 ospf interface

-> show ipv6 ospf interface vlan-2071

Type = BROADCAST,
Admin Status = Enabled,
IPv6 Interface Status = Up,
Oper Status = Up,
State = DR,
Area = 0.0.0.0,
Priority = 100,
Cost = 1,
Interface Type = Point-To-Point,
Designated Router = 3.3.3.3,
Backup Designated Router = 0.0.0.0,
Hello Interval = 1,
Router Dead Interval = 4,
Retransmit Interval = 5,
Transit Delay = 1,
Ifindex = 17,
IPv6 'ifindex' = 2071,
MTU = 1500,
# of attached neighbors = 0,
Globally reachable prefix #0 = 2071::2/64

Output fields when an IP address or interface name is specified are described below:

output definitions
Type The OSPF interface type, which can be Broadcast, NBMA, Point-to-
Point, or Point-to-Multipoint.
Admin Status The current administrative status of the interface, either enabled or
disabled.
IPv6 Interface Status The current administrative status of the IPv6 interface, either up or
down.
Oper Status Indicates whether the interface is an active OSPF interface.
State The current state of the OSPF interface. It will be down, up, dp, dr, or
other.
Area The area identification number to which the interface is assigned. This
field is not applicable if an interface has not yet been assigned to an
area.
Priority The priority of the interface with regards to becoming the designated
router. The higher the number, the higher the priority.
Cost The cost added to routes learned on this interface.
Interface Type Displays the OSPFv3 interface type.
Designated Router The identification number of the designated router.
Backup Designated Router The identification number of the backup designated router.
Hello Interval The number of seconds between hello messages sent out on the
interface.
Router Dead Interval The number of seconds the interface waits for hello messages received
from a neighbor before declaring the neighbor as dead.
Retransmit Interval The number of seconds the interface waits before resending hello
messages.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 24-49
show ipv6 ospf interface OSPFv3 Commands

output definitions (continued)

Transit Delay The estimated number of seconds required to transmit a link state
update over this interface.
Ifindex The unique value assigned to an interface.
IPv6 'ifindex' The unique value assigned to an IPv6 interface.
MTU The Maximum Transfer Unit (in bytes) for the interface.
# of attached neighbors The number of OSPFv3 neighbors in the initialization state.
Globally reachable prefix #0 A globally unique IPv6 address.

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 ospf interface Creates and deletes an OSPFv3 interface.

ipv6 ospf interface dead- Configures the OSPFv3 interface dead interval.
interval
ipv6 ospf interface hello- Configures the OSPFv3 interface hello interval.
interval
ipv6 ospf interface cost Configures the OSPFv3 interface cost.
ipv6 ospf interface priority Configures the OSPFv3 interface priority.
ipv6 ospf interface retrans- Configures the OSPFv3 interface retransmit interval.
interval
ipv6 ospf interface transit-delay Configures the OSPFv3 interface transit delay.
ipv6 ospf interface area Configures an OSPFv3 interface area.
ipv6 ospf interface suppress- Enables or disables the administration status on an OSPFv3
link-lsa interface.

MIB Objects
ospfv3IfTable
ospfv3IfAreaId
ospfv3IfType
ospfv3IfAdminStat
ospfv3IfRtrPriority
ospfv3IfTransitDelay
ospfv3IfRetransInterval
ospfv3IfHelloInterval
ospfv3IfRtrDeadInterval
ospfv3IfPollInterval
ospfv3IfState
ospfv3IfDesignatedRouter
ospfv3IfBackupDesignatedRouter
ospfv3IfEvents
ospfv3IfStatus

page 24-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 25 IS-IS Commands

Intermediate System-Intermediate System (IS-IS) is a shortest path first (SPF) or link-state protocol. IS-IS
is an interior gateway protocol (IGP) that distributes routing information between routers in a single auton-
omous system (AS) for IP (IPv4 and IPv6) as well as OSI environments. This feature allows a single rout-
ing protocol to support pure IP and OSI environments, and dual environments. Integrated IS-IS is also
deployed extensively in an IP-only environment.
Each participating router distributes its local state (that is, the usable interfaces of the router and reachable
neighbors) throughout the AS by flooding. In a link-state protocol, each router maintains a database
describing the entire AS topology. IS-IS routers have adjacencies with other routers on point-to-point
links. In a multi-access network, routers report their adjacencies to a Designated Intermediate System
(DIS), which generates an additional Link State PDU (LSP), commonly known as the pseudo-node LSP.
The DIS is responsible for flooding the LAN with LSP and also for synchronizing the entire AS topology.
This database is built from the collected link state advertisements of all routers.
IS-IS is a hierarchical protocol where the autonomous system is divided into multiple areas to reduce the
size of the Routing table. Routing within an area is referred to as Level-1 routing and that between two or
more areas is referred to as Level 2 routing. Each area runs a separate copy of the basic link-state routing
algorithm.
Alcatel-Lucent’s version of IS-IS complies with RFC 1142.
MIB information for the IP commands is as follows:
Filename: AlcatelIND1Isis.mib
Module: ALCATEL-IND1-ISIS-MIB
Filename: IETF_ISIS.MIB
Module: ISIS-MIB
A summary of the available commands is listed here:

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-1
 IS-IS Commands

Global IS-IS Commands ip load isis

ip isis admin-state
ip isis area-id
ip isis level-capability
ip isis auth-check
ip isis auth-type
ip isis csnp-auth
ip isis hello-auth
ip isis psnp-auth
ip isis lsp-lifetime
ip isis lsp-wait
ip isis spf-wait
ip isis summary-address
ip isis overload
ip isis overload-on-boot
ip isis graceful-restart
ip isis graceful-restart helper
ip isis strict-adjacency-check
ip isis level auth-type
ip isis level hello-auth
ip isis level csnp-auth
ip isis level psnp-auth
ip isis level wide-metrics-only
IPv4 and IPv6 Commands ip isis activate-ipv6|ipv4
ip isis vlan
ip isis vlan admin-state
ip isis vlan interface-type
ip isis vlan csnp-interval
ip isis vlan hello-auth-type
ip isis vlan level-capability
ip isis vlan lsp-pacing-interval
ip isis vlan passive
ip isis vlan retransmit-interval
ip isis vlan default-type
ip isis vlan level hello-auth-type
ip isis vlan level hello-interval
ip isis vlan level hello-multiplier
ip isis vlan level metric
ip isis vlan level passive
ip isis vlan level priority
ip isis summary-address6

page 25-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands

Show Commands show ip isis adjacency

show ip isis database
show ip isis hostname
show ip isis routes
show ip isis routes6
show ip isis spf
show ip isis spf-log
show ip isis statistics
show ip isis status
show ip isis summary-address
show ip isis vlan
show ip isis summary-address6
Clear Commands clear ip isis adjacency
clear ip isis lsp-database
clear ip isis spf-log
clear ip isis statistics
M-ISIS (Multi Topology) ip isis multi-topology
Commands

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-3
ip load isis IS-IS Commands

ip load isis
Loads the IS-IS software on the router.
ip load isis

Syntax Definitions

N/A

Defaults
By default, IS-IS is not loaded on the switch.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• You need to load IS-IS on the switch before executing any IS-IS configuration command.

• To unload IS-IS, remove all the IS-IS configuration from “vcboot.cfg”.

Examples
-> ip load isis

Release History
Release 8.1.1; command introduced.

Related Commands

show ip protocols Displays switch routing protocol information and status.

MIB Objects
alaDrcTmIPIsisStatus

page 25-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis admin-state

ip isis admin-state
Enables or disables the administrative status of IS-IS on the switch.
ip isis admin-state {enable | disable}

Syntax Definitions

enable Enables IS-IS.

disable Disables IS-IS.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
When IS-IS status is disabled, the configuration settings and related statistics of the protocol remain
unaffected.

Examples
-> ip isis admin-state enable
-> ip isis admin-state disable

Release History
Release 8.1.1; command introduced.

Related Commands

show ip isis status Displays the IS-IS status.

MIB Objects
isisSysTable
isisSysAdminState

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-5
ip isis area-id IS-IS Commands

ip isis area-id
Configures the area ID for the switch.
ip isis area-id area address
no ip isis area-id area address

Syntax Definitions

area address 1–13 byte variable length integer, which specifies the area address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the area ID.

• The area ID is part of the Network Service Access Point (NSAP) address.

• Other parts of NSAP address (system ID and selector ID) are not configurable. System ID is derived
from router ID and selector ID remains always as 00.
• You can configure a maximum of three area addresses.

Examples
-> ip isis area-id 49.0001
-> no ip isis area-id 49.0001

Release History
Release 8.1.1; command introduced.

Related Commands

show ip isis status Displays the IS-IS status.

MIB Objects
isisManAreaAddrTable
isisManAreaAddrExistState

page 25-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis level-capability

ip isis level-capability
Configures the router level of the IS-IS protocol globally.
ip isis level-capability {level-1 | level-2 | level-1/2}

Syntax Definitions

level-1 Specifies that the router can operate at Level-1 only.

level-2 Specifies that the router can operate at Level-2 only.
level-1/2 Specifies that the router can operate at both Level-1 and Level-2.

Defaults

parameter default
level-1 | level-2 | level-1/2 level-1/2

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Changing the level capability restarts the IS-IS protocol.

• You can also configure the level capability at the IS-IS circuit level.

Examples
-> ip isis level-capability level-1
-> ip isis level-capability level-2

Release History
Release 8.1.1; command introduced.

Related Commands

ip isis vlan level-capability Configures the IS-IS level on the specified circuit.
show ip isis status Displays the IS-IS status.

MIB Objects
isisSysTable
isisSysType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-7
ip isis auth-check IS-IS Commands

ip isis auth-check
Enables or disables authentication check for IS-IS PDUs.
ip isis auth-check {enable | disable}

Syntax Definitions

enable Enables authentication check for IS-IS PDUs.

disable Disables authentication check for IS-IS PDUs.

Defaults
By default, authentication check is enabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If enabled, IS-IS PDUs that fail to match either of the authentication type and key requirements are
rejected.
• If disabled, the authentication PDUs are generated and the IS-IS PDUs are authenticated on receipt. An
error message will be generated in case of a mismatch; but PDUs will not be rejected.

Examples
-> ip isis auth-check enable
-> ip isis auth-check disable

Release History
Release 8.1.1; command introduced;

Related Commands

ip isis auth-type Enables authentication and configures the authentication type of IS-
IS protocol globally.
ip isis level auth-type Enables authentication and configures the authentication types for
specific IS-IS levels.
show ip isis status Displays the IS-IS status.

MIB Objects
vRtrIsisTable
vRtrIsisAuthCheck

page 25-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis auth-type

ip isis auth-type
Enables authentication and configures the authentication type of IS-IS protocol globally.
ip isis auth-type {simple {key key | encrypt-key encrypt-key} | md5 {key key | encrypt-key encrypt-key}
| none}

Syntax Definitions

simple Simple authentication will be used.

md5 Specifies that MD5 authentication algorithm will be used. Hash-key will
be used in MD5 authentication.
key Key will be plain text ASCII up to 118 characters. Use quotes around
string if the key contains multiple words with spaces between them.
encrypt-key The key in hexadecimal format to provide security consideration on the
authentication key. Configuration snapshot always displays authentica-
tion key in the encrypted form.
none No authentication will be used.

Defaults

parameter default
simple | md5 | none none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Simple authentication uses only a text string as the password in the packet. This helps to protect the
routers from a configuration mishap. MD5 authentication is used to protect the system from malicious
actions.
• MD5 authentication is used to encrypt the information that is sent over the network. MD5
authentication uses shared secret key. The Key is used to sign the packets with an MD5 checksum to
sign the packet, so that the packets cannot be tampered. As the key is not included in the packet,
snooping the key is not possible.
• Use the Key parameter to configure the password for Simple or MD5 authentication. Alternatively, use
the encrypt-key parameter to configure the password by supplying the encrypted form of the password
as the encrypt-key. The Configuration snapshot always displays the password in the encrypted form.
You should use only this key parameter during the CLI configuration.
• If the encrypt-key parameter is used to configure the password through the CLI, then its value should
be the same as the one that appears in the configuration snapshot. Only valid system generated values
are accepted as encrypt-key.
• This command configures the authentication type of IS-IS protocol globally. These settings can be
overridden at each level.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-9
ip isis auth-type IS-IS Commands

• By default, the authentication is disabled and no authentication type is configured.

Examples
-> ip isis auth-type simple key rachel
-> ip isis auth-type md5 encrypt-key 7a1e441a014b4030

Release History
Release 8.1.1; command introduced.

Related Commands

ip isis level auth-type Enables authentication and configures the authentication types for
specific IS-IS levels.
show ip isis status Displays the IS-IS status.

MIB Objects
vRtrIsisTable
vRtrIsisAuthType
vRtrIsisAuthKey

page 25-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis csnp-auth

ip isis csnp-auth
Enables or disables the authentication of Complete Sequence Number PDUs (CSNPs).
ip isis csnp-auth
no ip isis csnp-auth

Syntax Definitions

N/A

Defaults
CSNP authentication check is enabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to prevent the CSNP authentication.

Examples
-> ip isis csnp-auth
-> no ip isis csnp-auth

Release History
Release 8.1.1; command introduced.

Related Commands

ip isis level csnp-auth Configures CSNP authentication for specific IS-IS levels.
show ip isis status Displays the IS-IS status.

MIB Objects
vRtrIsisTable
vRtrIsisCsnpAuthentication

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-11
ip isis hello-auth IS-IS Commands

ip isis hello-auth
Enables or disables the authentication of Hello PDUs globally.
ip isis hello-auth
no ip isis hello-auth

Syntax Definitions

N/A

Defaults
Authentication check of Hello PDUs is enabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to prevent the authentication of Hello packets.

Examples
-> ip isis hello-auth
-> no ip isis hello-auth

Release History
Release 8.1.1; command introduced.

Related Commands

ip isis level hello-auth Enables or disables the authentication of Hello PDUs for specific
IS-IS levels.
show ip isis status Displays the IS-IS status.

MIB Objects
vRtrIsisTable
vRtrIsisHelloAuthentication

page 25-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis psnp-auth

ip isis psnp-auth
Enables or disables the authentication of Partial Sequence Number PDUs (PSNPs).
ip isis psnp-auth
no ip isis psnp-auth

Syntax Definitions

N/A

Defaults
PSNP authentication check is enabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to prevent the authentication of PSNP packets.

Examples
-> ip isis psnp-auth
-> no ip isis psnp-auth

Release History
Release 8.1.1; command introduced.

Related Commands

ip isis level psnp-auth Configures the PSNP authentication for specific IS-IS levels.
show ip isis status Displays the IS-IS status.

MIB Objects
vRtrIsisTable
vRtrIsisPsnpAuthentication

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-13
ip isis lsp-lifetime IS-IS Commands

ip isis lsp-lifetime
Configures the time interval for which Link State PDUs generated by a router are considered valid by
other routers in the same domain.
ip isis lsp-lifetime seconds
no ip isis lsp-lifetime

Syntax Definitions

seconds Validity interval in seconds.The valid range is 350–65535.

Defaults

parameter default
seconds 1200

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to restore the default value.

Examples
-> ip isis lsp-lifetime 760
-> no ip isis lsp-lifetime

Release History
Release 8.1.1; command introduced.

Related Commands

ip isis vlan lsp-pacing-interval Configures the interval between IS-IS LSP PDUs sent from the
specified circuit.
show ip isis status Displays the IS-IS status.
show ip isis database Displays IS-IS LSP database information of the adjacent routers.

MIB Objects
vRtrIsisTable
vRtrIsisLspLifetime

page 25-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis lsp-wait

ip isis lsp-wait
Configures the intervals between the first, second and subsequently generated LSPs.
ip isis lsp-wait {max-wait | initial-wait | second-wait} seconds
no ip isis lsp-wait {max-wait | initial-wait | second-wait}

Syntax Definitions

max-wait Specifies the maximum interval between two successive LSPs, in

seconds. The valid range is 1–120.
initial-wait Specifies the initial LSP generation delay, in seconds. The valid range is
0–100.
second-wait Specifies the time interval between the first and second generated LSPs,
in seconds. The valid range is 1–100.
seconds Specifies the time interval.

Defaults

parameter default
max-wait seconds 5
initial-wait seconds 0
second-wait seconds 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to restore the default value.

• Successive LSPs are generated at increasing second-wait interval until a maximum value is reached.

Examples
-> ip isis lsp-wait max-wait 25
-> no ip isis lsp-wait initial-wait

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-15
ip isis lsp-wait IS-IS Commands

Related Commands

ip isis vlan lsp-pacing-interval Configures the interval between IS-IS LSP PDUs sent from the
specified circuit.
show ip isis status Displays the IS-IS status.

MIB Objects
vRtrIsisTable
vRtrIsisLspInitialWait
vRtrIsisLspSecondWait
vRtrIsisLspMaxWait

page 25-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis spf-wait

ip isis spf-wait
Configures the intervals between the first, second, and subsequent SPF calculations.
ip isis spf-wait {max-wait seconds | initial-wait milliseconds| second-wait milliseconds}
no ip isis spf-wait {max-wait | initial-wait | second-wait}

Syntax Definitions

max-wait seconds Specifies the maximum interval between two successive SPF
calculations, in seconds. The valid range is 1000-120000 milliseconds.
initial-wait milliseconds Specifies the initial SPF calculation delay, in milliseconds. The valid
range is 10–100000 milliseconds.
second-wait milliseconds Specifies the interval between first and second generated SPFs, in
milliseconds. The valid range is 1–100000 milliseconds.

Defaults

parameter default
max-wait milliseconds 10000
initial-wait milliseconds 1000
second-wait milliseconds 1000

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to restore the default value.

• Successive SPF calculations are generated at exponentially increasing second-wait interval until a
maximum value is reached.

Examples
-> ip isis spf-wait max-wait 1000
-> no ip isis spf-wait max-wait

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-17
ip isis spf-wait IS-IS Commands

Related Commands

show ip isis status Displays the IS-IS status.

MIB Objects
vRtrIsisTable
vRtrIsisSpfWait
vRtrIsisSpfInitialWait
vRtrIsisSpfSecondWait

page 25-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis summary-address

ip isis summary-address
Adds or deletes the summary address.
ip isis summary-address {ip-prefix/mask | ip-prefix [/netmask]} {level-1 | level-2 | level-1/2}
no ip isis summary-address {ip-prefix/mask | ip-prefix [/netmask]}

Syntax Definitions

ip-prefix/mask Specifies the IP prefix in dotted decimal notation and the mask length.
ip-prefix Specifies the IP prefix in dotted decimal notation.
/netmask Specifies the subnet mask in dotted decimal notation.
level-1 Specifies the IS-IS level as Level-1.
level-2 Specifies the IS-IS level as Level-2.
level-1/2 Specifies the IS-IS level as Level-1/2.

Defaults

parameter default
level-1 | level-2 | level-1/2 level-1/2

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an already configured summary address.

• Native IS-IS routes can only be summarized into Level-2 from the Level-1 database.

• It is not possible to summarize IS-IS internal routes at Level-1, although it is possible to summarize
external (redistributed) routes at Level-1.
• IS-IS routes are not summarized by default.

Examples
-> ip isis summary-address 10.0.0.0/8 level-2
-> no ip isis summary-address 10.0.0.0/8

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-19
ip isis summary-address IS-IS Commands

Related Commands

show ip isis summary-address Displays the IS-IS summary address database.

MIB Objects
vRtrIsisSummaryTable
vRtrIsisSummRowStatus

page 25-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis overload

ip isis overload
Enables and configures the IS-IS router to operate in the overload state for a specified time period.
ip isis overload [timeout seconds]
no ip isis overload [timeout]

Syntax Definitions

timeout seconds Specifies the timeout interval, in seconds. The valid range is 60–1800.

Defaults
By default, the IS-IS overload state is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to make the router exit the overload state.

• If the time period is not specified, the router remains in the overload state for an infinite period.

• During normal operation, the router may be forced to enter an overload state due to a lack of resources.
When in the overload state, the router is used only if the destination route is directly reachable by the
router i.e., it will not be used for other transit traffic.
• This command can be used when the router is overloaded or before executing a shutdown command to
divert traffic around the router.

Examples
-> ip isis overload timeout 70
-> no ip isis overload timeout

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-21
ip isis overload IS-IS Commands

Related Commands

ip isis overload-on-boot Configures the IS-IS router to be in the overload state during bootup
for a specified time period.
show ip isis status Displays the IS-IS status.

MIB Objects
isisSysTable
isisSysSetOverload
vRtrIsisTable
vRtrIsisOverloadTimeout

page 25-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis overload-on-boot

ip isis overload-on-boot
Configures the IS-IS router to be in the overload state after bootup for a specified time period.
ip isis overload-on-boot [timeout seconds]
no ip isis overload-on-boot [timeout seconds]

Syntax Definitions

timeout seconds Specifies the timeout interval, in seconds. The valid range is 60–1800.

Defaults
By default, the IS-IS router will not be in the overload state.

parameter default
timeout seconds 60

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to prevent the router from entering the overload state after bootup.

• The router in the overload state is used only if there is no alternate path to reach the destination.

• This command configures the router after bootup in the overload state until the timeout timer expires or
a timeout value is specified in the no form of this command.
• The no overload command does not influence the overload-on-boot function.

Examples
-> ip isis overload-on-boot timeout 80
-> no ip isis overload-on-boot timeout

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-23
ip isis overload-on-boot IS-IS Commands

Related Commands

ip isis overload Sets the IS-IS router to operate in the overload state.
show ip isis status Displays the IS-IS status.

MIB Objects
vRtrIsisTable
vRtrIsisOverloadOnBoot
vRtrIsisOverloadOnBootTimeout

page 25-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis graceful-restart

ip isis graceful-restart
Configures graceful restart of the router. It allows routing protocols to re-converge faster, minimizing
service interruption.
ip isis graceful-restart
no ip isis graceful-restart

Syntax Definitions

N/A

Defaults
Graceful restart is disabled on the router by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable graceful restart and remove the graceful restart
configuration from the IS-IS router.
• When graceful restart is enabled, the router can either be a helper (which helps a neighbor router to
restart) or a restarting router, or both. In the current release, only the helper mode of a router is
supported.

Examples
-> ip isis graceful-restart
-> no ip isis graceful-restart

Release History
Release 8.1.1; command introduced.

Related Commands

ip isis graceful-restart helper Configures the helper mode of routers for graceful restart.
show ip isis status Displays the IS-IS status.

MIB Objects
vRtrIsisTable
vRtrIsisGracefulRestart

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-25
ip isis graceful-restart helper IS-IS Commands

ip isis graceful-restart helper

Administratively enables and disables the IS-IS router to operate in the helper mode in response to a router
performing a graceful restart.
ip isis graceful-restart helper {enable | disable}

Syntax Definitions

enable Enables the helper mode on the router.

disable Disables the helper mode on the router.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When graceful restart is enabled, the helper mode is enabled by default.

• When graceful restart helper is enabled on a router, it can help other restarting routers.

Examples
-> ip isis graceful-restart helper disable

Release History
Release 8.1.1; command introduced.

Related Commands

ip isis graceful-restart Configures graceful restart on the router.

show ip isis status Displays the IS-IS status.

MIB Objects
vRtrIsisTable
vRtrIsisGRHelperMode

page 25-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis strict-adjacency-check

ip isis strict-adjacency-check
Enables or disables the adjacency check configuration on the router.
ip isis strict-adjacency-check {enable | disable}

Syntax Definitions

enable Enables the adjacency check configuration on the router.

disable Disables the adjacency check configuration on the router.

Defaults
By default, the adjacency check configuration is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When the adjacency check configuration is enabled, both routers have to run the same IP version only
in the IS-IS protocol to form an adjacency.
• When the adjacency check configuration is disabled, one common IP version running between two
routers is enough to form an adjacency in the IS-IS protocol.

Examples
-> ip isis strict-adjacency-check enable

Release History
Release 8.1.1; command introduced.

Related Commands

show ip isis status Displays the IS-IS status.

MIB Objects
vRtrIsisTable
vRtrIsisStrictAdjacencyCheck

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-27
ip isis level auth-type IS-IS Commands

ip isis level auth-type

Enables authentication and configures the authentication types for specific IS-IS levels.
ip isis level {1 | 2} auth-type {simple {key key | encrypt-key encrypt-key} | md5 {key key | encrypt-key
encrypt-key} | none}

Syntax Definitions

1 Specifies the IS-IS level as Level-1.

2 Specifies the IS-IS level as Level-2.
simple Simple authentication will be used.
md5 Specifies that MD5 authentication algorithm will be used. Hash-key will
be used in MD5 authentication.
key Key will be plain text ASCII up to 118 characters. Use quotes around
string if the key contains multiple words with spaces between them.
encrypt-key The key in hexadecimal format to provide security consideration on the
authentication key. Configuration snapshot always displays
authentication key in the encrypted form.
none No authentication will be used.

Defaults

parameter default
simple | md5 | none none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Simple authentication uses only a text string as the password in the packet. This helps to protect the
routers from a configuration mishap. MD5 authentication is used to protect the system from malicious
actions.
• MD5 authentication is used to encrypt the information that is sent over the network. MD5
authentication uses shared secret key. The Key is used to sign the packets with an MD5 checksum to
sign the packet, so that the packets cannot be tampered. As the key is not included in the packet,
snooping the key is not possible.
• Use the Key parameter to configure the password for Simple or MD5 authentication. Alternatively, use
the encrypt-key parameter to configure the password by supplying the encrypted form of the password
as the encrypt-key. The Configuration snapshot always displays the password in the encrypted form.
You should use only this key parameter during the CLI configuration.
• If the encrypt-key parameter is used to configure the password through the CLI, then its value should
be the same as the one that appears in the configuration snapshot. Only valid system generated values
are accepted as encrypt-key.

page 25-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis level auth-type

• This command overrides the global configuration of IS-IS authentication type.

• This command also sets the password or hash-key according to the type of authentication.

• By default, the authentication is disabled and no authentication type is configured.

Examples
-> ip isis level 2 auth-type simple key rachel
-> ip isis level 2 auth-type md5 encrypt-key 7a1e441a014b4030

Release History
Release 8.1.1; command introduced.

Related Commands

ip isis auth-type Enables authentication and configures the authentication type of IS-
IS protocol globally.
show ip isis status Displays the IS-IS status.

MIB Objects
vRtrIsisLevelTable
vRtrIsisLevelAuthType
vRtrIsisLevelAuthKey

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-29
ip isis level hello-auth IS-IS Commands

ip isis level hello-auth

Enables or disables the authentication of Hello PDUs for specific IS-IS levels.
ip isis level {1 | 2} hello-auth
no ip isis level {1 | 2} hello-auth

Syntax Definitions

1 Specifies the IS-IS level as Level-1.

2 Specifies the IS-IS level as Level-2.

Defaults
Authentication check of Level Hello PDUs is enabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to prevent the authentication of Hello packets at the specified IS-IS
level.
• This command overrides the global configuration of IS-IS Hello authentication.

Examples
-> ip isis level 1 hello-auth
-> no ip isis level 1 hello-auth

Release History
Release 8.1.1; command introduced.

Related Commands

ip isis hello-auth Enables or disables the authentication of Hello PDUs globally.

show ip isis status Displays the IS-IS status.

MIB Objects
vRtrIsisLevelTable
vRtrIsisLevelHelloAuthentication

page 25-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis level csnp-auth

ip isis level csnp-auth

Enables or disables the CSNP authentication for specific IS-IS levels.
ip isis level {1 | 2} csnp-auth
no ip isis level {1 | 2} csnp-auth

Syntax Definitions

1 Specifies the IS-IS level as Level-1.

2 Specifies the IS-IS level as Level-2.

Defaults
CSNP authentication check for specific IS-IS levels is enabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to prevent the authentication of CSNPs at the specified IS-IS level.

• This command overrides the global configuration of IS-IS CSNP authentication.

Examples
-> ip isis level 1 csnp-auth
-> no ip isis level 1 csnp-auth

Release History
Release 8.1.1; command introduced.

Related Commands

ip isis csnp-auth Enables or disables the authentication of CSNPs.

show ip isis status Displays the IS-IS status.

MIB Objects
vRtrIsisLevelTable
vRtrIsisLevelCsnpAuthentication

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-31
ip isis level psnp-auth IS-IS Commands

ip isis level psnp-auth

Enables or disables PSNP authentication for specific IS-IS levels.
ip isis level {1 | 2} psnp-auth
no ip isis level {1 | 2} psnp-auth

Syntax Definitions

1 Specifies the IS-IS level as Level-1.

2 Specifies the IS-IS level as Level-2.

Defaults

PSNP authentication check for specific IS-IS levels is enabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to prevent the authentication of PSNPs at the specified IS-IS level.

• This command overrides the global configuration of IS-IS PSNP authentication.

Examples
-> ip isis level 1 psnp-auth
-> no ip isis level 1 psnp-auth

Release History
Release 8.1.1; command introduced.

Related Commands

ip isis psnp-auth Enables or disables the authentication of PSNPs.

show ip isis status Displays the IS-IS status.

MIB Objects
vRtrIsisLevelTable
vRtrIsisLevelPsnpAuthentication

page 25-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis level wide-metrics-only

ip isis level wide-metrics-only

Enables the wide metrics in LSPs for specific IS-IS levels.
ip isis level {1 | 2} wide-metrics-only
no ip isis level {1 | 2} wide-metrics-only

Syntax Definitions

1 Specifies the IS-IS level as Level-1.

2 Specifies the IS-IS level as Level-2.

Defaults
By default, wide metrics is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to restore the narrow metric (1–63).

• Wide metrics are used for improved granularity of metrics.

• Numeric values above 63 indicate wide metrics.

Examples
-> ip isis level 1 wide-metrics-only
-> no ip isis level 1 wide-metrics-only

Release History
Release 8.1.1; command introduced.

Related Commands

show ip isis status Displays the IS-IS status.

MIB Objects
vRtrIsisLevelTable
VrtrIsisLevelWideMetricsOnly

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-33
ip isis activate-ipv6|ipv4 IS-IS Commands

ip isis activate-ipv6|ipv4
Configures the IPv6 or IPv4 routing in IS-IS.
ip isis {activate-ipv6 | activate-ipv4}

Syntax Definitions

N/A

Defaults
By default, both IPv4 and IPv6 routing is enabled in IS-IS.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The no form of this command disables the IPv4/IPv6 routing in IS-IS.

Examples
-> ip isis activate-ipv6
-> ip isis activate-ipv4
-> no ip isis activate-ipv4

Release History
Release 8.1.1; command introduced.

Related Commands

show ip isis status Displays the IS-IS status.

MIB Objects
vRtrIsisActivateIPV4
vRtrIsisActivateIPV6

page 25-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis vlan

ip isis vlan
Configures IPv4 or IPv6 IS-IS circuit on a particular VLAN. This command enables IS-IS routing on a
particular VLAN. This is used to add both the IPv4 and IPv6 interfaces on a particular VLAN to the IS-IS
circuit.
ip isis vlan vlan-id [address-family {v4 | v6 | v4v6}]

Syntax Definitions

vlan-id The VLAN ID of a given VLAN on which IS-IS is to be enabled.

v4 | v6 | v4v6 The address family extension. The type of interface (IPv4 or IPv6) is
controlled by the address-family extension.

Defaults
By default, both address families (IPv4 and IPv6) are disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The no form of this command disables IPv4/IPv6 IS-IS circuit on a particular VLAN.

Examples
-> ip isis vlan 10
-> ip isis vlan 10 address-family v6
-> no ip isis vlan 10 address-family v6

Release History
Release 8.1.1; command introduced.

Related Commands

show ip isis vlan Displays the IS-IS IPv4 and IPv6 interface information on a VLAN
in the IS-IS database.

MIB Objects
vRtrIsisIfTable
vRtrIsisIfRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-35
ip isis vlan admin-state IS-IS Commands

ip isis vlan admin-state

Enables or disables IS-IS on an circuit.
ip isis vlan vlan-id admin-state {enable | disable}

Syntax Definitions

vlan-id The VLAN ID of a given VLAN on which IS-IS routing is to be

enabled.
enable Administratively enables IS-IS on the VLAN.
disable Administratively disables IS-IS on the VLAN.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
When the status is manually disabled, the configuration settings and related statistics of the protocol
remain unaffected.

Examples
-> ip isis vlan 10 admin-state enable
-> ip isis vlan 10 admin-state disable

Release History
Release 8.1.1; command introduced.

Related Commands

show ip isis vlan Displays the IS-IS IPv4 and IPv6 interface information on a VLAN in
the IS-IS database.

MIB Objects
isisCircTable
isisCircAdminState

page 25-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis vlan interface-type

ip isis vlan interface-type

Configures the IS-IS interface (circuit) type as broadcast or point-to-point.
ip isis vlan vlan-id interface-type {broadcast | point-to-point}

Syntax Definitions

vlan-id The VLAN ID of a given VLAN.

broadcast Sets the interface (circuit) type as a broadcast IS-IS interface.
point-to-point Sets the interface (circuit) type as a point-to-point IS-IS interface.

Defaults

parameter default
broadcast | point-to-point broadcast

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip isis vlan 10 interface-type broadcast
-> ip isis vlan 10 interface-type point-to-point

Release History
Release 8.1.1; command introduced.

Related Commands

ip isis vlan default-type Sets the interface type to default, that is, broadcast.
show ip isis vlan Displays the IS-IS IPv4 and IPv6 interface information on a VLAN in
the IS-IS database.

MIB Objects
isisCircTable
isisCircType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-37
ip isis vlan csnp-interval IS-IS Commands

ip isis vlan csnp-interval

Configures the time interval in seconds to send Complete Sequence Number PDUs (CSNP) PDUs from
the specified VLAN circuit.
ip isis vlan vlan-id csnp-interval seconds

Syntax Definitions

vlan-id The VLAN ID of a given VLAN on which IS-IS routing is to be

enabled.
seconds The time interval in seconds between successive CSNP PDUs sent on an
interface after which IS-IS must generate a CSNP PDU on the specified
circuit. The valid range is 1–65535.

Defaults

parameter default
seconds Broadcast interface: 10 seconds
Point-to-Point interface: 5 seconds

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The no form of this command reverts the time interval to the default value.

Examples
-> ip isis vlan 10 csnp-interval 10
-> no ip isis vlan 10 csnp-interval

Release History
Release 8.1.1; command introduced.

Related Commands

show ip isis status Displays the IS-IS status.

MIB Objects
vRtrIsisIfCsnpInterval

page 25-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis vlan hello-auth-type

ip isis vlan hello-auth-type

Configures the authentication settings for the hello protocol at a circuit level.
ip isis vlan vlan-id hello-auth-type {simple {key key | encrypt-key encrypt-key} | md5 {key key |
encrypt-key encrypt-key} | none}

Syntax Definitions

vlan-id The VLAN ID of a given VLAN.

simple Simple authentication will be used.
md5 Specifies that MD5 authentication algorithm will be used. Hash-key will
be used in MD5 authentication.
key Key will be plain text ASCII up to 118 characters. Use quotes around
string if the key contains multiple words with spaces between them.
encrypt-key The key in hexadecimal format to provide security considerations on the
authentication key. Configuration snapshot always displays
authentication key in the encrypted form.
none No authentication will be used.

Defaults

parameter default
simple | md5 | none none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Simple authentication uses only a text string as the password in the packet. This helps to protect the
routers from a configuration mishap. MD5 authentication is used to protect the system from malicious
actions.
• MD5 authentication is used to encrypt the information that is sent over the network. MD5 authentica-
tion uses shared secret key. The Key is used to sign the packets with an MD5 checksum to sign the
packet, so that the packets cannot be tampered. As the key is not included in the packet, snooping the
key is not possible.
• Use the Key parameter to configure the password for Simple or MD5 authentication. Alternatively, use
the encrypt-key parameter to configure the password by supplying the encrypted form of the password
as the encrypt-key. The Configuration snapshot always displays the password in the encrypted form.
You must use only this key parameter during the CLI configuration.
• If the encrypt-key parameter is used to configure the password through the CLI, then its value should
be the same as the one that appears in the configuration snapshot. Only valid system generated values
are accepted as encrypt-key.
• By default, the authentication is disabled and no authentication type is configured.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-39
ip isis vlan hello-auth-type IS-IS Commands

Examples
-> ip isis vlan 10 hello-auth-type md5 key asddfgfhno
-> ip isis vlan 10 hello-auth-type simple key sdsdff

Release History
Release 8.1.1; command introduced.

Related Commands

ip isis vlan level hello-auth-type Configures the authentication of Hello PDUs for the specified IS-IS
level of an IS-IS Circuit.
show ip isis vlan Displays the IS-IS IPv4 and IPv6 interface information on a VLAN in
the IS-IS database.

MIB Objects
vRtrIsisIfHelloAuthKey
vRtrIsisIfHelloAuthType

page 25-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis vlan level-capability

ip isis vlan level-capability

Configures the IS-IS level on the specified circuit.
ip isis vlan vlan-id level-capability [level-1 | level-2 | level-1/2]

Syntax Definitions

vlan-id The VLAN ID of a given VLAN.

level-1 Specifies that the interface can operate at Level-1 only.
level-2 Specifies that the interface can operate at Level-2 only.
level-1/2 Specifies that the interface can operate at both Level-1 and Level-2.

Defaults

parameter default
level-1 | level-2 | level-1/2 level-1/2

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Changing the level capability restarts the IS-IS protocol on the interface.

• If the level capability is configured globally and on a specific interface, the combination of the two
settings will decide the potential adjacency.

Examples
-> ip isis vlan 10 level-capability level-1
-> ip isis vlan 10 level-capability level-1/2

Release History
Release 8.1.1; command introduced.

Related Commands

ip isis level-capability Configures the router level of the IS-IS protocol globally.
show ip isis vlan Displays the IS-IS IPv4 and IPv6 interface information on a VLAN in
the IS-IS database.

MIB Objects
isisCircTable
isisCircLevel

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-41
ip isis vlan lsp-pacing-interval IS-IS Commands

ip isis vlan lsp-pacing-interval

Configures the interval between IS-IS LSP PDUs sent from the specified circuit.
ip isis vlan vlan-id lsp-pacing-interval milliseconds
no ip isis vlan vlan-id lsp-pacing-interval

Syntax Definitions

vlan-id The VLAN ID of a given VLAN.

milliseconds The time interval in milliseconds (from 0 to 65535) between IS-IS
LSPs.

Defaults

parameter default
milliseconds 100

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to restore the default settings.

• No LSPs are sent from the specified interface if the time interval is set to 0.

Examples
-> ip isis vlan 10 lsp-pacing-interval 1000
-> no ip isis vlan 10 lsp-pacing-interval

Release History
Release 8.1.1; command introduced.

page 25-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis vlan lsp-pacing-interval

Related Commands

ip isis lsp-lifetime Configures the time interval for which LSPs generated by a router is
considered valid by other routers in the same domain.
ip isis lsp-wait Configures the time interval between successively generated LSPs.
show ip isis vlan Displays the IS-IS IPv4 and IPv6 interface information on a VLAN
in the IS-IS database.

MIB Objects
vRtrIsisIfTable
vRtrIsisIfLspPacingInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-43
ip isis vlan passive IS-IS Commands

ip isis vlan passive

Configures the IS-IS circuit as passive.
ip isis vlan vlan-id passive
no ip isis vlan vlan-id passive

Syntax Definitions

vlan-id The VLAN ID of a given VLAN.

Defaults
By default, the interface is not passive.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the passive attribute.

• This command adds the passive attribute that causes the IS-IS circuit to be advertised as an IS-IS
circuit without running the IS-IS protocol. Normally, only interface addresses that are configured for
IS-IS are advertised as IS-IS interface at the level that they are configured. When the passive mode is
enabled, the interface or the interface at the level ignores ingress IS-IS PDUs (Protocol Data Unit) and
will not transmit IS-IS protocol PDUs.

Examples
-> ip isis vlan 10 passive
-> no ip isis vlan 10 passive

Release History
Release 8.1.1; command introduced.

Related Commands

ip isis vlan level passive Configures the IS-IS circuit as passive at the specified IS-IS level.
show ip isis vlan Displays the IS-IS IPv4 and IPv6 interface information on a VLAN in
the IS-IS database.

MIB Objects
isisCircTable
isisCircPassiveCircuit

page 25-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis vlan retransmit-interval

ip isis vlan retransmit-interval

Configures the minimum time interval between LSP (Link State Packet) retransmissions on a point-to-
point interface.
ip isis vlan vlan-id retransmit-interval seconds
no ip isis vlan vlan-id retransmit-interval

Syntax Definitions

vlan-id The VLAN ID of a given VLAN.

seconds The minimum time interval (1–65535) in seconds between LSP trans-
missions on a point-to-point interface.

Defaults

parameter default
seconds 5

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to restore the default settings.

• The retransmit interval should be greater than the expected round-trip delay between two devices to
avoid any needless retransmission of PDUs.

Examples
-> ip isis vlan 10 retransmit-interval 130
-> no ip isis vlan 10 retransmit-interval

Release History
Release 8.1.1; command introduced.

Related Commands

show ip isis vlan Displays the IS-IS IPv4 and IPv6 interface information on a VLAN in
the IS-IS database.

MIB Objects
vRtrIsisIfTbale
vRtrIsisIfRetransmitInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-45
ip isis vlan default-type IS-IS Commands

ip isis vlan default-type

Sets the interface type to default, that is, broadcast.
ip isis vlan vlan-id default-type

Syntax Definitions

vlan-id The VLAN ID of a given VLAN.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip isis vlan 10 default-type

Release History
Release 8.1.1; command introduced.

Related Commands

ip isis vlan interface-type Configures the IS-IS interface (circuit) type as broadcast or point-to-
point.

MIB Objects
vRtrIsisIfTable
vRtrIsisIfTypeDefault

page 25-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis vlan level hello-auth-type

ip isis vlan level hello-auth-type

Configures the authentication of Hello PDUs for the specified IS-IS level of an IS-IS Circuit.
ip isis vlan vlan-id level {1 | 2} hello-auth-type {simple {key key | encrypt-key encrypt-key} | md5 {key
key | encrypt-key encrypt-key} | none}

Syntax Definitions

vlan-id The VLAN ID of a given VLAN.

1 Specifies the IS-IS level as Level-1.
2 Specifies the IS-IS level as Level-2.
simple Simple authentication will be used.
md5 Specifies that MD5 authentication algorithm will be used. Hash-key will
be used in MD5 authentication.
key Key will be plain text ASCII up to 118 characters. Use quotes around
string if the key contains multiple words with spaces between them.
encrypt-key The key in hexadecimal format to provide security consideration on the
authentication key. Configuration snapshot always displays authentica-
tion key in the encrypted form.
none No authentication will be used.

Defaults

parameter default
simple | md5 | none none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Simple authentication uses only a text string as the password in the packet. This helps to protect the
routers from a configuration mishap. MD5 authentication is used to protect the system from malicious
actions.
• MD5 authentication is used to encrypt the information that is sent over the network. MD5 authentica-
tion uses shared secret key. The Key is used to sign the packets with an MD5 checksum to sign the
packet, so that the packets cannot be tampered. As the key is not included in the packet, snooping the
key is not possible.
• Use the Key parameter to configure the password for Simple or MD5 authentication. Alternatively, use
the encrypt-key parameter to configure the password by supplying the encrypted form of the password
as the encrypt-key. The Configuration snapshot always displays the password in the encrypted form.
You should use only this key parameter during the CLI configuration.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-47
ip isis vlan level hello-auth-type IS-IS Commands

• If the encrypt-key parameter is used to configure the password through the CLI, then its value should
be the same as the one that appears in the configuration snapshot. Only valid system generated values
are accepted as encrypt-key.
• This command also configures the authentication type and the corresponding key. These settings over-
ride the configuration done at an interface level.
• By default, the authentication is disabled and no authentication type is configured.

Examples
-> ip isis vlan 10 level 1 hello-auth-type md5 key xyz123
-> ip isis vlan 10 level 2 hello-auth-type none

Release History
Release 8.1.1; command introduced.

Related Commands

ip isis vlan hello-auth-type Configures the authentication settings for the hello protocol at a circuit
level.
show ip isis vlan Displays the IS-IS IPv4 and IPv6 interface information on a VLAN in
the IS-IS database.

MIB Objects
vRtrIsisIfLevelTable
vRtrIsisIfLevelHelloAuthType
vRtrIsisIfLevelHelloAuthKey

page 25-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis vlan level hello-interval

ip isis vlan level hello-interval

Configures the time interval between the successive Hello PDUs for the specified IS-IS level on a circuit.
ip isis vlan vlan-id level {1 | 2} hello-interval seconds
no ip isis vlan vlan-id level {1 | 2} hello-interval

Syntax Definitions

vlan-id The VLAN ID of a given VLAN.

seconds The hello interval, in seconds. The valid range is 1–20000.

Defaults

parameter default
seconds (designated routers) 3
seconds 9
(non-designated routers)

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to restore the default settings.

Examples
-> ip isis vlan 10 level 1 hello-interval 50
-> no isis vlan 10 level 2 hello-interval

Release History
Release 8.1.1; command introduced.

Related Commands

show ip isis vlan Displays the IS-IS IPv4 and IPv6 interface information on a VLAN in
the IS-IS database.

MIB Objects
vRtrIsisIfLevelTable
vRtrIsisIfLevelHelloTimer

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-49
ip isis vlan level hello-multiplier IS-IS Commands

ip isis vlan level hello-multiplier

Configures the number of missing Hello PDUs from a neighbor, after which the adjacency is declared as
down.
ip isis vlan vlan-id level {1 | 2} hello-multiplier number
no ip isis vlan vlan-id level {1 | 2} hello-multiplier

Syntax Definitions

vlan-id The VLAN ID of a given VLAN.

number The multiplier (2–100) of the hello interval.

Defaults

parameter default
number 3

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to restore the default settings.

Examples
-> ip isis vlan 10 level 1 hello-multiplier 10
-> no ip isis vlan 10 level 2 hello-multiplier

Release History
Release 8.1.1; command introduced.

Related Commands

show ip isis vlan Displays the IS-IS IPv4 and IPv6 interface information on a VLAN in
the IS-IS database.

MIB Objects
isisCircLevelTable
isisCircLevelHelloMultiplier

page 25-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis vlan level metric

ip isis vlan level metric

Configures the metric value of the specified IS-IS level of the circuit.
ip isis vlan vlan-id level {1 | 2} metric number
no ip isis vlan vlan-id level {1 | 2} metric

Syntax Definitions

vlan-id The VLAN ID of a given VLAN.

1 Specifies the IS-IS level as Level-1.
2 Specifies the IS-IS level as Level-2.
number The metric value (0–16777215) assigned for the specified level of the
circuit. If metric value is set to 0, metric will be set to the default value.

Defaults

parameter default
number 10

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to restore the default value.

• To calculate the lowest cost to reach a destination, each configured level on each circuit must have a
cost. The costs for each level on a circuit may be different. If the metric is not configured, the default
of 10 is used.

Examples
-> ip isis vlan 10 level 1 metric 25
-> no ip isis vlan 10 level 2 metric

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-51
ip isis vlan level metric IS-IS Commands

Related Commands

show ip isis vlan Displays the IS-IS IPv4 and IPv6 interface information on a VLAN in
the IS-IS database.

MIB Objects
vRtrIsisIfLevelTable
vRtrIsisIfLevelAdminMetric

page 25-52 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis vlan level passive

ip isis vlan level passive

Configures the IS-IS circuit as passive at the specified IS-IS level.
ip isis vlan vlan-id level {1 | 2} passive
no ip isis vlan vlan-id level {1 | 2} passive

Syntax Definitions

vlan-id The VLAN ID of a given VLAN.

1 Specifies the IS-IS level as Level-1.
2 Specifies the IS-IS level as Level-2.

Defaults
By default, the interface level passive configuration is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the passive attribute.

• This command adds the passive attribute that causes the IS-IS circuit at the given level to be advertised
as an IS-IS circuit without running the IS-IS protocol. Normally, only interface addresses that are
configured for IS-IS are advertised as IS-IS interface at the level that they are configured. When the
passive mode is enabled, the interface or the interface at the level ignores ingress IS-IS protocol PDUs
and will not transmit IS-IS protocol PDUs.

Examples
-> ip isis vlan 10 level 1 passive
-> no ip isis vlan 10 level 1 passive

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-53
ip isis vlan level passive IS-IS Commands

Related Commands

ip isis vlan passive Configures the IS-IS circuit as passive.

show ip isis vlan Displays the IS-IS IPv4 and IPv6 interface information on a VLAN
in the IS-IS database.

MIB Objects
vRtrIsisIfLevelTable
vRtrIsisIfLevelPassive

page 25-54 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis vlan level priority

ip isis vlan level priority

Configures the priority of the IS-IS circuit for the designated router election on a multi-access network.
ip isis vlan vlan-id level [1 | 2] priority number
no ip isis vlan vlan-id level [1 | 2] priority

Syntax Definitions

vlan-id The VLAN ID of a given VLAN.

1 Specifies the IS-IS level as Level-1.
2 Specifies the IS-IS level as Level-2.
number The priority value of the IS-IS circuit at this level. The valid range is 0–
127.

Defaults

parameter default
number 64

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to restore the default value.

• This priority is included in hello PDUs transmitted by the circuit on a multi-access network.

• The router with the highest priority is the preferred designated router.

• The designated router sends LSPs to this network and also to the routers that are attached to it.

Examples
-> ip isis vlan 10 level 1 priority 4
-> ip isis vlan 10 level 2 priority 4
-> no ip isis vlan 10 level 1 priority

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-55
ip isis vlan level priority IS-IS Commands

Related Commands

show ip isis vlan Displays the IS-IS IPv4 and IPv6 interface information on a VLAN in
the IS-IS database.

MIB Objects
vRtrIsisIfLevelTable
vRtrIsisIfLevelISPriority

page 25-56 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands ip isis summary-address6

ip isis summary-address6
Configures the IPv6 summary address.
ip isis summary-address6 {ipv6-prefix/prefix-length | ipv6-address} {level-1 | level-2 | level-1/2}
no ip isis summary-address6 {ipv6-prefix/prefix-length | ipv6-address} {level-1 | level-2 | level-1/2}

Syntax Definitions

ipv6-prefix/prefix-length IPv6 prefix and prefix length.

ipv6-address IPv6 address.
level-1 Specifies that the routes can be summarized at Level-1 only.
level-2 Specifies that the routes can be summarized at Level-2 only.
level-1/2 Specifies that the routes can be summarized at Level-1 and at Level-2.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to remove an already configured summary address.

Examples
-> ip isis summary-address6 4001::/16 level-1
-> no ip isis summary-address6 4001::/16

Release History
Release 8.1.1; command introduced.

Related Commands

show ip isis summary-address6 Displays the IS-IS IPv6 summary address database.

MIB Objects
vRtrIsisInetSummLevel
vRtrIsisInetSummRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-57
show ip isis adjacency IS-IS Commands

show ip isis adjacency

Displays information about IS-IS adjacent routers.
show ip isis adjacency [system-id nbr_sys_id | vlan vlan-id] [detail]

Syntax Definitions

nbr_sys_id The system ID of the neighbor router.

vlan-id The VLAN ID of a given VLAN.
detail Indicates that the output is displayed in a detailed manner.

Defaults
By default adjacency information for all the neighbor routers are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the nbr_sys_id or vlan-id parameter with this command to view the adjacency information for a
specific neighbor.

Examples
-> show ip isis adjacency
=================================================================================
ISIS Adjacency
=================================================================================
System ID Type State Hold VlanID MT IDs Hostname
---------------------------------------------------------------------------------
0000.0000.0001 L1 UP 25 20 0, 2 Router-A
0000.0000.0002 L2 UP 21 30 None Router-B
---------------------------------------------------------------------------------
Adjacency : 2
=================================================================================

output definitions
System ID The system ID of the adjacent router. The system ID is a fixed size, six
octet field in the NSAP. In an IS-IS routing domain, each router is iden-
tified by a 6-octet hexadecimal system ID.
Type The level (LI, L2, or L1/L2) of the adjacent router.
State The state of the adjacent router (Up or Down).
Hold The Hold time of the adjacent router.
VlanID The VLAN ID of the adjacent router.
MT IDs MT IDs sent by MT enabled ISIS neighbour. '0' signifies the IPv4 sup-
port, '2' signifies IPv6 support, 'none' signifies MT disabled neighbour.

page 25-58 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands show ip isis adjacency

output definitions
Hostname The host name of the adjacent router.
Adjacencies The total number of adjacent routers.

-> show ip isis adjacency detail

============================================================================
ISIS adjacency
============================================================================
-------------------------------------------------------------------------
SystemID : 0000.0000.0001 SNPA : 00:d0:95:f3:0f:08
VlAN : 20 Up Time : WED JUN 05 05:18:51 2013
State : UP Priority : 64
Nbr Sys Type : L2 L.CircType : L1L2
Hold Time : 6 Max Hold : 9
Adj Level : L2 Host-name : Router-A
MT IDs : 0, 2 NLPIDs : IPv4, IPv6
IPv4 Neighbor : 2.2.2.3
Ipv6 Neighbor : FE80::C809:FFF:FEDC:0
Restart Support : Disabled
Restart Status : Not currently being helped
Restart Suppressed : Disabled

----------------------------------------------------------------------------
SystemID : 0000.0000.0002 SNPA : 00:d0:95:f3:0f:08
VlAN : 10 Up Time : WED JUN 05 05:18:51 2013
State : UP Priority : 64
Nbr Sys Type : L1 L.CircType : L1L2
Hold Time : 6 Max Hold : 9
Adj Level : L2 Host-name : Router-B
MT IDs : None NLPIDs : IPv4
IPv4 Neighbor : 2.2.2.3
Ipv6 Neighbor : FE80::C809:AFF:FEEC:0
Restart Support : Disabled
Restart Status : Not currently being helped
Restart Suppressed : Disabled
----------------------------------------------------------------------------
Adjacency : 2
============================================================================

output definitions
SystemID The system ID of the adjacent router. The system ID is a fixed size, six
octet field in the NSAP. In an IS-IS routing domain, each router is iden-
tified by a 6-octet hexadecimal system ID.
VLAN The Vlan ID in which the adjacency is present.
MT IDs MT IDs sent by MT enabled ISIS neighbour. '0' signifies the IPv4 sup-
port, '2' signifies IPv6 support, 'none' signifies MT disabled neighbour.
NLPIDs The IP address families supported by IS-IS neighbor: IPv4 or IPv6
State The state of the adjacent router (Up or Down).
Adj Level The adjacency level (L1 or L2) of the router.
Nbr Sys Type The type of the neighboring router(L1, L2 or L1L2)
Hold Time The Hold time of the adjacent router.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-59
show ip isis adjacency IS-IS Commands

output definitions
IPv4 Neighbor The 32-bit IP address of the neighbor.
IPv6 Neighbor The 32-bit IPv6 address of the neighbor
Restart Support Indicates if graceful restart is enabled or disabled.
Restart Status Indicates whether the router is currently helping an adjacent router to
restart.
Restart Suppressed Indicates whether the advertisement of LSPs are suppressed (enabled)
or not (disabled) as per the request of adjacent router.
SNPA The SNPA address of the adjacent router.
Up Time Indicates the time period in seconds, during which the router was in the
adjacency.
Priority The priority of the adjacent router.
Host-name The host name of the adjacent router.
L. CircType Indicates the level circuit type (L1, L2 or L1L2) of the adjacent router.
Max Hold Indicates the maximum Hold time of the adjacent router.

Release History
Release 8.1.1; command introduced.

Related Commands

clear ip isis adjacency Clears and resets the IS-IS adjacency database.

MIB Objects
isisISAdjTable
isisISAdjIndex
isisISAdjState
isisISAdjNeighSNPAAddress
isisISAdjNeighSysType
isisISAdjNeighSysID
isisISAdjUsage
isisISAdjNeighPriority
isisISAdjUpTime
isisISAdjHoldTimer
vRtrIisisISAdjTable
vRtrIsisISAdjCircLevel
vRtrIsisISAdjRestartSupport
vRtrIsisISAdjRestartSupressed
vRtrIsisISAdjExpireIn
vRtrIsisISAdjNeighborIP
vRtrIsisISAdjRestartStatus
vRtrIsisISAdjMTIdMask

page 25-60 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands show ip isis database

show ip isis database

Displays IS-IS LSP database information of the adjacent routers.
show ip isis database [system_id system_id | lsp_id lsp_id] [detail] [level {1 | 2}]

Syntax Definitions

system_id The system ID of the router.

lsp_id The LSP ID.
detail Indicates that the output is displayed in a detailed manner.
level Indicates the IS-IS level, either 1 or 2.

Defaults
By default the entire LSP database is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use system-id or lsp-id parameter with this command to view specific LSP database information.

• Use the level parameter with this command to view the LSP database information of a particular level.

Examples
-> show ip isis database
Legends : P = The Partition repair bit is set
OV = The overload bit is set
ATT = The Attach bit is set
L1 = Specifies a Level 1 IS type
L2 = Specifies a Level 2 IS type
=================================================================
ISIS Database
=================================================================
LSP ID Sequence Checksum Lifetime Attributes
------------------------------------------------------------------
Displaying level-1 database
------------------------------------------------------------------
1720.2116.0051.00-00 0x44 0xb664 919 L1L2
level-1 LSP count : 1

Displaying level-2 database

------------------------------------------------------------------
1720.2116.0051.00-00 0x45 0xb465 1083 L1L2
level-2 LSP count : 1
=====================================================================

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-61
show ip isis database IS-IS Commands

output definitions
LSP ID The LSP ID. Indicates the system ID and the pseudo-node ID of the
originating router.
Sequence The sequence number of the LSP. The sequence number is a value used
to identify old and duplicate LSPs.
Checksum The checksum value of the LSP.
Lifetime The number of seconds the LSP remains valid. The LSP lifetime value
of zero indicates that this LSP is being removed from the Link State
Database of all the routers.
Attributes The level capability of the router.
LSP Count The number of LSPs in the Link State Database.

-> show ip isis database detail

Legends : P = The Partition repair bit is set
OV = The overload bit is set
ATT = The Attach bit is set
L1 = Specifies a Level 1 IS type
L2 = Specifies a Level 2 IS type
==================================================================
ISIS Database
==================================================================
Displaying level-1 database
------------------------------------------------------------------
LSP ID : 1720.2116.0051.00-00 Level : L1
Sequence : 0x44 Checksum : 0xb664 Lifetime : 818
Version : 1 Pkt Type : 18 Pkt Ver : 1
Attributes : L1L2 Max Area : 3
SysID Len : 6 Used Len : 635 Alloc Len : 1489

TLVs :
Area Addresses :
Area Address : (3) 49.0000
Supp protocols :
Protocols : Ipv4 , Ipv6
IS-Hostname :
Hostname : HostA
IS Neighbors :
Virtual Flag : 0
Neighbor : 1720.2116.0052.00 Metric : 10 (I)
IPv4 I/F Address :
IP Address : 172.21.160.51
IP Address : 172.21.160.52
IPv6 I/F Address :
IPv6 Address : 2001:1::1
IPv6 Address : 3001:1::1
IPv4 Internal Reach :
IP Prefix : 16.16.16.0/24 (Dir.: UP ) Metric : 10 (I)
IP Prefix : 17.17.17.0/24 (Dir.: UP ) Metric : 10 (I)
IPv4 External Reach :
IP Prefix : 24.24.24.0/24 (Dir.: UP ) Metric : 10 (E)
IP Prefix : 25.25.25.0/24 (Dir.: UP ) Metric : 10 (E)
IPv6 Reach. :
IPv6 Prefix : 2001:1::/64
Flags : Up Internal Metric : 10
IPv6 Prefix : 3001:1::/64

page 25-62 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands show ip isis database

Flags : Up Internal Metric : 10

IPv6 Prefix : 4001:1::/64
Flags : Up Internal Metric : 10
TE IP Reach. :
IPv4 Prefix : 11.1.1.0/24 (Dir.:Up) Metric : 10
IPv4 Prefix : 22.1.1.0/24 (Dir.:Up) Metric : 10
IPv4 Prefix : 21.1.1.0/24 (Dir.:Up) Metric : 10
IPv4 Prefix : 10.135.38.0/24 (Dir.:Up) Metric : 1

level-1 LSP count : 1

Displaying level-2 database

------------------------------------------------------------------
LSP ID : 1720.2116.0051.00-00 Level : L2
Sequence : 0x45 Checksum : 0xb465 Lifetime : 981
Version : 1 Pkt Type : 20 Pkt Ver : 1
Attributes : L1L2 Max Area : 3
SysID Len : 6 Used Len : 635 Alloc Len : 1489

TLVs :
Area Addresses :
Area Address : (3) 49.0000
Supp protocols :
Protocols : Ipv4 Ipv6
IS-Hostname :
Hostname : HostA
IS Neighbors :
Virtual Flag : 0
Neighbor : 1720.2116.0052.00 Metric : 10 (I)
IPv4 I/F Address :
IP Address : 172.21.160.51
IP Address : 172.21.160.52
IPv6 I/F Address :
IPv6 Address : 2001:1::1
IPv6 Address : 3001:1::1
IPv4 Internal Reach :
IP Prefix : 16.16.16.0/24 (Dir.: UP ) Metric : 10 (I)
IP Prefix : 17.17.17.0/24 (Dir.: UP ) Metric : 10 (I)
IPv4 External Reach :
IP Prefix : 24.24.24.0/24 (Dir.: UP ) Metric : 10 (E)
IP Prefix : 25.25.25.0/24 (Dir.: UP ) Metric : 10 (E)
IPv6 Reach. :
IPv6 Prefix : 3001:1::/64
Flags : Up Internal Metric : 10
TE IP Reach. :
IPv4 Prefix : 21.1.1.0/24 (Dir.:Up) Metric : 10
IPv4 Prefix : 10.135.38.0/24 (Dir.:Up) Metric : 1
IPv4 Prefix : 11.1.1.0/24 (Dir.:Up) Metric : 1

level-2 LSP count : 1

==================================================================

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-63
show ip isis database IS-IS Commands

page 25-64 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands show ip isis database

output definitions
LSP ID The LSP ID. Indicates the system ID and the pseudo-node ID of the
originating router.
Sequence The sequence number of the LSP. The Sequence number is a value used
to identify old and duplicate LSPs.
Checksum The checksum value of the LSP.
Lifetime The number of seconds the LSP remains valid. The LSP lifetime value
of zero indicates that this LSP is being removed from the Link State
Database of all the routers.
Version The version of the IS-IS protocol that has generated the LSP.
Pkt Type The IS-IS PDU type number derived from the PDU header, which can be
18 or 20. The number 18 represents L1 LSP PDU type and 20 represents
L2 LSP PDU type.
Pkt Ver The version of the IS-IS protocol that has generated the packet.
Attributes The level capability of the router.
Max Area The Maximum number of areas supported by the originating router of the
LSP.
SysID Len The length of the system-id as used by the originating router.
Used Len The length used by the LSP.
Alloc Len The length allocated for the LSP to be stored.
Area Address The area ID of the router.
Supp protocols The network layer protocols that are supported.
IS-Host Name The host name of the router.
System ID The system ID of the adjacent router. The system ID is a fixed size, six
octet field in the NSAP. In an IS-IS routing domain, each router is iden-
tified by a 6-octet hexadecimal system ID.
IS Neighbors The list of reachable IS-IS neighbors.
IPv4 Internal Reach The list of IS-IS internal routes.
IPv6 Reach The list of IS-IS IPv6 internal routes.
IP Prefix The IP address and subnet mask of the destination.
Metrics The metric value to reach the destination.
IPv4 External Reach The list of external IS-IS routes.
IPv6 Reach The list of external IS-IS IPv6 routes.
level-1 LSP Count The number of Level-1 LSPs.
level-2 LSP Count The number of Level-2 LSPs.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-65
show ip isis database IS-IS Commands

Related Commands

show ip isis hostname Displays the database of IS-IS host name and its corresponding system
ID.
clear ip isis lsp-database Clears and resets the IS-IS LSP database information.

MIB Objects
vRtrIsisLSPTable
vRtrIsisLSPId
vRtrIsisLSPSeq
vRtrIsisLSPChecksum
vRtrIsisLSPLifetimeRemain
vRtrIsisLSPAttributes
vRtrisisLSPVersion
vRtrIsisLSPPktType
vRtrIsisLSPSysIdLen
vRtrIsisLSPAllocLen
vRtrIsisLSPMaxArea
vRtrIsisLSPBuff
vRtrisisLSPUsedLen

page 25-66 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands show ip isis hostname

show ip isis hostname

Displays the database of IS-IS host name and its corresponding system ID.
show ip isis hostname

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip isis hostname
Hosts
=========================================================================
System Id Hostname
-------------------------------------------------------------------------
1800.0000.0002 core_west
1800.0000.0005 core_east
1800.0000.0008 asbr_west
1800.0000.0009 asbr_east
1800.0000.0010 abr_sjc
1800.0000.0011 abr_lax
1800.0000.0012 abr_nyc
1800.0000.0013 abr_dfw
1800.0000.0015 dist_oak
1800.0000.0018 dist_nj
1800.0000.0020 acc_nj
1800.0000.0021 acc_ri
1800.0000.0027 dist_arl
1800.0000.0028 dist_msq
1800.0000.0029 acc_arl

output definitions
System Id The system ID of the router. The system ID is a fixed size, six octet
field in the NSAP. In an IS-IS routing domain, each router is identified by
a 6-Octet hexadecimal system ID.
Hostname The host name of the router.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-67
show ip isis hostname IS-IS Commands

Release History
Release 8.1.1; command introduced.

Related Commands

show ip isis adjacency Displays information about IS-IS adjacent routers.

show ip isis database Displays IS-IS LSP database information of the adjacent routers
ip isis area-id Configures the area ID for the router.

MIB Objects
vRtrIsisHostnameTable
vRtrIsisSysID
vRtrIsisHostname

page 25-68 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands show ip isis routes

show ip isis routes

Displays the IS-IS route information from the routing table.
show ip isis routes

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip isis routes
=================================================================================
ISIS Routes
=================================================================================
Prefix Metric Lvl/Type SPF-num Nexthop System ID
---------------------------------------------------------------------------------
1.1.1.0/24 10 1/Int 7 0.0.0.0 1720.2116.0051
2.2.2.0/24 10 1/Int 1 0.0.0.0 1720.2116.0051
3.3.3.0/24 10 1/Int 1 0.0.0.0 1720.2116.0051
4.4.4.0/24 10 1/Int 1 0.0.0.0 1720.2116.0051
5.5.5.0/24 10 1/Int 1 0.0.0.0 1720.2116.0051
6.6.6.0/24 10 1/Int 1 0.0.0.0 1720.2116.0051
---------------------------------------------------------------------------------
Routes : 8
=================================================================================

output definitions
Prefix The IP prefix and mask of the destination routes.
Metric The cost to reach the destination route.
Lvl/Type The level and route type of the routes.
SPF-num The version of the SPF calculation used to select the route.
Nexthop The Next Hop address to reach the destination.
System ID The system ID of the adjacent router. The system ID is a fixed size, six
octet field in the NSAP. In an IS-IS routing domain, each router is iden-
tified by a 6-octet hexadecimal system ID.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-69
show ip isis routes IS-IS Commands

Release History
Release 8.1.1; command introduced.

Related Commands
N/A

MIB Objects
vRtrIsisRouteTable
vRtrIsisRouteLevel
vRtrIsisRouteSpfVersion
vRtrIsisRouteType
vRtrisisRouteDest
vRtrIsisRouteNexthopIP
vRtrIsisRouteNexthopSysID
vRtrIsisRouteMetric
vRtrIsisRouteMask

page 25-70 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands show ip isis routes6

show ip isis routes6

Displays the IS-IS IPv6 route information from the routing table.
show ip isis routes6

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip isis routes6
===================================================================================
ISISv6 Routes
===================================================================================
Prefix Metric Lvl/Type Vlan-Id Nexthop System ID
-----------------------------------------------------------------------------------
2001:1::/64 10 1/Int 6 :: 0300.0100.1001
3001:1::/64 10 1/Int 11 :: 0300.0100.1001
4001:1::/64 10 1/Int 6 :: 0300.0100.1001
5001:1::/64 20 1/Int 6 fe80::213:c3ff:fe9a:2761 0000.0000.0001
-----------------------------------------------------------------------------------
Routes : 4
===================================================================================

output definitions
Prefix The IP prefix and mask of the IPv6 destination routes.
Metric The cost to reach the destination route.
Lvl/Type The level and route type of the routes.
SPF-num The version of the SPF calculation used to select the route.
Nexthop The Next Hop address to reach the destination.
System ID The system ID of the adjacent router. The system ID is a fixed size, six
octet field in the NSAP. In an IS-IS routing domain, each router is iden-
tified by a 6-octet hexadecimal system ID.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-71
show ip isis routes6 IS-IS Commands

Related Commands
N/A

MIB Objects
N/A

page 25-72 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands show ip isis spf

show ip isis spf

Displays the IS-IS SPF calculation information.
show ip isis spf [detail]

Syntax Definitions

detail Indicates that the output is displayed in a detailed manner.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The SPF path table is common for both IPv4 and IPv6.

Examples
-> show ip isis spf
============================================================
ISIS Path Table
============================================================
Node VlanId Nexthop
------------------------------------------------------------
0000.0000.0001.00 6 0000.0000.0001
------------------------------------------------------------
SPF count: 1
====================================================================

output definitions
Node The system ID of the routers.
VlanId The VLAN ID.
Nexthop The system ID of the Next Hop router.

-> show ip isis spf detail

==================================================================
ISIS Path Table
==================================================================
------------------------------------------------------------------
Node : 0000.0000.0001.00 Metric : 10
VlanId : 6 SNPA : None
Nexthop : 0000.0000.0001
------------------------------------------------------------
SPF count: 1
===========================================================================

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-73
show ip isis spf IS-IS Commands

output definitions
Node The system ID of the routers.
Metric The metric value used for SPF calculations.
VlanId The VLAN ID.
SNPA The SNPA address of the router.
Nexthop The system ID of the Next Hop router.
SPF count The number of SPF calculations done by the router.

Release History
Release 8.1.1; command introduced.

Related Commands

show ip isis spf-log Displays the IS-IS SPF log.

show ip isis status Displays the IS-IS status.

MIB Objects
vRtrIsisPathTable
vRtrIsisPathID
vRtrIsisPathIfIndex
vRtrIsisPathNHopSysID
vRtrIsisPathMetric
vRtrIsisPathSNPA

page 25-74 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands show ip isis spf-log

show ip isis spf-log

Displays the IS-IS SPF log.
show ip isis spf-log [detail]

Syntax Definitions

detail Indicates that the output is displayed in a detailed manner.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays the last 20 IS-IS SPF events.

Examples
-> show ip isis spf-log
ISIS SPFLog
==============================================================================
When Duration L1-Nodes L2-Nodes Event-Count
-------------------------------------------------------------------------------
01/30/2005 11:01:54 <0.01s 1 1 3
-------------------------------------------------------------------------------
Log Entries : 1

output definitions
When The date on which the SPF calculation was completed.
Duration The time duration of the event.
L1-Nodes The number of Level-1 nodes.
L2-Nodes The number of Level-2 nodes.
Event-Count The number of SPF calculations.
Log Entries The total number of log entries.

-> show ip isis spf-log detail

=============================================================================
ISIS SPFLog
=============================================================================
SpfTimeStamp : SUN OCT 01 05:15:29 2006
spfRunTime : 0
Spf Involved L1 Nodes : 69
Spf Involved L2 Nodes : 71
Spf Event-count : 169
Last TriggeredLspId : 0020.0200.2001.00-4a

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-75
show ip isis spf-log IS-IS Commands

Spf Trigger Reason : newAdjacency(0) ,lspExpired(8) ,lspChanged(10)

SpfTimeStamp : SUN OCT 01 05:15:46 2006
spfRunTime : 0
Spf Involved L1 Nodes : 72
Spf Involved L2 Nodes : 72
Spf Event-count : 227
Last TriggeredLspId : 0020.0200.2001.00-4a
Spf Trigger Reason : newAdjacency(0) ,lspExpired(8) ,lspChanged(10)
----------------------------------------------------------------------------
Log Entries : 2
============================================================================

output definitions
SpfTimeStamp The timestamp when the SPF run started on the system.
spfRunTime The time (in hundredths of a second) required to complete the SPF run.
Spf Involved L1 Nodes The number of Level-1 nodes involved in the SPF calculation.
Spf Involved L1 Nodes The number of Level-2 nodes involved in the SPF calculation.
Spf Event-count The number of SPF events that triggered the SPF calculation.
Last TriggeredLspId The LSP ID of the last LSP processed before the SPF run.
Spf trigger Reason Indicates the reasons (newAdjacency, lspExpired, or lspChanged) for
SPF calculations.
Log Entries The number of SPF logs.

Release History
Release 8.1.1; command introduced.

Related Commands

show ip isis spf Displays the IS-IS SPF calculation information.

clear ip isis spf-log Clears and resets the IS-IS SPF log information.

MIB Objects
vRtrIsisSpfLogTable
vRtrIsisSpfRunTime
vRtrIsisSpfL1Nodes
VRtrIsisSpfL2Nodes
vRtrIsisSpfEventCount
vRtrIsisSpfLastTriggerLSPId
vRtrIsisSpfTriggerReason

page 25-76 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands show ip isis statistics

show ip isis statistics

Displays the IS-IS statistics information.
show ip isis statistics

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip isis statistics
=========================================================================
ISIS Statistics
==============================================================================
ISIS Instance : 1 SPF Runs : 44
Purge Initiated : 0 LSP Regens : 54
CSPF Statistics
Requests : 0 Request Drops : 0
Paths Found : 0 Paths Not Found : 0
-------------------------------------------------------------------------------
PDU Type Received Processed Dropped Sent Retransmitted
-------------------------------------------------------------------------------
LSP 185 184 1 54 0
IIH 8382 8382 0 2796 0
CSNP 3352 352 0 0 0
PSNP 0 0 0 4 0
Unknown 0 0 0 0 0

output definitions
ISIS Instance The number of IS-IS instances.
SPF Runs The number of SPF calculations that have been performed.
Purge Initiated The number of purges that the system initiated. A purge is initiated if
the router decides that a link-state PDU must be removed from the data-
base.
LSP Regens The number of LSPs that have been regenerated. An LSP is regenerated
when it nears the end of its lifetime and has not changed.
Requests The number of CSNP requests received.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-77
show ip isis statistics IS-IS Commands

output definitions (continued)

Request Drops The number of CSNP requests that are dropped.
Paths Found The number of paths found.
Paths Not Found The number of paths not found.
PDU Type The type of PDU.
Received The number of PDUs received since IS-IS started or since the statistics
were set to zero.
Processed The number of PDUs that are processed (number of PDUs received less
the number dropped).
Dropped The number of PDUs that are dropped.
Sent The number of PDUs transmitted since IS-IS started or since the statis-
tics were set to zero.
Retransmitted The number of PDUs that are retransmitted.

Release History
Release 8.1.1; command introduced.

Related Commands

clear ip isis statistics Clears and resets the IS-IS statistics information.

page 25-78 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands show ip isis statistics

MIB Objects
vRtrIsisStatsTable
vRtrIsisSpfRuns
vRtrIsisLSPRegenerations
vRtrIsisInitiatedPurges
vRtrIsisLSPRecd
vRtrIsisLSPDrop
vRtrIsisLSPSent
vRtrIsisLSPRetrans
vRtrIsisIIHRecd
vRtrIsisIIHDrop
vRtrIsisIIHSent
vRtrIsisIIHRetrans
vRtrIsisCSNPRecd
vRtrIsisCSNPDrop
vRtrIsisCSNPSent
vRtrIsisCSNPRetrans
vRtrIsisPSNPRecd
vRtrIsisPSNPDrop
vRtrIsisPSNPSent
vRtrIsisPSNPRetrans
vRtrIsisUnknownRecd
vRtrIsisUnknownDrop
vRtrIsisUnknownSent
vRtrIsisUnknownRetrans
vRtrIsisCSPFRequests
vRtrIsisCSPFDroppedRequests
vRtrIsisCSPFPathsFound
vRtrIsisCSPFPathsNotFound

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-79
show ip isis status IS-IS Commands

show ip isis status

Displays the IS-IS status.
show ip isis status

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip isis status
==========================================================
ISIS Status
==========================================================
System Id : 0050.0500.5001
Admin State : UP
Protocols Enabled : IPv4, IPv6
Last Enabled : Mon Jul 27 13:37:19 2015
Level Capability : L1L2
Authentication Check : True
Authentication Type : None
Graceful Restart : Disabled
GR helper-mode : Disabled
LSP Lifetime : 1200
LSP Wait : Max :5 sec, Initial :0 sec, Second :1 sec
Adjacency Check : Loose
L1 Auth Type : None
L2 Auth Type : None
L1 Wide Metrics-only : Disabled
L2 Wide Metrics-only : Disabled
L1 LSDB Overload : Disabled
L2 LSDB Overload : Disabled
L1 LSPs : 177
L2 LSPs : 177
Last SPF : FRI OCT 26 05:04:09 2007
SPF Wait : Max :10000 ms, Initial :1000 ms, Second :1000 ms
Hello-Auth Check : Enabled
Csnp-Auth Check : Enabled
Psnp-Auth Check : Enabled
L1 Hello-Auth Check : Enabled
L1 Csnp-Auth Check : Enabled

page 25-80 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands show ip isis status

L1 Psnp-Auth Check : Enabled

L2 Hello-Auth Check : Enabled
L2 Csnp-Auth Check : Enabled
L2 Psnp-Auth Check : Enabled
Multi-topology : Enabled
Auto-Configuration : Disabled
Area Address : 49.0000
===========================================================

output definitions
System Id The system ID of the router. The system ID is a fixed size, six octet
field in the NSAP. In an IS-IS routing domain, each router is identified
by a 6-octet hexadecimal system ID.
Admin State The state of the router (Up or Down).
Protocols Enabled The protocol enabled on the router: IPv4 or IPv6
Last Enabled The date and time when the router is enabled.
Level Capability The level capability of the router (L1, L2, or L1L2).
Authentication Check Indicates the status of the authentication (true or false).
Authentication Type The type of authentication (password or md5).
Graceful Restart Indicates if graceful restart is Enabled or Disabled.
GR helper-mode Indicates if the helper mode of graceful restart is Enabled or Disabled.
LSP Lifetime The Lifetime of the LSP (in seconds).
LSP Wait The Wait time of the LSP (in seconds).
Adjacency Check The adjacency check configuration on the router
L1 Auth Type The authentication type (password or md5) for Level-1 adjacency.
L2 Auth Type The authentication type (password or md5) for Level-2 adjacency.
L1 Wide Metrics-only Indicates whether wide metrics is Enabled or Disabled for Level-1
adjacency.
L2 Wide Metrics-only Indicates whether wide metrics is Enabled or Disabled for Level-2
adjacency.
L1 LSDB Overload Indicates whether LSDB Overload is Enabled or Disabled for Level-1
adjacency.
L2 LSDB Overload Indicates whether LSDB Overload is Enabled or Disabled for Level-2
adjacency.
L1 LSPs The number of LSPs for Level-1 adjacency.
L2 LSPs The number of LSPs for Level-2 adjacency.
Last SPF The date and duration of the last SPF calculation.
SPF Wait The Wait time for the SPF calculation.
Hello-Auth Check Indicates the status of global Hello authentication check (Enabled or
Disabled).
Csnp-Auth Check Indicates the status of global CSNP authentication check (Enabled or
Disabled).
Psnp-Auth Check Indicates the status of global PSNP authentication check (Enabled or
Disabled).

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-81
show ip isis status IS-IS Commands

output definitions (continued)

L1 Hello-Auth Check Indicates the status of L1 Hello authentication check (Enabled or Dis-
abled).
L1 Csnp-Auth Check Indicates the status of L1 CSNP authentication check (Enabled or Dis-
abled).
L1 Psnp-Auth Check Indicates the status of L1 PSNP authentication check (Enabled or Dis-
abled).
L2 Hello-Auth Check Indicates the status of L2 Hello authentication check (Enabled or Dis-
abled).
L2 Csnp-Auth Check Indicates the status of L2 CSNP authentication check (Enabled or Dis-
abled).
L2 Psnp-Auth Check Indicates the status of L2 PSNP authentication check (Enabled or Dis-
abled).
Multi-Topology Indicates the status of multi-topology capability support for IS-IS
(Enabled or Disabled).
Auto-Configuration Indicates if IS-IS instance is enabled or disabled through auto configu-
ration.
Area Address The area address of the router.

Release History
Release 8.1.1; command introduced.

Related Commands

show ip isis statistics Displays IS-IS statistics information.

page 25-82 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands show ip isis status

MIB Objects
vRtrIsisTable
vRtrIsisLastEnabledTime
vRtrIsisAuthKey
vRtrIsisAuthType
vRtrIsisLspLifetime
vRtrIsisOverloadTimeout
vRtrIsisLastSpfRun
vRtrIsisGracefulRestart
vRtrIsisOverloadOnBootv
vRtrIsisOverloadOnBootimeout
vRtrIsisSpfWait
vRtrIsisSpfInitialWait
vRtrIsisSpfSecondWait
vRtrIsisLspMaxWait
vRtrIsisLspInitialWait
vRtrIsisLspSecondWait
vRtrIsisCsnpAuthentication
vRtrIsisHelloAuthentication
vRtrIsisPsnpAuthentication
vRtrIsisGRHelperMode
vRtrIsisSpfWait
vRtrIsisMTEnabled
vRtrIsisLevelTable
vRtrIsisLevelAuthKey
vRtrIsisLevelAuthType
vRtrIsisLevelExtPreference
vRtrIsisLevelPreference
vRtrIsisLevelWideMetricsOnly
vRtrIsisLevelCsnpAuthentication
vRtrIsisLevelPsnpAuthentication
vRtrIsisLevelHelloAuthentication
vRtrIsisLevelWideMertic
vRtrIsisLevelNumLSPs

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-83
show ip isis summary-address IS-IS Commands

show ip isis summary-address

Displays the IS-IS summary address database.
show ip isis summary-address [ip-addr [/mask]]

Syntax Definitions

ip-addr The 32-bit IP address.

/mask The netmask value. The valid range is 1–32.

Defaults
By default summary address information for all the IP addresses is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the ip-addr parameter with this command to view the summary address information for a specific IP
address.

Examples
-> show ip isis summary-address
=========================================================================
ISIS Summary Address
======================================================
Address Level
-------------------------------------------------------------------------------
1.0.0.0/8 L1
2.1.0.0/24 L1L2
3.1.2.3/32 L2
-------------------------------------------------------------------------------

Summary Address : 3

output definitions
Address The summary address for a range of IPv4 addresses.
Level The capability level of the router.
Summary Address The number of summarized addresses.

Release History
Release 8.1.1; command introduced.

page 25-84 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands show ip isis summary-address

Related Commands

ip isis summary-address Adds or deletes the summary address.

MIB Objects
vRtrIsissummaryTable
vRtrIsisSummPefix
vRtrIsisSummMask
vRtrIsisSummLevel

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-85
show ip isis vlan IS-IS Commands

show ip isis vlan

Displays the IS-IS IPv4 and IPv6 interface information on a VLAN in the IS-IS database.
show ip isis vlan [vlan-id] [detail]

Syntax Definitions

vlan-id The VLAN ID.

detail Indicates that the output is displayed in a detailed manner.

Defaults
By default, the interface information for all the interfaces is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the vlan-id parameter with this command to view information for a specific VLAN.

Examples
-> show ip isis vlan
===================================================================================
ISIS VLan
===================================================================================
Interface Address-family Level VlanID Oper-state Admin-state L1/L2-Metric
-----------------------------------------------------------------------------------
ospf ipv4 L1L2 11 DOWN UP 10/10
vlan11 ipv6 L1L2 11 DOWN UP 10/10
-----------------------------------------------------------------------------------
Vlans : 2
===================================================================================

output definitions
Interface The name of the IS-IS interface.
Address-family The address family extension: IPv4 or IPv6
Level The level capability of the interface.
VlanID The VLAN ID of the interface.
Oper-state The operational state of the interface (up or down).
Admin-state The administrative state of the interface (up or down).
L1/L2 -Metric The metric value of the router for the corresponding capability level.
Vlans The total number of VLANs.

page 25-86 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands show ip isis vlan

-> show ip isis vlan detail

=========================================================================
ISIS Interface
=========================================================================
--------------------------------------------------------------------------
VlanId : 10 Level Capability : L1L2
Oper State : Up Admin State : Up
Auth Type : None Address Families : IPv4, IPv6
Circuit Id : 1 RetransmitInt : 5
Type : Broadcast LSP Pacing Int : 100
Mesh Group : Inactive CSNP Int : 10
Level : 1 Adjacencies : 0
Desg IS : abr_nyc
Auth Type : None Metric : 10
Hello Timer : 9 Hello Mult : 3
Priority : 64 Passive : No
Level : 2 Adjacencies : 0
Desg IS : abr_nyc
Auth Type : None Metric : 10
Hello Timer : 9 Hello Mult : 3
Priority : 64 Passive : No
-------------------------------------------------------------------------------
VlanId : 20 Level Capability : L1L2
Oper State : Up Admin State : Up
Auth Type : None Address Families : IPv4, IPv6
Circuit Id : 8 RetransmitInt : 5
Type : Pt-to-Pt LSP Pacing Int : 100
Mesh Group : Inactive CSNP Int : 10
Level : Pt-to-Pt
Desg IS : abr_nyc
Auth Type : None Metric : 10
Hello Timer : 9 Hello Mult : 3
Priority : 64 Passive : No
------------------------------------------------------------------------------
vlans : 2
==============================================================================

output definitions
VlanId The VLAN ID.
Level Capability The level capability of the interface.
Oper State The operational state of the interface (up or down).
Admin State The administrative state of the interface (up or down).
Auth Type Indicates the authentication type (simple, MD5, or none) of the inter-
face.
Address Families The address family extension: IPv4 or IPv6
Circuit Id The circuit ID of the interface.
RetransmitInt Specifies the minimal interval of time, in seconds between retransmis-
sion of an LSP on the point-to-point interface.
Type The type of interface: Broadcast or Pt-to-Pt (point to point).
LSP Pacing Int The LSP Pacing interval.
Mesh Group The status of the mesh group (Active or Inactive).
CSNP Int The CSNP interval.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-87
show ip isis vlan IS-IS Commands

output definitions (continued)

Level Indicates the IS-IS level of the neighbor (L1, L2, or L1L2).
Adjacencies The number of adjacencies formed.
Desg IS The ID of the LAN Designated Intermediate System on this circuit at
this level.
Auth Type Indicates the authentication type (simple, MD5, or none) for the speci-
fied level.
Metric The metric value of this circuit for a specific level.
Hello Timer Indicates the Hello timer value.
Hello Mult Indicates the Hello multiplier value.
Priority The priority value of the interface.
Passive Indicates whether the interface is configured as a passive interface (Yes
or No).
Vlans The total number of VLANs.

Release History
Release 8.1.1; command introduced.

Related Commands

ip isis vlan Configures IPv4 or IPv6 IS-IS circuit on a particular VLAN.

page 25-88 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands show ip isis vlan

MIB Objects
isisCircTable
isisCircLocalID
isisCircAdminState
isisCircType
isisCircLevel
isisCircPassiveCircui
isisCircMeshGroup
isisCircLevelTable
isisCircLevelISPriority
isisCircLevelCircID
isisCircLevelDesIS
isisCircLevelHelloMultiplier
isisCircLevelHelloTimer
isisCircLevelCSNPInterval
vRtrIsisIfTable
vRtrIsisIfAdminState
vRtrIsisIfOperState
vRtrIsisIfCsnpInterval
vRtrIsisIfHelloAuthKey
vRtrIsisIfHelloAuthType
vRtrIsisIfLspPacingInterval
vRtrIsisIfRetransmitInterval
vRtrIsisIfLevelTable
vRtrIsisIfLevelHelloAuthKey
vRtrIsisIfLevelHelloAuthType
vRtrIsisIfLevelPassive
vRtrIsisIfLevelNumAdjacencies
vRtrIsisIfLevelISPriority
vRtrIsisIfLevelHelloTimer
vRtrIsisLevelOperMetric
vRtrIsisIfLevelAdminMetric

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-89
show ip isis summary-address6 IS-IS Commands

show ip isis summary-address6

Displays the IS-IS IPv6 summary address database.
show ip isis summary-address6 [ip-addr [/mask]]

Syntax Definitions

ip-addr The 32-bit IP address.

/mask The netmask value. The valid range is 1–32.

Defaults
By default, summary address information for all the IP addresses is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the ip-addr parameter with this command to view the summary address information for a specific IP
address.

Examples
-> show ip isis summary-address6
===========================================================
ISISv6 Summary Address
===========================================================
Address Level
-----------------------------------------------------------
1111:1::/64 L1
-----------------------------------------------------------
Summary Address : 1
===========================================================

output definitions
Address The summary address for a range of IPv6 addresses.
Level The capability level of the router.
Summary Address The number of summarized addresses.

Release History
Release 8.1.1; command introduced.

page 25-90 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands show ip isis summary-address6

Related Commands

ip isis summary-address6 Configures the IPv6 summary address.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-91
clear ip isis adjacency IS-IS Commands

clear ip isis adjacency

Clears and resets the IS-IS adjacency database information.
clear ip isis adjacency [system-id nbr-sys-id]

Syntax Definitions

nbr-sys-id The system ID of the neighbor router.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If the nbr-sys-id parameter is specified, only the entries specific to that system ID are removed from the
database.

Examples
-> clear ip isis adjacency system-id 1122.3344.5566

Release History
Release 8.1.1; command introduced.

Related Commands
show ip isis adjacency Displays information about IS-IS adjacent routers.

page 25-92 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands clear ip isis adjacency

MIB Objects
isisISAdjTable
isisISAdjIndex
isisISAdjState
isisISAdjNeighSNPAAddress
isisISAdjNeighSysType
isisISAdjNeighSysID
isisISAdjUsage
isisISAdjHoldTimer
isisISAdjNeighPriority
isisISAdjUpTime
vRtrIsisISAdjTable
vRtrIsisISAdjExpiresIn
vRtrIsisISAdjCircLevel
vRtrIsisISAdjRestartSupport
vRtrIsisISAdjRestartStatus
vRtrIsisISAdjRestartSupressed

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-93
clear ip isis lsp-database IS-IS Commands

clear ip isis lsp-database

Clears and resets the IS-IS LSP database information.
clear ip isis lsp-database [system-id sys-id]

Syntax Definitions

sys-id The system ID of the router.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If the sys-id parameter is specified, only the entries specific to that system ID are removed from the data-
base.

Examples
-> clear ip isis lsp-database system-id 000a.1234.2345

Release History
Release 8.1.1; command introduced.

Related Commands

show ip isis database Displays IS-IS LSP database information of the adjacent routers.

MIB Objects
vRtrIsisLSPTable
vRtrIsisLSPId
vRtrIsisLSPSeq
vRtrIsisLSPChecksum
vRtrIsisLSPLifetimeRemain
vRtrIsisLSPVersion
vRtrIsisLSPPktType
vRtrIsisLSPPktVersion
vRtrIsisLSPMaxArea
vRtrIsisLSPSysIdLen
vRtrIsisLSPAttributes
vRtrIsisLSPUsedLen
vRtrIsisLSPAllocLen
vRtrIsisLSPBuff
vRtrIsisLSPZeroRLT

page 25-94 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands clear ip isis spf-log

clear ip isis spf-log

Clears and resets the IS-IS SPF log information.
clear ip isis spf-log

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> clear ip isis spf-log

Release History
Release 8.1.1; command introduced.

Related Commands

show ip isis spf-log Displays the IS-IS SPF log.

MIB Objects
vRtrIsisSpfLogTable
vRtrIsisSpfRunTime
vRtrIsisSpfL1Nodes
VRtrIsisSpfL2Nodes
vRtrIsisSpfEventCount
vRtrIsisSpfLastTriggerLSPId
vRtrIsisSpfTriggerReason

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-95
clear ip isis statistics IS-IS Commands

clear ip isis statistics

Clears and resets the IS-IS statistics information.
clear ip isis statistics

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> clear ip isis statistics

Release History
Release 8.1.1; command introduced.

Related Commands

show ip isis statistics Displays the IS-IS statistics information.

page 25-96 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IS-IS Commands clear ip isis statistics

MIB Objects
vRtrIsisStatsTable
vRtrIsisSpfRuns
vRtrIsisLSPRegenerations
vRtrIsisInitiatedPurges
vRtrIsisLSPRecd
vRtrIsisLSPDrop
vRtrIsisLSPSent
vRtrIsisLSPRetrans
vRtrIsisIIHRecd
vRtrIsisIIHDrop
vRtrIsisIIHSent
vRtrIsisIIHRetrans
vRtrIsisCSNPRecd
vRtrIsisCSNPDrop
vRtrIsisCSNPSent
vRtrIsisCSNPRetrans
vRtrIsisPSNPRecd
vRtrIsisPSNPDrop
vRtrIsisPSNPSent
vRtrIsisPSNPRetrans
vRtrIsisUnknownRecd
vRtrIsisUnknownDrop
vRtrIsisUnknownSent
vRtrIsisUnknownRetrans
vRtrIsisCSPFRequests
vRtrIsisCSPFDroppedRequests
vRtrIsisCSPFPathsFound
vRtrIsisCSPFPathsNotFound

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 25-97
ip isis multi-topology IS-IS Commands

ip isis multi-topology
Enables M-ISIS (multi-topology) capability support for IS-IS. If enabled, IPv6 SPF computation is
performed separate from the IPv4 SPF computation.
ip isis multi-topology
no ip isis multi-topology

Syntax Definitions

N/A

Defaults
By default, multi-topology is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Changing the multi-topology mode with this command results in internal disabling and re-enabling of IS-
IS protocol with the new mode of operation. This will cause IS-IS adjacencies to be reset.

Examples
-> ip isis multi-topology
-> no ip isis multi-topology

Release History
Release 8.2.1; command introduced.

Related Commands

show ip isis status Displays the IS-IS status.

show ip isis adjacency Displays information about IS-IS adjacent routers.

MIB Objects
vRtrIsisEntry
vRtrIsisMTEnabled

page 25-98 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 26 BGP Commands

This chapter describes the CLI commands used to configure the BGP (Border Gateway Protocol) and
Multiprotocol extensions to BGP. BGP is a protocol for exchanging routing information between gateway
hosts in a network of ASs (autonomous systems). BGP is the most common protocol used between
gateway hosts on the Internet. The routing table exchanged contains a list of known routers, the addresses
they can reach, and a preference metrics associated with the path to each router so that the best available
route is chosen.
Multiprotocol Extensions to BGP-4 supports the exchange of IPv6 unicast prefixes, as well as the
establishment of BGP peering sessions with BGP speakers identified by their IPv6 addresses.
The Alcatel-Lucent implementation of BGP-4 and Multiprotocol Extensions to BGP-4 complies with the
following RFCs: 4271, 2439, 3392, 2385, 1997, 4456, 3065, 4273, 4760, 2545

Note. In the following document, the BGP terms “peer” and “neighbor” are used interchangeably to mean
any BGP speaker known to the local router.

MIB information for BGP is as follows:

Filename: AlcatelIND1Bgp.MIB
Module: ALCATEL-IND1-BGP-MIB
Filename: IETF_BGP4.MIB
Module: BGP4-MIB

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-1
 BGP Commands

The following table summarizes the available commands:

Global BGP Commands ip load bgp

ip bgp admin-state
ip bgp autonomous-system
ip bgp bestpath as-path ignore
ip bgp cluster-id
ip bgp default local-preference
ip bgp fast-external-failover
ip bgp always-compare-med
ip bgp bestpath med missing-as-worst
ip bgp client-to-client reflection
ip bgp as-origin-interval
ip bgp synchronization
ip bgp confederation identifier
ip bgp maximum-paths
ip bgp log-neighbor-changes
ip bgp dampening
ip bgp dampening clear
ip bgp asn-format
show ip bgp
show ip bgp statistics
show ip bgp dampening
show ip bgp dampening-stats
show ip bgp path
show ip bgp routes
Aggregate Configuration ip bgp aggregate-address
ip bgp aggregate-address admin-state
ip bgp aggregate-address as-set
ip bgp aggregate-address community
ip bgp aggregate-address local-preference
ip bgp aggregate-address metric
ip bgp aggregate-address summary-only
show ip bgp aggregate-address
Network (local route) ip bgp network
Configurations ip bgp network admin-state
ip bgp network community
ip bgp network local-preference
ip bgp network metric
show ip bgp network

page 26-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands

Neighbor (Peer) Configuration ip bgp neighbor

ip bgp neighbor admin-state
ip bgp neighbor advertisement-interval
ip bgp neighbor clear
ip bgp neighbor route-reflector-client
ip bgp neighbor default-originate
ip bgp neighbor timers
ip bgp neighbor conn-retry-interval
ip bgp neighbor auto-restart
ip bgp neighbor maximum-prefix
ip bgp neighbor md5 key
ip bgp neighbor ebgp-multihop
ip bgp neighbor description
ip bgp neighbor next-hop-self
ip bgp neighbor passive
ip bgp neighbor remote-as
ip bgp neighbor remove-private-as
ip bgp neighbor soft-reconfiguration
ip bgp neighbor stats-clear
ip bgp confederation neighbor
ip bgp neighbor update-source
ip bgp neighbor in-aspathlist
ip bgp neighbor in-communitylist
ip bgp neighbor in-prefixlist
ip bgp neighbor out-aspathlist
ip bgp neighbor out-communitylist
ip bgp neighbor out-prefixlist
ip bgp neighbor route-map
ip bgp neighbor clear soft
show ip bgp neighbors
show ip bgp neighbors policy
show ip bgp neighbors timer
show ip bgp neighbors statistics

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-3
 BGP Commands

Policy Commands ip bgp policy aspath-list

ip bgp policy aspath-list action
ip bgp policy aspath-list priority
ip bgp policy community-list
ip bgp policy community-list action
ip bgp policy community-list match-type
ip bgp policy community-list priority
ip bgp policy prefix-list
ip bgp policy prefix-list action
ip bgp policy prefix-list ge
ip bgp policy prefix-list le
ip bgp policy prefix6-list
ip bgp policy route-map action
ip bgp policy route-map aspath-list
ip bgp policy route-map asprepend
ip bgp policy route-map community
ip bgp policy route-map community-list
ip bgp policy route-map community-mode
ip bgp policy route-map lpref
ip bgp policy route-map lpref-mode
ip bgp policy route-map match-community
ip bgp policy route-map match-mask
ip bgp policy route-map match-prefix
ip bgp policy route-map match-regexp
ip bgp policy route-map med
ip bgp policy route-map med-mode
ip bgp policy route-map origin
ip bgp policy route-map prefix-list
ip bgp policy route-map weight
ip bgp policy route-map community-strip
show ip bgp policy aspath-list
show ip bgp policy community-list
show ip bgp policy prefix-list
show ip bgp policy route-map
BGP Graceful Restart ip bgp graceful-restart
Commands ip bgp graceful-restart restart-interval
IPv6 Global BGP Commands ip bgp unicast
ipv6 bgp unicast
ip bgp neighbor activate-ipv6
ip bgp neighbor ipv6-nexthop
show ipv6 bgp path
show ipv6 bgp routes
IPv6 BGP Network ipv6 bgp network
Configuration Commands ipv6 bgp network community
ipv6 bgp network local-preference
ipv6 bgp network metric
ipv6 bgp network admin-state
show ipv6 bgp network

page 26-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands

IPv6 BGP Neighbor (Peer) ipv6 bgp neighbor

Configuration Commands ipv6 bgp neighbor activate-ipv6
ipv6 bgp neighbor ipv6-nexthop
ipv6 bgp neighbor admin-state
ipv6 bgp neighbor remote-as
ipv6 bgp neighbor timers
ipv6 bgp neighbor maximum-prefix
ipv6 bgp neighbor next-hop-self
ipv6 bgp neighbor conn-retry-interval
ipv6 bgp neighbor default-originate
ipv6 bgp neighbor update-source
ipv6 bgp neighbor ipv4-nexthop
show ipv6 bgp neighbors
show ipv6 bgp neighbors statistics
show ipv6 bgp neighbors policy
show ipv6 bgp neighbors policy

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-5
ip load bgp BGP Commands

ip load bgp
Loads the BGP protocol software into running memory on the router. The image file containing BGP
should already be resident in flash memory before issuing this command.
ip load bgp

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command requires that the BGP software be resident in flash memory in the active directory.

• Enter this command in the router’s configuration file (vcboot.cfg) to ensure BGP software is running
after a reboot.
• The command does not administratively enable BGP on the router; BGP will be disabled after issuing
this command. You must issue the ip bgp admin-state to start the BGP protocol.

Examples
-> ip load bgp

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp autonomous-system Configures the Autonomous system number for this BGP router.
ip bgp admin-state Administratively enables or disables BGP.

MIB Objects
alaDrcTmIPBgpStatus

page 26-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp admin-state

ip bgp admin-state
Administratively enables or disables BGP. The BGP protocol will not be active until you enable it using
this command.
ip bgp admin-state {enable | disable}

Syntax Definitions

enable Enables BGP.

disable Disables BGP.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• You must first load the BGP software into running memory using the ip load bgp command before
initiating this command.
• Many BGP commands require that the protocol be disabled (ip bgp admin-state) before issuing them.

Examples
-> ip bgp admin-state enable
-> ip bgp admin-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

ip load bgp Loads the BGP software.

MIB Objects
alaBgpGlobal
alaBgpProtoStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-7
ip bgp autonomous-system BGP Commands

ip bgp autonomous-system
Configures the Autonomous System (AS) number for this router. This number identifies this BGP speaker
(this router) instance to other BGP routers. The AS number for a BGP speaker determines whether it is an
internal or an external peer in relation to other BGP speakers. BGP routers in the same AS are internal
peers while BGP routers in different ASs are external peers. BGP routers in the same AS exchange
different routing information with each other than they exchange with BGP routers in external ASs. BGP
speakers append their AS number to routes passing through them; this sequence of AS numbers is known
as a route’s AS path.
ip bgp autonomous-system value

Syntax Definitions

value The AS number in the asplain, asdot+, or asdot formats.

Defaults

parameter default
value 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• A router can belong to only one AS. Do not specify more than one AS value for each router.

• The BGP protocol must be disabled (using the ip bgp admin-state command) before using this
command.
• The 4-octet ASN is represented in one of three ways:
– asplain (simple decimal notation)
– asdot+ (two 16-bit values as low-order and high-order)
– asdot (a mixture of asplain and asdot+).

Examples
-> ip bgp autonomous-system 64724
The following examples show how to configure the local BGP ASN as 65535 in the
three different formats:
-> ip bgp autonomous-system 65535 (asplain format)
-> ip bgp autonomous-system 0.65535 (asdot+ format)
-> ip bgp autonomous-system 65535 (asdot format)

page 26-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp autonomous-system

The following examples show how to configure the local BGP ASN as 65538 in the
three different formats:
-> ip bgp autonomous-system 65538 (asplain format
-> ip bgp autonomous-system 1.2 (asdot+ format)
-> ip bgp autonomous-system 1.2 (asdot format)

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp admin-state Enables and disables the BGP protocol.

MIB Objects
alaBgpGlobal
alaBgpAutonomousSystemNumber

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-9
ip bgp bestpath as-path ignore BGP Commands

ip bgp bestpath as-path ignore

Indicates whether AS path comparison will be used in route selection. The AS path is the sequence of ASs
through which a route has traveled. A shorter AS path is preferred over a longer AS path. The AS path is
always advertised in BGP route updates. This command informs BGP to use the length of the AS path as a
criteria for determining the best route.
ip bgp bestpath as-path ignore
no ip bgp bestpath as-path ignore

Syntax Definitions

N/A

Defaults
This command is enabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable this feature after it has been enabled.

• AS path comparison does not consider the type of links connecting the ASs along the path. In some
cases a longer path over very fast connections may be a better route than a shorter path over slower
connections. For this reason the AS path should not be the only criteria used for route selection. BGP
considers local preference before AS path when making path selections.
• The BGP protocol must be disabled (using the ip bgp admin-state command) before using this
command.

Examples
-> ip bgp bestpath as-path ignore
-> no ip bgp bestpath as-path ignore

Release History
Release 8.1.1; command was introduced.

page 26-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp bestpath as-path ignore

Related Commands

ip bgp aggregate-address as-set Specifies whether AS path aggregation is to be performed or not.

ip bgp policy aspath-list Creates or removes an AS path list.
ip bgp default local-preference Configures the default local preference (lpref) value to be used
when advertising routes.

MIB Objects
alaBgpGlobal
alaBgpAsPathCompare

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-11
ip bgp cluster-id BGP Commands

ip bgp cluster-id
Configures a BGP cluster ID when there are multiple, redundant, route reflectors in a cluster. This
command is not necessary for configurations containing only one route reflector.
ip bgp cluster-id ip_address

Syntax Definitions

ip_address 32-bit IP address that is the Cluster ID of the router acting as a route
reflector.

Defaults

parameter default
ip_address 0.0.0.0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• In a route-reflection configuration where there are multiple route-reflectors in a cluster, use this
command to configure this cluster ID. Configuring multiple route-reflectors enhances redundancy and
avoids a single point of failure. When there is only one reflector in a cluster, the router ID of the
reflector is used as the cluster-ID.
• The BGP protocol must be disabled (using the ip bgp admin-state command) before using this
command.
• Using many redundant reflectors in a single cluster places demands on the memory required to store
routes for all redundant reflectors’ peers.

Examples
-> ip bgp cluster-id 1.2.3.4

Release History
Release 8.1.1; command was introduced.

page 26-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp cluster-id

Related Commands

ip bgp admin-state Enables and disables BGP.

ip bgp client-to-client reflection Enables route reflection and sets this speaker as the route reflector.

MIB Objects
alaBgpGlobal
alaBgpClusterId

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-13
ip bgp default local-preference BGP Commands

ip bgp default local-preference

Configures the default local preference (lpref) value to be used when advertising routes. A higher local
preference value is preferred over a lower value. The local preference value is sent to all BGP peers in the
local autonomous system; it is not advertised to external peers.
ip bgp default local-preference value

Syntax Definitions

value The default local preference value for this router. The valid range is 0–
4294967295.

Defaults

parameter default
value 100

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to restore the default value.

• Unless a route is specifically configured for a different local preference value it will default to value
you specify in this command. This value is used for routes learned from external autonomous systems
(the local preference value is not advertised in routes received from external peers) and for aggregates
and networks that do not already contain local preference values.
• This value is specific to the router so it can compare its own local preference to those received in
advertised paths. If other routers belong to the same AS, then they should use the same default local
preference value.
• The BGP protocol must be disabled (using the ip bgp admin-state command) before using this
command.

Examples
-> ip bgp default local-preference 200

Release History
Release 8.1.1; command was introduced.

page 26-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp default local-preference

Related Commands

ip bgp aggregate-address local- Sets the local preference for a BGP aggregate.
preference
ip bgp network local-preference Sets the local preference for a BGP network.

MIB Objects
alaBgpGlobal
alaBgpDefaultLocalPref

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-15
ip bgp fast-external-failover BGP Commands

ip bgp fast-external-failover
Enables fast external failover (FEFO). When enabled, FEFO resets a session when a link to a directly
connected external peer is operationally down. The BGP speaker will fall back to Idle and then wait for a
connection retry by the external peer that went down.
ip bgp fast-external-failover
no ip bgp fast-external-failover

Syntax Definitions

N/A

Defaults
This command is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable Fast External Failover.

• When enabled, this command allows BGP to take immediate action when a directly connected inter-
face, on which an external BGP session is established, goes down. Normally BGP relies on TCP to
manage peer connections. Fast External failover improves upon TCP by resetting connections as soon
as they go down.
• The BGP protocol must be disabled (using the ip bgp admin-state command) before using this
command.

Examples
-> ip bgp fast-external-failover
-> no ip bgp fast-external-failover

Release History
Release 8.1.1; command was introduced.

page 26-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp fast-external-failover

Related Commands

ip bgp neighbor clear Restarts a BGP peer.

ip bgp neighbor auto-restart Enables or disables BGP peer automatic restart.
ip bgp neighbor timers Configures the time interval between KEEPALIVE messages sent
by this peer and the tolerated hold time interval, in seconds, for
messages to this peer from other peers.

MIB Objects
alaBgpFastExternalFailOver

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-17
ip bgp always-compare-med BGP Commands

ip bgp always-compare-med
Enables or disables Multi-Exit Discriminator (MED) comparison between peers in different autonomous
systems. The MED value is considered when selecting the best path among alternatives; it indicates the
weight for a particular exit point from the AS. A path with a lower MED value is preferred over a path
with a higher MED value.
ip bgp always-compare-med
no ip bgp always-compare-med

Syntax Definitions

N/A

Defaults
This command is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable MED comparison for external peers.

• By default, BGP only compares MEDs from the same autonomous system when selecting routes.
Enabling this command forces BGP to also compare MEDs values received from external peers, or
other autonomous systems.
• The BGP protocol must be disabled (using the ip bgp admin-state command) before using this
command.

Examples
-> ip bgp always-compare-med
-> no ip bgp always-compare-med

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp bestpath med missing- Configures the MED parameter when it is missing in a BGP path.
as-worst

MIB Objects
alaBgpGlobal
alaBgpMedAlways

page 26-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp bestpath med missing-as-worst

ip bgp bestpath med missing-as-worst

Configures the MED parameter when it is missing in a BGP path.
ip bgp bestpath med missing-as-worst
no ip bgp bestpath med missing-as-worst

Syntax Definitions

N/A

Defaults
By default this command is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable missing MEDs as worst.

• This command is used to specify how a missing MED in an external BGP path is to be treated for route
selection purposes. The default behavior is to treat missing MEDs as zero (best). This command allows
you to treat missing MEDs as worst (232-1) for compatibility reasons.
• The BGP protocol must be disabled (using the ip bgp admin-state command) before using this
command.

Examples
-> ip bgp bestpath med missing-as-worst
-> no ip bgp bestpath med missing-as-worst

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp always-compare-med Forces BGP to consider MED values from external routes.

MIB Objects
alaBgpGlobal
alaBgpMissingMed

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-19
ip bgp client-to-client reflection BGP Commands

ip bgp client-to-client reflection

Enables or disables this BGP speaker (router) to be a route reflector. Route reflectors advertise routing
information to internal BGP peers, referred to as clients. BGP requires all internal routers to know all
routes in an AS. This requirement demands a fully meshed (each router has a direct connection to all other
routers in the AS) topology. Route reflection loosens the fully meshed restriction by assigning certain BGP
routers as route reflectors, which take on the responsibility of advertising routing information to local BGP
peers.
ip bgp client-to-client reflection
no ip bgp client-to-client reflection

Syntax Definitions

N/A

Defaults
This command is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable the speaker as a route reflector.

• In addition to defining this router as the route reflector, this command also enable route reflection for
this cluster. After setting this command this reflector will begin using route reflection behavior when
communicating to client and non-client peers.
• Once route reflectors are configured, you need to indicate the clients (those routers receiving routing
updates from the reflectors) for each route reflector. Use the ip bgp neighbor route-reflector-client
command to configure clients.
• The BGP protocol must be disabled (using the ip bgp admin-state command) before using this
command.

Examples
-> ip bgp client-to-client reflection
-> no ip bgp client-to-client reflection

Release History
Release 8.1.1; command was introduced.

page 26-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp client-to-client reflection

Related Commands

ip bgp admin-state Administratively disables BGP in this router.

ip bgp neighbor route-reflector- Configures a BGP peer to be a client to the this route reflector.
client

MIB Objects
alaBgpGlobal
alaBgpRouteReflection

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-21
ip bgp as-origin-interval BGP Commands

ip bgp as-origin-interval
Specifies the frequency at which routes local to the autonomous system are advertised. These
advertisements are also referred to as UPDATE messages. This interval applies to advertisements to
internal peers.
ip bgp as-origin-interval seconds
no ip bgp as-origin-interval

Syntax Definitions

seconds The update interval in seconds. The valid range is 1–65535.

Defaults

parameter default
seconds 15

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to reset the feature to the default value.

• A lower value may increase the likelihood of route flapping as route status is updated more frequently.

Examples
-> ip bgp as-origin-interval 15
-> no ip bgp as-origin-interval

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp neighbor advertisement- Set the route advertisement interval for external peers.
interval

MIB Objects
alaBgpGlobal
alaBgpAsOriginInterval

page 26-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp synchronization

ip bgp synchronization
Enables or disables synchronization of BGP prefixes with AS-internal routing information. Enabling this
command will force the BGP speaker to advertise prefixes only if the prefixes are reachable through AS-
internal routing protocols (IGPs like RIP and OSPF).
ip bgp synchronization
no ip bgp synchronization

Syntax Definitions

N/A

Defaults
This command is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable IGP synchronization.

• A BGP router is not supposed to advertise routes learned through internal BGP updates unless those
routes are also known by the primary internal routing protocol (e.g, RIP or OSPF). However, requiring
all routers in an AS to know all external routes places a heavy burden on routers focusing mainly on
Intra-AS routing. Therefore, disabling synchronization avoids this extra burden on internal routers. As
long as all BGP routers in an AS are fully meshed (each has a direct connection to all other BGP rout-
ers in the AS) then the problem of unknown external router should not be a problem and synchroniza-
tion can be disabled.
• By default, synchronization is disabled and the BGP speaker can advertise a route without waiting for
the IGP to learn it. When the autonomous system is providing transit service, BGP should not propa-
gate IGP paths until the IGP prefixes themselves are known to be reachable through IGP. If BGP
advertises such routes before the IGP routers have learned the path, they will drop the packets causing
a blackhole.
• The BGP protocol must be disabled (using the ip bgp admin-state command) before using this
command.

Examples
-> ip bgp synchronization
-> no ip bgp synchronization

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-23
ip bgp synchronization BGP Commands

Related Commands

show ip bgp Displays the current global settings for the local BGP speaker.

MIB Objects
alaBgpGlobal
alaBgpIgpSynchStatus

page 26-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp confederation identifier

ip bgp confederation identifier

Sets a confederation identification value for the local BGP speaker (this router). A confederation is a
grouping of sub-ASs into a single AS. To peers outside a confederation, the confederation appears to be a
single AS. Within the confederation multiple ASs may exist and even exchange information with each
other as using external BGP (EBGP).
ip bgp confederation identifier value

Syntax Definitions

value The confederation identification value. The valid range is 0–65535.

Defaults

parameter default
value 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to restore the default value.

• A value of 0 means this local speaker is not a member of any confederation.

• The BGP protocol must be disabled (using the ip bgp admin-state command) before using this
command.
• Use this command in conjunction with the ip bgp confederation neighbor command to specify those
peers that are a members of the same confederation as the local BGP speaker.

Examples
-> ip bgp confederation identifier 3

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-25
ip bgp confederation identifier BGP Commands

Related Commands

ip bgp autonomous-system Sets the AS number for this router.

ip bgp confederation neighbor Specifies peers that are members of a confederation.

MIB Objects
alaBgpGlobal
alaBgpConfedId

page 26-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp maximum-paths

ip bgp maximum-paths
Enables or disables support for multiple equal paths. When multipath support is enabled and the path
selection process determines that multiple paths are equal when the router-id is disregarded, then all equal
paths are installed in the hardware forwarding table. When multipath support is disabled, only the best
route entry is installed in the hardware forwarding table.
ip bgp maximum-paths
no ip bgp maximum-paths

Syntax Definitions

N/A

Defaults
This command is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable support for multiple equal cost paths.

• The BGP protocol must be disabled (using the ip bgp admin-state command) before using this
command.

Examples
-> ip bgp maximum-paths
-> no ip bgp maximum-paths

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip bgp Displays the current global settings for the local BGP speaker.

MIB Objects
alaBgpGlobal
alaBgpMultiPath

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-27
ip bgp log-neighbor-changes BGP Commands

ip bgp log-neighbor-changes
Enables or disables the logging of peer state changes. If enabled, this logging tracks changes in the state of
BGP peers from ESTABLISHED to IDLE and from IDLE to ESTABLISHED. Viewing peer state logging
requires that certain debug parameters be set.
ip bgp log-neighbor-changes
no ip bgp log-neighbor-changes

Syntax Definitions

N/A

Defaults
This command is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The BGP protocol must be disabled (using the ip bgp admin-state command) before using this command.

Examples
-> ip bgp log-neighbor-changes
-> no ip bgp log-neighbor-changes

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp admin-state Disables BGP within the router.

MIB Objects
alaBgpGlobal
alaBgpPeerChanges

page 26-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp dampening

ip bgp dampening
Enables or disables BGP route dampening or the suppression of unstable routes. Route dampening helps to
control the advertisement of routes that are going up and then down at an abnormally high rate. Routes
that are changing states (available then unavailable) are said to be flapping.
ip bgp dampening [half-life half_life reuse reuse suppress suppress max-suppress-time max_sup-
press_time]
no ip bgp dampening

Syntax Definitions

half_life The half-life duration, in seconds. The valid range is 0–65535.

reuse The number of route withdrawals set for the re-use value. The valid
range is 1–9999.
suppress The dampening cutoff value. The valid range is 1–9999.
max_suppress_time The maximum number of seconds a route can be suppressed. The valid
range is 0–65535.

Defaults

parameter value
half_life 300
reuse 200
suppress 300
max_suppress_time 1800

This command is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable dampening.

• BGP dampening is disabled by default. When enabled, route dampening suppresses routes that are
unstable, or “flapping,” and disrupting the network.
• BGP dampening of IPv6 route flaps is currently not supported.

• This command enables dampening and can also be used to change the default times for the dampening
variables.
• Use the dampening variables to set penalties, suppression limits, and reuse values for flapping routes.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-29
ip bgp dampening BGP Commands

• The half-life value configures the half-life duration for a reachable route. After the time interval speci-
fied in this command, the penalty value for the route will be reduced by half. This command sets the
duration in seconds during which the accumulated stability value is reduced by half if the route is
considered reachable, whether suppressed or not. A larger value may be desirable for routes that are
known for their instability. A larger value will also result in a longer suppression time if the route
exceeds the flapping rate.
• The reuse value configures the number of route withdrawals necessary to begin readvertising a previ-
ously suppressed route. If the penalty value for a suppressed route fall below this value, then it will be
advertised again. This command sets the reuse value, expressed as a number of route withdrawals.
When the stability value for a route reaches or falls below this value, a previously suppressed route will
be advertised again. The instability metric for a route is decreased by becoming more stable and by
passing half-life time intervals.
• The suppress value configures the cutoff value, or number of route withdrawals, at which a flapping
route is suppressed and no longer advertised to BGP peers. This value is expressed as a number of
route withdrawals. When the stability value for a route exceeds this cutoff value, the route advertise-
ment is suppressed.
• The max-suppress-time value configures the maximum time (in seconds) a route can be suppressed.
This time is also known as the maximum holdtime or the maximum instability value. Once this time is
reached the route flap history for a route will be deleted and the route will be advertised again (assum-
ing it is still reachable). This maximum holdtime as applied on an individual route basis. Each
suppressed route will be held for the amount of time specified in this command unless the route is re-
advertised by falling below the reuse value.
• Entering the command with no variables returns the variables back to their defaults.

Examples
-> ip bgp dampening
-> ip bgp dampening half-life 20 reuse 800 suppress 60 max-suppress-time 40
-> no ip bgp dampening

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp dampening clear Clears the dampening history data for all routes on the router, reset-
ting route flap counters and unsuppressing any routes that had been
suppressed due to route flapping violations.
show ip bgp dampening Displays the BGP route dampening settings.
show ip bgp dampening-stats Displays BGP dampening statistics.

page 26-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp dampening

MIB Objects
alaBgpGlobal
alaBgpDampening
alaBgpDampMaxFlapHistory
alaBgpDampHalfLifeReach
alaBgpDampReuse
alaBgpDampCutOff

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-31
ip bgp dampening clear BGP Commands

ip bgp dampening clear

Clears the dampening history data for all routes on the router, resetting route flap counters and
unsuppressing any routes that had been suppressed due to route flapping violations.
ip bgp dampening clear

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use this command to clear all of the currently stored information on routes for dampening purposes.
When this command is entered, all route information in regards to dampening is cleared.
• BGP dampening of IPv6 route flaps is currently not supported.

Examples
-> ip bgp dampening clear

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp dampening Enables or disables route dampening.

MIB Objects
alaBgpGlobal
alaBgpDampeningClear

page 26-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp asn-format

ip bgp asn-format
Configures the display format to be used when displaying 4-octet ASNs.
ip bgp asn-format {asdot | asplain}

Syntax Definitions

asdot A mixture of asplain and asdot+.

asplain Simple decimal notation.

Defaults
The default is asplain.

Platforms Supported
OmniSwitch 6900.

Usage Guidelines
This command configures the display format to be used when displaying 4-octet ASNs. This configuration
changes only the output format. The input format can be in any mode.

Examples
-> ip bgp asn-format asdot

Release History
Release 7.3.3; command was introduced.

Related Commands

ip bgp autonomous-system Configures the Autonomous System (AS) number for this router.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-33
ip bgp aggregate-address BGP Commands

ip bgp aggregate-address
Creates and deletes a BGP aggregate route. Aggregate routes are used to reduce the size of routing tables
by combining the attributes of several different routes and allowing a single aggregate route to be adver-
tised to peers.
The base command (ip bgp aggregate-address) may be used with other keywords to set up aggregate
address configuration. These keywords are listed here and described as separate commands later in this
chapter. In addition, some keywords have a no form to remove the parameter or return it to its default.
Note that only one of the following optional keywords is specified with each use of the base command.
Keywords are not combined together in a single command.
ip bgp aggregate-address ip_address ip_mask
[admin-state {enable | disable}]
[as-set]
[community string]
[local-preference value]
[metric metric]
[summary-only]
no ip bgp aggregate-address ip_address ip_mask

Syntax Definitions

ip_address 32-bit IP address to be used as the aggregate address.

ip_mask 32-bit subnet mask that determines how many bits of the IP address
denote the network number.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete an aggregate route.

• This command allows administrative operations on a BGP aggregate. You must still enable the
aggregate route through the ip bgp aggregate-address admin-state command.
• You cannot aggregate an address (for example, 100.10.0.0) if you do not have at least one more
specific route of the address (for example, 100.10.20.0) in the BGP routing table.
• Only the aggregate is advertised unless aggregate summarization is disabled using the ip bgp
aggregate-address summary-only command.

page 26-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp aggregate-address

Examples
-> ip bgp aggregate-address 172.22.2.0 255.255.255.0
-> no ip bgp aggregate-address 172.22.2.0 255.255.255.0

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp aggregate-address Enables or disables aggregate summarization, which suppresses

summary-only more-specific routes.

MIB Objects
alaBgpAggrAddr
alaBgpAggrSet
alaBgpAggrCommunity
alaBgpAggrLocalPref
alaBgpAggrMetric
alaBgpAggrSummarize
alaBgpAggrMask

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-35
ip bgp aggregate-address admin-state BGP Commands

ip bgp aggregate-address admin-state

Enables or disables a BGP aggregate route.
ip bgp aggregate-address ip_address ip_mask admin-state {enable | disable}

Syntax Definitions

ip_address 32-bit IP address for this aggregate route.

ip_mask 32-bit subnet mask that determines how many bits of the network
address denote the network number.
enable Enables this aggregate route.
disable Disables this aggregate route.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Configure all aggregate route parameters before enabling the aggregate with this command. Use the ip
bgp aggregate-address command to configure individual aggregate parameters.
• The show ip bgp path command displays every aggregate currently defined.

Examples
-> ip bgp aggregate-address 172.22.2.0 255.255.255.0 admin-state enable
-> ip bgp aggregate-address 172.22.2.0 255.255.255.0 admin-state disable

Release History
Release 8.1.1; command was introduced.

page 26-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp aggregate-address admin-state

Related Commands

ip bgp aggregate-address Creates an aggregate route.

show ip bgp path Displays aggregate routes.

MIB Objects
alaBgpAggrTable
alaBgpAggrAddr
alaBgpAggrMask

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-37
ip bgp aggregate-address as-set BGP Commands

ip bgp aggregate-address as-set

Specifies whether AS path aggregation is to be performed or not. AS path aggregation takes the AS path
for all routes in this aggregate and creates a new AS path for the entire aggregate. This aggregated AS path
includes all the ASs from the routes in the aggregate, but it does not repeat AS numbers if some routes in
the aggregate include the same AS in their path.
ip bgp aggregate-address ip_address ip_mask as-set
no ip bgp aggregate-address ip_address ip_mask as-set

Syntax Definitions

ip_address 32-bit IP address.

ip_mask 32-bit subnet mask that determines how many bits of the IP address
denote the network number.

Defaults
This command is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable the as-set option.

• When AS path aggregation is disabled (the default), the AS path for the aggregate defaults to the AS
number of the local BGP speaker (configured in the ip bgp autonomous-system command).
• If AS path aggregation is enabled, a flap in a more specific path’s AS path will cause a flap in the
aggregate as well.
• Do not use this command when aggregating many paths because of the numerous withdrawals and
updates that must occur as path reachability information for the summarized routes changes.

Examples
-> ip bgp aggregate-address 172.22.2.115 255.255.255.0 as-set
-> no ip bgp aggregate-address 172.22.2.115 255.255.255.0 as-set

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp aggregate-address Creates and deletes a BGP aggregate route.

page 26-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp aggregate-address as-set

MIB Objects
alaBgpAggrTable
alaBgpAggrAddr
alaBgpAggrMask
alaBgpAggrSet

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-39
ip bgp aggregate-address community BGP Commands

ip bgp aggregate-address community

Defines a community for an aggregate route created by the ip bgp aggregate-address command.
Communities are a way of grouping BGP peers that do not share an IP subnet or an AS number.
ip bgp aggregate-address ip_address ip_mask community {none | no-export | no-advertise | no-export-
subconfed | num:num}

Syntax Definitions

ip_address 32-bit IP address of the aggregate route.

ip_mask 32-bit subnet mask that determines how many bits of the IP address
denote the network number.
none Removes the community restrictions on the community section of the
route map.
no-export Routes in this community are advertised within the AS but not beyond
the local AS.
no-advertise Routes in this community are not advertised to any peer.
no-export-subconfed Routes in this community are not advertised to any external BGP peer.
num:num The community number, given in the form of the AS number and the
community number, separated by a colon, as defined in RFC 1997.

Defaults

parameter default
none | no-export | no-advertise none
| no-export-subconfed |
num:num

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
To revert the aggregate community string to the default value, set the community string to none.

Examples
-> ip bgp aggregate-address 172.22.2.115 255.255.255.0 community no-export
-> ip bgp aggregate-address 172.22.2.115 255.255.255.0 community none

Release History
Release 8.1.1; command was introduced.

page 26-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp aggregate-address community

Related Commands

ip bgp aggregate-address Creates and deletes a BGP aggregate route.

MIB Objects
alaBgpAggrTable
alaBgpAggrAddr
alaBgpAggrMask
alaBgpAggrCommunity

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-41
ip bgp aggregate-address local-preference BGP Commands

ip bgp aggregate-address local-preference

Configures the local preference attribute value for this BGP aggregate. This value will override the default
local preference value; it is used when announcing this aggregate to internal peers.
ip bgp aggregate-address ip_address ip_mask local-preference value
no ip bgp aggregate-address ip_address ip_mask local-preference value

Syntax Definitions

ip_address An IP address for the aggregate route.

ip_mask A 32-bit subnet mask that determines how many bits of the IP address
denote the network number.
value The local preference attribute. The valid range is 0–4294967295

Defaults

parameter default
value 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to set the local preference back to the default value.

• You can specify that this route use the default local preference value for the AS by specifying zero (0).
In this case the local preference for this route will take the default local preference value set for this AS
(defined in the ip bgp default local-preference command).

Examples
-> ip bgp aggregate-address 172.22.2.115 255.255.255.0 local-preference 200
-> no ip bgp aggregate-address 172.22.2.115 255.255.255.0 local-preference 200

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp default local-preference Sets the default local preference value for this AS.

page 26-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp aggregate-address local-preference

MIB Objects
alaBgpAggrTable
alaBgpAggrAddr
alaBgpAggrMask
alaBgpAggrLocalPref

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-43
ip bgp aggregate-address metric BGP Commands

ip bgp aggregate-address metric

Configures the MED attribute value for a BGP aggregate. This value is used when announcing this aggre-
gate to internal peers; it indicates the best exit point from the AS.
ip bgp aggregate-address ip_address ip_mask metric value
no ip bgp aggregate-address ip_address ip_mask metric value

Syntax Definitions

ip_address A 32-bit IP address.

ip_mask A 32-bit subnet mask that determines how many bits of the IP address
denote the network number.
value The MED attribute. The valid range is 0–4294967295.

Defaults

parameter default
value 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to reset the aggregate metric back to its default value.

• The default value of zero indicates that a MED will not be sent for this aggregate. When a MED value
is missing for a route, BGP will determine a MED value based upon the settings specified in the ip bgp
bestpath med missing-as-worst command.

Examples
-> ip bgp aggregate-address 172.22.2.115 255.255.255.0 metric 0
-> no ip bgp aggregate-address 172.22.2.115 255.255.255.0 metric 0

Release History
Release 8.1.1; command was introduced.

page 26-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp aggregate-address metric

Related Commands

ip bgp bestpath med missing- Configures the MED for paths that do not contain a MED value.
as-worst
ip bgp always-compare-med Forces BGP to use the MED for comparison of external routes.

MIB Objects
alaBgpAggrTable
alaBgpAggrAddr
alaBgpAggrMask
alaBgpAggrMetric

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-45
ip bgp aggregate-address summary-only BGP Commands

ip bgp aggregate-address summary-only

Enables or disables aggregate summarization, which supresses more-specific routes. Disabling aggregate
summarization means that more-specific routes will be announced to BGP peers (internal and external
peers).
ip bgp aggregate-address ip_address ip_mask summary-only
no ip bgp aggregate-address ip_address ip_mask summary-only

Syntax Definitions

ip_address IP address for the aggreagte route.

ip_mask 32-bit subnet mask that determines how many bits of the IP address
denote the network number.

Defaults
This command is enabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable this feature.

• This command specifies whether more-specific routes should be announced or suppressed.

• By default, aggregate summarization is enabled, which means that only the aggregate entry (for exam-
ple, 100.10.0.0) is advertised. Advertisements of more-specific routes (for example, 100.10.20.0) are
suppressed.

Examples
-> ip bgp aggregate-address 172.22.2.115 255.255.255.0 summary-only
-> no ip bgp aggregate-address 172.22.2.115 255.255.255.0 summary-only

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp aggregate-address Creates and deletes a BGP aggregate route.

page 26-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp aggregate-address summary-only

MIB Objects
alaBgpAggrTable
alaBgpAggrAddr
alaBgpAggrMask
alaBgpAggrSummarize

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-47
ip bgp network BGP Commands

ip bgp network
Creates or deletes a BGP network. A network must be known to the local BGP speaker; it also must origi-
nate from the local BGP speaker. The network may be directly connected, dynamically learned, or static.
In lieu of these options, the base command (ip bgp network) may be used with other keywords to set up
network configuration. These keywords are listed here and described as separate commands later in this
chapter. In addition, some keywords have a no form to remove the parameter or return it to its default.
ip bgp network network_address ip_mask
[community string]
[local-preference value]
[metric metric]
[admin-state {enable | disable}]
no ip bgp network network_address ip_mask

Syntax Definitions

network_address 32-bit IP address.

ip_mask 32-bit subnet mask that determines how many bits of the network
address denote the network number.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete a local network.

• Creating and enabling a network entry indicates to BGP that this network should originate from this
router. The network specified must be known to the router, whether it is connected, static, or dynami-
cally learned.
• You can create up to 200 network entries. The basic show ip bgp path command will display every
network currently defined.
• This command allows administrative operations on a BGP network. You must still enable the network
through the ip bgp network admin-state command.

Examples
-> ip bgp network 172.22.2.115 255.255.255.0
-> no ip bgp network 172.22.2.115 255.255.255.0

Release History
Release 8.1.1; command was introduced.

page 26-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp network

Related Commands

ip bgp network admin-state Enables a BGP network.

MIB Objects
alaBgpNetworkTable
alaBgpNetworkAddr
alaBgpNetwrokMetric
alaBgpNetworkLocalPref
alaBgpNetworkCommunity
alaBgpNetworkMask

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-49
ip bgp network admin-state BGP Commands

ip bgp network admin-state

Enables or disables a BGP network.
ip bgp network network_address ip_mask admin-state {enable | disable}

Syntax Definitions

network_address 32-bit IP address.

ip_mask 32-bit subnet mask that determines how many bits of the network
address denote the network number.
enable Enables this network.
disable Disables this network.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Configure all network parameters before enabling this BGP network with this command. Use the ip
bgp network command to configure individual aggregate parameters.
• You can create up 200 network entries. The show ip bgp path command displays every network
currently defined.

Examples
-> ip bgp network 172.22.2.115 255.255.255.0 admin-state enable

Release History
Release 8.1.1; command was introduced.

page 26-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp network admin-state

Related Commands

ip bgp network Create a BGP network.

show ip bgp path Display currently defined BGP networks.

MIB Objects
alaBgpNetworkTable
alaBgpNetworkAddr
alaBgpNetworkMask

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-51
ip bgp network community BGP Commands

ip bgp network community

Defines a community for a route created by the ip bgp network command. Communities are a way of
grouping BGP peers that do not share an IP subnet or an AS.
ip bgp network network_address ip_mask community {none | no-export | no-advertise | no-export-
subconfed | num:num}

Syntax Definitions

network_address 32-bit IP address of the network.

ip_mask 32-bit subnet mask that determines how many bits of the network
address denote the network number.
none Removes the community restrictions on the community section of the
route map.
no-export Routes in this community are advertised within the AS but not beyond
the local AS.
no-advertise Routes in this community are not advertised to any peer.
no-export-subconfed Routes in this community are not advertised to any external BGP peer.
num:num The community number, given in the form of the AS number and the
community number, separated by a colon, as defined in RFC 1997.

Defaults

parameter default
none | no-export | no-advertise none
| no-export-subconfed |
num:num

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
To revert the network community string to the default value, set the community string to none.

Examples
-> ip bgp network 172.22.2.115 255.255.255.0 community export
-> ip bgp network 172.22.2.115 255.255.255.0 community none

Release History
Release 8.1.1; command was introduced.

page 26-52 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp network community

Related Commands

ip bgp network Creates or deletes a BGP network

MIB Objects
alaBgpNetworkTable
alaBgpNetworkAddr
alaBgpNetworkMask
alaBgpNetworkCommunity

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-53
ip bgp network local-preference BGP Commands

ip bgp network local-preference

Defines the local preference value for a route generated by the ip bgp network command. This value will
override the default local preference value; it is used when announcing this network to internal peers.
ip bgp network network_address ip_mask local-preference value
no ip bgp network network_address ip_mask local-preference value

Syntax Definitions

network_address A 32-bit IP address.

ip_mask A 32-bit subnet mask that determines how many bits of the network
address denote the network number.
value The local preference attribute value. The valid range is 0–4294967295.

Defaults

parameter default
value 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to return the local preference of the specified network to its default
setting.
• You can specify that this route use the default local preference value for the AS by specifying zero (0).
In this case the local preference for this route will take the default local preference value set for this AS
(defined in the ip bgp default local-preference command).

Examples
-> ip bgp network 172.22.2.115 255.255.255.0 local-preference 600
-> no ip bgp network 172.22.2.115 255.255.255.0 local-preference 600

Release History
Release 8.1.1; command was introduced.

page 26-54 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp network local-preference

Related Commands

ip bgp network Creates or deletes a BGP network.

ip bgp default local-preference Sets the default local preference for this AS.

MIB Objects
alaBgpNetworkTable
alaBgpNetworkAddr
alaBgpNetworkMask
alaBgpNetworkLocalPref

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-55
ip bgp network metric BGP Commands

ip bgp network metric

Configures the Multi-Exit Discriminator (MED) attribute value for an network generated by the ip bgp
network command. This value is used when announcing this network to internal peers; it indicates the
best exit point from the AS.
ip bgp network network_address ip_mask metric value
no ip bgp network network_address ip_mask metric value

Syntax Definitions

network_address A 32-bit IP address.

ip_mask A 32-bit subnet mask that determines how many bits of the network
address denote the network number.
value A MED attribute value. The valid range is 0–4294967295.

Defaults

parameter default
value 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to return the metric for this network to its default value.

• The default value of zero indicates that a MED will not be sent for this network. When a MED value is
missing for a route, BGP will determine a MED value based upon the settings specified in the ip bgp
bestpath med missing-as-worst command.

Examples
-> ip bgp network 172.22.2.115 255.255.255.0 metric 100
-> no ip bgp network 172.22.2.115 255.255.255.0 metric 100

Release History
Release 8.1.1; command was introduced.

page 26-56 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp network metric

Related Commands

ip bgp network Creates or deletes a BGP network.

ip bgp bestpath med missing- Specifies the MED value when it is missing.
as-worst

MIB Objects
alaBgpNetworkTable
alaBgpNetworkAddr
alaBgpNetworkMask
alaBgpNetwrokMetric

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-57
ip bgp neighbor BGP Commands

ip bgp neighbor
Creates or deletes a BGP peer.
ip bgp neighbor ip_address
no ip bgp neighbor ip_address

Syntax Definitions

ip_address 32-bit IP address of the new BGP peer.

Defaults
No peers configured.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete a BGP peer.

• You must still enable a BGP peer after creating it. A BGP peer is enabled using the ip bgp neighbor
admin-state command.
• Once created, a BGP peer cannot be enabled until it is assigned an autonomous system number using
the ip bgp neighbor remote-as command.

Examples
-> ip bgp neighbor 172.22.2.115
-> no ip bgp neighbor 172.22.2.115

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp neighbor admin-state Enable or disable a BGP peer.

ip bgp neighbor remote-as Configure the AS number for the peer.

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr

page 26-58 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor admin-state

ip bgp neighbor admin-state

Enables or disables a BGP peer.
ip bgp neighbor ip_address admin-state {enable | disable}

Syntax Definitions

ip_address 32-bit IP address of the new BGP peer.

enable Enables this peer.
disable Disables this peer.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• You must first create a peer and assign it an IP address using the ip bgp neighbor command before
enabling the peer.
• Configure all BGP peer related commands before enabling a peer using this command. Once you
enable the peer it will begin sending BGP connection and route advertisement messages.

Examples
-> ip bgp neighbor 172.22.2.115 admin-state enable
-> ip bgp neighbor 172.22.2.115 admin-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp neighbor Creates a BGP peer.

show ip bgp neighbors Displays peer parameters.

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-59
ip bgp neighbor advertisement-interval BGP Commands

ip bgp neighbor advertisement-interval

Configures the time interval for updates between external BGP peers.
ip bgp neighbor ip_address advertisement-interval value

Syntax Definitions

ip_address 32-bit IP address of the neighbor.

value An advertisement time interval in seconds. The valid range is 0–65535.

Defaults

parameter default
value 30

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Internal peers sharing the same AS as the local BGP speaker (configured in the ip bgp autonomous-
system command) use the global route advertisement update interval. This command sets the interval this
peer uses to send BGP UPDATE messages to external peers.

Examples
-> ip bgp neighbor 172.22.2.115 255.255.255.0 advertisement-interval 60

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip bgp neighbors Displays BGP peer main status.

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
bgpPeerMinRouteAdvertisementTinterval

page 26-60 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor clear

ip bgp neighbor clear

Restarts a BGP peer. The peer will be unavailable during this restart.
ip bgp neighbor ip_address clear

Syntax Definitions

ip_address 32-bit IP address of the neighbor.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use this command whenever changes occur to BGP-related access lists, weights, distribution lists,
timer specifications, or administrative distance.
• Many peer commands restart the peer as soon as they are configured. The following commands restart
the BGP peer for which they are configured:
ip bgp neighbor remote-as
ip bgp neighbor md5 key
ip bgp neighbor passive
ip bgp neighbor ebgp-multihop
ip bgp neighbor maximum-prefix
ip bgp neighbor update-source
ip bgp neighbor next-hop-self
ip bgp neighbor soft-reconfiguration
ip bgp neighbor route-reflector-client
ip bgp confederation neighbor
ip bgp neighbor remove-private-as
ip bgp neighbor update-source.
• You do not need to issue the ip bgp neighbor clear command after issuing any of the above
commands.

Examples
-> ip bgp neighbor 172.22.2.115 clear

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-61
ip bgp neighbor clear BGP Commands

Related Commands

ip bgp neighbor auto-restart Automatically attempts to restart a BGP peer session after a session
terminates.

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
alaBgpPeerRestart

page 26-62 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor route-reflector-client

ip bgp neighbor route-reflector-client

Configures this peer as a client to the local route reflector.
ip bgp neighbor ip_address route-reflector-client
no ip bgp neighbor ip_address route-reflector-client

Syntax Definitions

ip_address 32-bit IP address of the neighbor.

Defaults
This command is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove this peer as a client to the local route reflector.

• This command configures this peer as one of the clients to the local route reflector.

• All of the peers configured using this command become part of the client group. The remaining peers
are members of the non-client group for the local route reflector.
• When route reflection is configured all of the internal BGP speakers in an autonomous system need not
be fully meshed. The route reflector take responsibility for passing internal BGP-learned routes to its
peers.

Examples
-> ip bgp neighbor 172.22.2.115 route-reflector-client
-> no ip bgp neighbor 172.22.2.115 route-reflector-client

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp client-to-client reflection Configures the local BGP speaker as a route reflector

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
alaBgpPeerClientStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-63
ip bgp neighbor default-originate BGP Commands

ip bgp neighbor default-originate

Enables or disables BGP peer default origination.
ip bgp neighbor ip_address default-originate
no ip bgp neighbor ip_address default-originate

Syntax Definitions

ip_address 32-bit IP address of the neighbor.

Defaults
This command is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable this feature.

• When this command is enabled, the local BGP speaker advertises itself as a default to the peer. Such a
default route overrides any learned default (propagation) and outbound policy. The default route 0.0.0.0
does not need to exist on the local router.

Examples
-> ip bgp neighbor 172.22.2.115 default-originate
-> no ip bgp neighbor 172.22.2.115 default-originate

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp neighbor Creates or deletes a BGP peer.

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
alaBgpPeerDefaultOriginate

page 26-64 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor timers

ip bgp neighbor timers

Configures the KEEPALIVE message interval and hold time interval (in seconds) with regards to the
specified peer.
ip bgp neighbor ip_address timers keepalive holdtime

Syntax Definitions

ip_address A 32-bit IP address for the BGP peer.

keepalive The interval (in seconds) between KEEPALIVE messages. The valid
values are zero (0) or the range 1–21845.
holdtime The hold time interval between updates to peers, in seconds. The valid
range is 0, 3–65535.

Defaults

parameter default
keepalive 30
holdtime 90

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Configures the time interval between KEEPALIVE messages sent by this peer. KEEPALIVE messages
do not contain route updates or indicate a change in the status of the BGP peer; they serve only to tell
the receiving BGP peer that the connection is still live and the peer is reachable.
• By default, the keep alive interval of 30 seconds is one-third the default hold-time interval of 90
seconds. The keep alive interval can never be more than one-third the value of the hold-time interval.
When the hold interval is reached without receiving keep alive or other updates messages, the peer is
considered dead.
• Setting the keep alive value to zero means no keep alive messages will be sent.

• Once a connection is established with a peer and a time period of the length specified in this command
transpires with no messages from the remote peer, then the connection with that remote peer will be
considered dead.
• Configures the tolerated hold time interval, in seconds, for messages to this peer from other peers. The
hold timer is used during the connection setup process and in on-going connection maintenance with
BGP peers. If this peer does not receive a KEEPALIVE, UPDATE, or NOTIFICATION message
within this time period, then the BGP connection will be closed.
• By default, the hold-interval of 180 seconds is three times the default keep-alive interval of 60 seconds.
The hold-interval can never be less than three times the keep-alive value.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-65
ip bgp neighbor timers BGP Commands

• You must restart the peer (using the ip bgp neighbor clear command) after issuing this command
before the new hold time interval takes effect.
• Both values must be set at the same time.

• Entering this command without the variables resets the variables to their default value.

Examples
-> ip bgp neighbor 172.22.2.115 timers 80 240
-> ip bgp neighbor 172.22.2.115 timers

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp neighbor conn-retry- The interval, in seconds, between BGP retries to set up a connec-
interval tion through the transport protocol with another peer.

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
bgpPeerHoldTimeConfigured
bgpPeerKeepAliveConfigured

page 26-66 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor conn-retry-interval

ip bgp neighbor conn-retry-interval

The interval, in seconds, between BGP retries to set up a connection through the transport protocol
with another peer. In the connect state, BGP tries to set up a connection with a remote peer. If the
connection fails, then the connect retry interval is started. Once this interval elapses, BGP retries
setting up the connection.
ip bgp neighbor ip_address conn-retry-interval seconds

Syntax Definitions

ip_address A 32-bit IP address for the neighbor.

seconds The time interval (in seconds) between retries. The valid range is 0–
65535.

Defaults

parameter default
seconds 120

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The time interval is started when a connection to a peer is lost.

• Other BGP peers may automatically attempt to restart a connection with this peer if they have
configured automatic peer session restart (using the ip bgp neighbor auto-restart command).
• You must restart the peer (using the ip bgp neighbor clear command) after issuing this command
before the new connection retry interval takes effect.
• Entering this command without the seconds variable resets the variable to its default value.

Examples
-> ip bgp neighbor 172.22.2.115 connect-interval 60
-> ip bgp neighbor 172.22.2.115 connect-interval

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-67
ip bgp neighbor conn-retry-interval BGP Commands

Related Commands

ip bgp neighbor auto-restart Enable automatic session restart after a session termination.
ip bgp neighbor clear Restarts the peer.

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
bgpPeerConnectRetryInterval

page 26-68 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor auto-restart

ip bgp neighbor auto-restart

Enables or disables BGP peer automatic restart. When enabled, this peer will automatically attempt to
restart a session with another peer after a session with that peer terminates. When disabled, this peer will
not try to re-establish a session with another peer after the session terminates; in such a case, the other peer
will have to restart the session for the two peers to resume communication.
ip bgp neighbor ip_address auto-restart

Syntax Definitions

ip_address 32-bit IP address for the neighbor.

Defaults
This command is enabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable automatic peer restart.

• After a session with another peer terminates, the local BGP speaker will wait 60 seconds before
attempting to restart the session. If the session does not start on the first attempt a second attempt will
be made after another 120 seconds (60x2). On each unsuccessful session attempt, the previous delay
between restarts is multiplied by 2, up to a maximum delay of 240 seconds. An exception to this rule
occurs when the peer session terminates on receipt of a NOTIFY message with 'unsupported option'
code or 'unsupported capability' code; in these cases the delay between restart attempts will begin at 1
second and multiply by 2 after each unsuccessful restart attempt (up to a maximum of 240 second
delay).
• Disabling this option can be helpful in cases where other peers are prone to frequent flapping or
sending many NOTIFY messages. By not restarting sessions with unstable neighbors, the local BGP
speaker forces those unstable neighbors to re-initialize the connection.

Examples
-> ip bgp neighbor 172.22.2.115 auto-restart
-> no ip bgp neighbor 172.22.2.115 auto-restart

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-69
ip bgp neighbor auto-restart BGP Commands

Related Commands

ip bgp neighbor Creates a BGP peer.

ip bgp neighbor admin-state Enables a BGP peer.

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
alaBgpPeerAutoRestart

page 26-70 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor maximum-prefix

ip bgp neighbor maximum-prefix

Configures the maximum number of prefixes, or paths, the local router can receive from this peer in
UPDATE messages.
ip bgp neighbor ip_address maximum-prefix maximum [warning-only]

Syntax Definitions

ip_address A 32-bit IP address of the BGP peer.

maximum The maximum number of prefixes. The valid range is 0–4294967295.

Defaults

parameter default
threshold 5000

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When the number of prefixes sent by this peer reaches this limit, the peer is restarted.

• You can use BGP logging to receive a warning when the number of prefixes received from this peer
reaches 80 percent of the value you configure in this command.
• If the warning-only prefix is used, the operator will be warned when the peer exceeds 80 percent of
the configured number of maximum prefixes.
• The BGP peer is restarted after issuing this command.

Examples
-> ip bgp neighbor 172.22.2.115 maximum-prefix 1000
-> ip bgp neighbor 172.22.2.115 maximum-prefix 1000 warning only

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp neighbor clear Restarts the BGP peer.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-71
ip bgp neighbor maximum-prefix BGP Commands

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
alaBgpPeerMaxPrefixWarnOnly
alaBgpPeerMaxPrefix

page 26-72 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor md5 key

ip bgp neighbor md5 key

Sets an encrypted MD5 signature for TCP sessions with this peer in compliance with RFC 2385.
ip bgp neighbor ip_address md5 key {string | none}

Syntax Definitions

ip_address 32-bit IP address of the BGP peer.

string The MD5 public key. Maximum character length is 200.
none Removes the MD5 public key.

Defaults

parameter default
string no password

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Entering the keyword none in place of a key removes the password and disables authentication.

• Due to security concerns the actual password that you specify in this command is encrypted using a
3DES algorithm before it appears in a saved snapshot file. Also, if you were to view this command in a
snapshot file, or vcboot.cfg file, it would appear in a different syntax. The syntax for this command
used in snapshot files is as follows:
ip bgp neighbor ip_address md5 key-encrypt encrypted_string
However, you should not use this syntax to actually set an MD5 password; it will not work.
• The BGP peer is restarted after issuing this command.

Examples
-> ip bgp neighbor 172.22.2.115 md5 key openpeer5

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-73
ip bgp neighbor md5 key BGP Commands

Related Commands

ip bgp neighbor clear Restarts the BGP peer.

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
alaBgpPeerMD5Key

page 26-74 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor ebgp-multihop

ip bgp neighbor ebgp-multihop

Allows external peers to communicate with each other even when they are not directly connected. The
absence of communication between disconnected peers can occur when a router that is not running BGP
sits between two BGP speakers; in such a scenario the BGP speakers are multiple hops from each other.
By enabling this command, you allow the BGP peers to speak to each other despite the non-BGP router
that sits between them.
ip bgp neighbor ip_address ebgp-multihop [ttl]
no ip bgp neighbor ip_address ebgp-multihop

Syntax Definitions

ip_address 32-bit IP address of the BGP peer.

ttl The Time to Live for the multi-hop connection, in seconds. The range is
1 to 255.

Defaults

parameter default
ttl 255

This command is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable multi-hop connections.

• By default an external BGP peer is on a directly connected subnet. This command allows you to
configure an external BGP peer that is not directly connected and may be multiple hops away. It should
be used with caution and only with the guidance of qualified technical support.
• As a safeguard against loops, the multi-hop connection will not be made if the only route to a multi-
hop peer is the default route (0.0.0.0).
• The BGP peer is restarted after issuing this command.

Examples
-> ip bgp neighbor 172.22.2.115 ebgp-multihop 250
-> no ip bgp neighbor 172.22.2.115 ebgp-multihop 50

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-75
ip bgp neighbor ebgp-multihop BGP Commands

Related Commands

ip bgp neighbor Creates or deletes a BGP peer.

ip bgp neighbor next-hop-self Sets the BGP peer to use next hop processing behavior.

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
alaBgpPeerMultiHop

page 26-76 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor description

ip bgp neighbor description

Configures the BGP peer name.
ip bgp neighbor ip_address description string

Syntax Definitions

ip_address 32-bit IP address of the BGP peer.

string Peer name (1 - 20 characters).

Defaults

parameter default
string peer(ip_address)

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The peer name is a text identifier that, by default, follows the format “peer(x.x.x.x)” where x.x.x.x is
the IP address of the BGP peer. For example, the default name of a peer at address 198.216.14.23
would be “peer(198.216.14.23)”.
• A peer name with embedded spaces must be enclosed in quotation marks.

Examples
-> ip bgp neighbor 172.22.2.115 description “peer for building 3”

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp neighbor Sets the IP address for the peer.

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
alaBgpPeerName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-77
ip bgp neighbor next-hop-self BGP Commands

ip bgp neighbor next-hop-self

Sets the BGP peer to use next hop processing behavior. By default, the next-hop processing of BGP
updates is disabled. Using this command to enable next-hop behavior may be useful in non-meshed
networks where BGP peers do not have direct access to other peers.
ip bgp neighbor ip_address next-hop-self
no ip bgp neighbor ip_address next-hop-self

Syntax Definitions

N/A

Defaults
This command is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable next hop processing behavior.

• In partially meshed networks a BGP peer may not have direct connections to other peers. When such a
peer receives route updates from these distant peers (through other peers), it may treat the remote peer
as if it were the next hop in the routing path. Packet forwarding will not work in such a case because no
direct connection exists. This command allows this peer to deem itself the next hop on the routing path
so that the two non-connected peers can route packets. This peer would have a direct connection to
both peers that want to exchange packets.
• The BGP peer is restarted after issuing this command.

Examples
-> ip bgp neighbor 172.22.2.115 next-hop-self
-> no ip bgp neighbor 172.22.2.115 next-hop-self

Release History
Release 8.1.1; command was introduced.

page 26-78 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor next-hop-self

Related Commands

ip bgp neighbor Creates or deletes a BGP peer.

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
alaBgpPeerNextHopSelf

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-79
ip bgp neighbor passive BGP Commands

ip bgp neighbor passive

Configures the local BGP speaker to wait for this peer to establish a connection. When enabled, the local
BGP speaker will not initiate a peer session with this peer; in this sense, the BGP speaker is “passive.”
When disabled, the local BGP speaker will attempt to set up a session with this peer.
ip bgp neighbor ip_address passive
no ip bgp neighbor ip_address passive

Syntax Definitions

ip_address 32-bit IP address of the BGP peer.

Defaults
This command is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable passive peer behavior.

• By default BGP will initiate a session to a peer once the peer is configured, has an AS number, and is
enabled. You can use this command to configure the local BGP speaker as passive and an outbound
session will not be initiated to this peer. For such peers, BGP will always wait passively for the
inbound session attempt.
• The BGP peer is restarted after issuing this command.

Examples
-> ip bgp neighbor 172.22.2.115 passive
-> no ip bgp neighbor 172.22.2.115 passive

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp neighbor Creates or deletes a BGP peer.

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
alaBgpPeerPassive

page 26-80 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor remote-as

ip bgp neighbor remote-as

Assigns an AS number to this BGP peer.
ip bgp neighbor ip_address remote-as value

Syntax Definitions

ip_address 32-bit IP address of the BGP peer.

value Autonomous system number in the asplain, asdot+, or asdot formats.

Defaults

parameter default
value 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• A BGP peer created with the ip bgp neighbor command cannot be enabled (ip bgp neighbor admin-
state enable) until it is assigned an autonomous system number. If the AS number matches the AS
number assigned to the local BGP speaker (assigned using the ip bgp autonomous-system command),
the peer is considered internal to the local autonomous system. Otherwise, the peer is consider external
to the local BGP speaker’s AS.
• This BGP peer may not be operational within this router and it may be in an external AS, but it must
still be configured on this router before the local BGP speaker can establish a connection to the peer.
The local BGP speaker does not auto-discover peers in other routers; it initially learns about peers
through the peer commands.
• The BGP peer is restarted after issuing this command.

• The 4-octet ASN is represented in one of three ways:

– asplain (simple decimal notation)
– asdot+ (two 16-bit values as low-order and high-order)
– asdot (a mixture of asplain and asdot+).

Examples
-> ip bgp neighbor 172.22.2.115 remote-as 100

The following examples show how to configure the BGP neighbor ASN as 65535 in the
three different formats:
-> ip bgp neighbor 2.2.2.2 remote-as 65535 (asplain format)
-> ip bgp neighbor 2.2.2.2 remote-as 0.65535 (asdot+ format)
-> ip bgp neighbor 2.2.2.2 remote-as 65535 (asdot format)

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-81
ip bgp neighbor remote-as BGP Commands

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp autonomous-system Set the AS for the local BGP speaker.

ip bgp neighbor Create a BGP peer.
ip bgp neighbor admin-state Enables a BGP peer.
enable

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
alaBgpPeerAS

page 26-82 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor remove-private-as

ip bgp neighbor remove-private-as

Enables or disables the stripping of private autonomous system numbers from the AS path of routes
destined to this peer.
ip bgp neighbor ip_address remove-private-as
no ip bgp neighbor ip_address remove-private-as

Syntax Definitions

ip_address 32-bit IP address of the BGP peer.

Defaults
This command is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable stripping of private AS numbers.

• By default all AS numbers in the AS path are passed to peers. Enabling his command strips any private
AS numbers in the AS path before sending updates to this peer. AS numbers in the range 64512 to
65535 are considered private ASs; they intended for internal use within an organization (such as an
enterprise network), but they are not intended for use on public networks (such as the Internet).
• This command has no effect if you are not using ASs in the range 64512 to 65535.

• The BGP peer is restarted after issuing this command.

Examples
-> ip bgp neighbor 172.22.2.115 remove-private-as
-> no ip bgp neighbor 172.22.2.115 remove-private-as

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp neighbor remote-as Configures the AS number for this peer.

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
alaBgpPeerRemovePrivateAs

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-83
ip bgp neighbor soft-reconfiguration BGP Commands

ip bgp neighbor soft-reconfiguration

Enables or disables BGP peer soft reconfiguration. Soft reconfiguration increases the stability of the peer
by allowing you to reconfigure attributes that require peer resets without halting the TCP connection with
other peers.
ip bgp neighbor ip_address soft-reconfiguration
no ip bgp neighbor ip_address soft-reconfiguration

Syntax Definitions

ip_address 32-bit IP address of the BGP peer.

Default
This command is enabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable this feature.

• This feature stores routes and other configuration information in local memory. When you make
configuration changes that require a peer reset, the routing cache is not cleared and connections with
other peers are not interrupted.
• By default BGP stores all paths from peers, even those that are policy rejected, in anticipation of policy
changes in the future. Storing these paths consumes memory. You can use this command to disable the
storing of these paths, or soft reconfiguration. However, if soft reconfiguration is disabled and the
inbound policy changes, the peer will have to be restarted using the ip bgp neighbor out-aspathlist
command.
• The BGP peer is restarted after issuing this command.

Examples
-> ip bgp neighbor 172.22.2.115 soft-reconfiguration
-> no ip bgp neighbor 172.22.2.115 soft-reconfiguration

Release History
Release 8.1.1; command was introduced.

page 26-84 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor soft-reconfiguration

Related Commands

ip bgp neighbor clear Restarts this BGP peer.

ip bgp neighbor out-aspathlist Resets inbound policies to this peer.

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
alaBgpPeerSoftReconfig

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-85
ip bgp neighbor stats-clear BGP Commands

ip bgp neighbor stats-clear

Clears the statistics for a peer.
ip bgp neighbor ip_address stats-clear

Syntax Definitions

ip_address 32-bit IP address of the BGP peer.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command clears the statistical variables for a peer so they can accumulate from a known point.

• The cleared statistics include the total messages sent and received from this peer, the total UPDATE
messages sent and received from this peer, the total NOTIFY messages sent and received from this
peer, and the total peer state transition messages sent and received from this peer. These statistics can
be displayed through show ip bgp neighbors statistics.

Examples
-> ip bgp neighbor 172.22.2.115 stats-clear

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip bgp neighbors statistics Displays peer statistics.

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
alaBgpPeerClearCounter

page 26-86 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp confederation neighbor

ip bgp confederation neighbor

Configures this peer as a member of the same confederation as the local BGP speaker.
ip bgp confederation neighbor ip_address
no ip bgp confederation neighbor ip_address

Syntax Definitions

ip_address 32-bit IP address of the peer.

Defaults
This command is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable this feature.

• You must first assign a confederation number to the local BGP speaker before assigning peers to the
confederation. Use the ip bgp confederation identifier command to assign a confederation number to
the local BGP speaker.
• The BGP peer is restarted after issuing this command.

Examples
-> ip bgp confederation neighbor 172.22.2.115
-> no ip bgp confederation neighbor 172.22.2.115

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp confederation identifier Sets a confederation identification value for the local BGP speaker
(this router).

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
alaBgpPeerConfedStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-87
ip bgp neighbor update-source BGP Commands

ip bgp neighbor update-source

Configures the local address from which this peer will be contacted. This local address can be configured
for internal and external BGP peers.
ip bgp neighbor ip_address update-source [interface_name]

Syntax Definitions

ip_address The 32-bit IP address for this peer.

interface_name The name of the interface.

Defaults

parameter default
interface_address 0.0.0.0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This address does not override the router identification for this BGP peer (configured in the ip bgp
neighbor command). It is the address through which this peer can be contacted within this router. The
router identification for a peer, especially an external peer, may not exist in the local router, but that
distant peer can still be contacted through this router. This command sets the local address through
which this distant peer can be contacted.
• The default is restored by entering the command without a IP address.

• The BGP peer is restarted after issuing this command.

• The update-source is not related to the router-id, it specifies the interface to be used for the TCP
connection endpoint. By default, the nearest interface is selected.

Examples
-> ip bgp neighbor 172.22.5.115 update-source 172.22.2.117
-> ip bgp neighbor 172.22.5.115 update-source vlan-22
-> ip bgp neighbor 172.22.5.115 update-source

Release History
Release 8.1.1; command was introduced.

page 26-88 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor update-source

Related Commands

ip bgp neighbor Sets the router identification for a BGP peer.

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
alaBgpPeerLocalAddr
alaBgpPeerLocalIntfName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-89
ip bgp neighbor in-aspathlist BGP Commands

ip bgp neighbor in-aspathlist

Assigns an inbound AS path list filter to a BGP peer.
ip bgp neighbor ip_address in-aspathlist {string | none}

Syntax Definitions

ip_address 32-bit IP address of the BGP peer.

string Inbound AS path list (0 to 70 characters). This name is case sensitive.
none Removes this AS path list from the peer.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The AS path list name (InboundASpath in the example below) is created using the ip bgp policy
aspath-list command. Any inbound routes from the BGP peer must match this AS path filter before
being accepted or passed to inbound policy.
• To deassign an input AS path filter list, use this command to assign a value of none.

Examples
-> ip bgp neighbor 172.22.2.115 in-aspathlist InboundASpath
-> ip bgp neighbor 172.22.2.115 in-aspathlist none

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy aspath-list Creates or removes an AS path list.

MIB Objects
alaBgpPeerTable
alaBgpPeerAspathListIn

page 26-90 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor in-communitylist

ip bgp neighbor in-communitylist

Assigns an inbound community list filter to a BGP peer.
ip bgp neighbor ip_address in-communitylist {string | none}

Syntax Definitions

ip_address 32-bit IP address of the BGP peer.

string Input community list (0 to 70 characters. This name is case sensitive.
none Removes this community list from the peer.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The community filter list name (InboundCommlist in the example below) is created using the ip bgp
policy community-list command. Any inbound routes from the BGP peer must match this community
filter before being accepted or passed to inbound policy.
• To deassign an input community filter list, use this command to assign a value of “none.”

Examples
-> ip bgp neighbor 172.22.2.115 in-communitylist InboundCommlist
-> ip bgp neighbor 172.22.2.115 in-communitylist none

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy community-list Creates or deletes a community list.

MIB Objects
alaBgpPeerTable
alaBgpPeerCommunityListIn

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-91
ip bgp neighbor in-prefixlist BGP Commands

ip bgp neighbor in-prefixlist

Assigns an inbound prefix filter list to a BGP peer.
ip bgp neighbor ip_address in-prefixlist {string | none}

Syntax Definitions

ip_address 32-bit IP address.

string Input prefix filter list (0 to 70 characters). This name is case sensitive.
none Removes the prefix list from the peer.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The prefix list name (InboundPrefix in the example below) is created using the ip bgp policy prefix-
list command. Any inbound routes from the BGP peer must match this prefix filter before being
accepted or passed to inbound policy.
• To deassign an input prefix filter list, use this command to assign a value of “none.”

Examples
-> ip bgp neighbor 172.22.2.115 in-prefixlist InboundPrefix
-> ip bgp neighbor 172.22.2.115 in-prefixlist none

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy prefix-list Creates or deletes a prefix match list.

MIB Objects
alaBgpPeerTable
alaBgpPeerPrefixListIn

page 26-92 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor out-aspathlist

ip bgp neighbor out-aspathlist

Assigns an outbound AS path filter list to a BGP peer.
ip bgp neighbor ip_address out-aspathlist {string | none}

Syntax Definitions

ip_address 32-bit IP address of the BGP peer.

string Outbound AS path list (0 - 70 characters).
none Removes the AS path list from the peer.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The AS path list name (OutboundASpath in the example below) is created using the ip bgp policy
aspath-list command. Any outbound routes from the BGP peer must match this AS path filter, or
policy, before being advertised or passed to outbound policy.
• To deassign an output AS path filter list, use this command to assign a value of “none”.

Examples
-> ip bgp neighbor 172.22.2.115 out-aspathlist OutboundASpath
-> ip bgp neighbor 172.22.2.115 out-aspathlist none

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy aspath-list Creates or removes an AS path list.

MIB Objects
alaBgpPeerTable
alaBgpPeerAspathListOut

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-93
ip bgp neighbor out-communitylist BGP Commands

ip bgp neighbor out-communitylist

Assigns an outbound community filter list to a BGP peer.
ip bgp neighbor ip_address out-communitylist {string | none}

Syntax Definitions

ip_address 32-bit IP address of the BGP peer.

string Outbound community list (0 - 70 characters).
none Removes the community list from the peer.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The community filter list name (OutboundCommlist in the example below) is created using the ip
bgp policy community-list command. Any outbound routes from the BGP peer must match this
community filter before being advertised or passed to outbound policy.
• To deassign an output community filter list, use this command to assign a value of “none”.

Examples
-> ip bgp neighbor 172.22.2.115 out-communitylist OutboundCommlist
-> ip bgp neighbor 172.22.2.115 out-communitylist none

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy community-list Creates or deletes a community list.

MIB Objects
alaBgpPeerTable
alaBgpPeerCommunityListOut

page 26-94 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor out-prefixlist

ip bgp neighbor out-prefixlist

Assigns an outbound prefix filter list to a BGP peer.
ip bgp neighbor ip_address out-prefixlist {string | none}

Syntax Definitions

ip_address 32-bit IP address of the BGP peer.

string Output prefix filter list (0 - 70 characters).
none Removes the prefix list from the peer.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The prefix list name (OutboundPrefix in the example below) is created using the ip bgp policy
prefix-list command. Any outbound routes from the BGP peer must match this prefix filter before
being advertised or passed to outbound policy.
• To deassign an output prefix filter list, use this command to assign a value of “none”.

Examples
-> ip bgp neighbor 172.22.2.115 out-prefixlist OutboundPrefix
-> ip bgp neighbor 172.22.2.115 out-prefixlist none

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy prefix-list Creates or deletes a prefix match list.

MIB Objects
alaBgpPeerTable
alaBgpPeerPrefixListOut

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-95
ip bgp neighbor route-map BGP Commands

ip bgp neighbor route-map

Assigns an inbound policy map to a BGP peer.
ip bgp neighbor ip_address route-map {string | none} {in | out}
no ip bgp neighbor ip_address route-map {in | out}

Syntax Definitions

ip_address 32-bit IP address of the peer.

string Inbound policy map name (0 to 70 characters). This name is case sensi-
tive.
none Deletes the route map if entered rather than a text string.
in Designates this route map policy as an inbound policy.
out Designates this route map policy as an outbound policy.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to deassign an inbound map.

• The policy route map name (peeringPointAMap in the example below) is created using the ip bgp
policy prefix6-list command. Any inbound routes from the BGP peer must match this route map filter
before being accepted or passed to inbound policy.
• It is also possible to deassign a route map by entering none in place of a route map name.

Examples
-> ip bgp neighbor 172.22.2.115 route-map InboundRoute in
-> ip bgp neighbor 172.22.2.115 route-map OutboundRoute out
-> ip bgp neighbor 172.22.2.115 route-map none in
-> no ip bgp neighbor 172.22.2.115 route-map in

Release History
Release 8.1.1; command was introduced.

page 26-96 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor route-map

Related Commands

ip bgp policy prefix6-list Creates or deletes a policy route map.

MIB Objects
alaBgpPeerTable
alaBgpPeerRouteMapOut
alaBgpPeerRouteMapIn

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-97
ip bgp neighbor clear soft BGP Commands

ip bgp neighbor clear soft

Invokes an inbound or outbound policy reconfiguration for a BGP peer.
ip bgp neighbor ip_address clear soft {in | out}

Syntax Definitions

ip_address 32-bit IP address for the BGP peer.

in Applies reconfiguration to the inbound policies.
out Applies reconfiguration to the outbound policies.

Default
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command reconfigures (or reapplies) all inbound or outbound policies to existing routes without
restarting the peer session.
• This command is useful if policies have been changed.

Examples
-> ip bgp neighbor 172.22.2.115 clear soft in
-> ip bgp neighbor 172.22.2.115 clear soft out

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp neighbor soft- Enables or disables BGP peer soft reconfiguration.

reconfiguration

MIB Objects
alaBgpPeerTable
alaBgpPeerReconfigureInBound
alaBgpPeerReconfigureOutBound

page 26-98 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy aspath-list

ip bgp policy aspath-list

Creates or removes an AS path list.
ip bgp policy aspath-list name “regular_expression”
no ip bgp policy aspath-list name “regular_expression”

Syntax Definitions

name AS path name, e.g., InboundAspath, ranging from 0 to 70 characters, or

a value of none. The AS path name is case sensitive.
regular_expression Regular expression, e.g., “^100 200$” where 100 (followed by a space)
represents the beginning of the list and 200 represents the end. The reg-
ular expression must be enclosed by quotation marks.

Defaults
No IP BGP peer policy AS path-list exists.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an AS path list.

• To create an AS path list, use the ip bgp policy aspath-list command.

• A regular expression consists of a character string presented in the form of a pattern, e.g., ^100 200$.
Valid regular expression characters (metacharacters) are shown in the table below. See also “Configur-
ing BGP” in your Advanced Routing Guide for more information on using regular expressions in BGP
commands.
•

Symbol Description
^ Matches the beginning of the AS path list.
123 Matches the AS number 123.
. Matches any single AS number.
? Matches zero or one occurrence of the previous token, which must be an AS number, a dot, an
alternation or a range.
+ Matches one or more occurrences of the previous token, which must be an AS number, a dot,
an alternation or a range.
* Matches zero or more occurrences of the previous token, which must be an AS number, a dot,
an alternation or a range.
( Begins an alternation sequence of AS numbers. It matches any AS number listed in the alterna-
tion sequence.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-99
ip bgp policy aspath-list BGP Commands

Symbol Description
| Separates AS numbers in an alternation sequence.
) Ends an alternation sequence of AS numbers
[ Begins a range pair consisting of two AS numbers separated by a dash. It matches any AS
number within that inclusive range.
- Separates the endpoints of a range.
] Ends a range pair.
$ Matches the end of the AS path list.
,_ Commas, underscores and spaces are ignored.

• When using a regular expression in the CLI, the regular expression must be enclosed in quotation
marks.
• This command creates AS path lists that can be applied to a peer’s inbound and outbound routes using
the ip bgp neighbor in-aspathlist and ip bgp neighbor out-aspathlist commands. The AS path list
filters routes based on one or more regular expressions, as shown in the example below. If the route
matches the AS path list filter, then the permit or deny action (i.e., policy) associated with the regular
expression applies.
• If a BGP AS path list is configured to deny routes from a particular string of regular expression, then
by default all of the routes coming from any AS would be denied. You must configure the policy
instance in the same policy to allow other routes to come in, to be permitted from other ASs.
• General or more specific AS path list information can be displayed by varying the use of the show ip
bgp command.

Examples
-> ip bgp policy aspath-list InboundAspath “^100 200$”
-> ip bgp policy aspath-list OutboundAspath “^300 400$”
-> no ip bgp policy aspath-list InboundAspath “^100 200$”

Release History
Release 8.1.1; command was introduced.

page 26-100 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy aspath-list

Related Commands

ip bgp neighbor in-aspathlist Assigns an inbound AS path list filter to a BGP peer.
ip bgp neighbor out-aspathlist Assigns an outbound AS path list filter to a BGP peer.
ip bgp policy aspath-list action Configures a policy action (either permit or deny a route from pass-
ing) to be taken for an AS path list when a match is found.
ip bgp policy aspath-list Configures priority for processing regular expressions in an AS path
priority list.

MIB Objects
alaBgpAspathMatchListTable
alaBgpAspathMatchListRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-101
ip bgp policy aspath-list action BGP Commands

ip bgp policy aspath-list action

Configures a policy action (either permit or deny a route from passing) to be taken for an AS path list
when a match is found. Matching criteria are specified in the regular expression.
ip bgp policy aspath-list name “regular_expression” action {permit | deny}

Syntax Definitions

name AS path name, e.g., InboundAspath, ranging from 0 to 70 characters, or

a value of none. The AS path name is case sensitive.
regular_expression Regular expression, e.g., “^100 200$” where 100 (followed by a space)
represents the beginning of the list and 200 represents the end. The reg-
ular expression must be enclosed by quotation marks.
permit Allows matching routes to pass.
deny Stops matching routes from passing.

Defaults

parameter default
permit | deny permit

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• A regular expression consists of a character string presented in the form of a pattern, e.g., ^100 200$.
Refer to ip bgp policy aspath-list on page 26-99 for a table of valid regular expression characters
(metacharacters). See also “Configuring BGP” in your Advanced Routing Guide for more information
on using regular expressions in BGP commands.
• This command allows or stops AS path lists from being applied to a peer’s inbound and outbound
routes configured through the ip bgp neighbor in-aspathlist and ip bgp neighbor out-aspathlist
commands. The AS path list filters routes based on one or more regular expressions, as shown in the
example below. If the route matches the AS path list filter, then the permit or deny action (i.e., policy)
associated with the regular expression applies.
• General or more specific AS path list information can be displayed by varying the use of the show ip
bgp command.

Examples
-> ip bgp policy aspath-list InboundAspath “^100 200$” action permit
-> ip bgp policy aspath-list OutboundAspath “^300 400$” action deny

Release History
Release 8.1.1; command was introduced.

page 26-102 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy aspath-list action

Related Commands

ip bgp neighbor in-aspathlist Assigns an inbound AS path list filter to a BGP peer.
ip bgp neighbor out-aspathlist Assigns an outbound AS path list filter to a BGP peer.
ip bgp policy aspath-list Creates or removes an AS path list.
ip bgp policy aspath-list Configures priority for processing regular expressions in an AS path
priority list.

MIB Objects
alaBgpAspathMatchListTable
alaBgpAspathMatchListAction

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-103
ip bgp policy aspath-list priority BGP Commands

ip bgp policy aspath-list priority

Configures the priority for processing regular expressions in an AS path list.
ip bgp policy aspath-list name “regular_expression” priority value

Syntax Definitions

name The AS path name, e.g., InboundAspath, ranging from 0 to 70 charac-

ters, or a value of none. The AS path name is case sensitive.
regular_expression A regular expression, e.g., “^100 200$” where 100 (followed by a
space) represents the beginning of the list and 200 represents the end.
The regular expression must be enclosed by quotation marks.
value A priority value, e.g., 1, assigned to the policy action. Valid priority
range is from 1 - 255.

Defaults

parameter default
value 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• A regular expression consists of a character string presented in the form of a pattern, e.g., ^100 200$.
Refer to ip bgp policy aspath-list on page 26-99 for a table of valid regular expression characters
(metacharacters). See also “Configuring BGP” in your Advanced Routing Guide for more information
on using regular expressions in BGP commands.
• This command specifies the priority of an AS path list filter being applied to a peer’s inbound and
outbound routes configured through the ip bgp neighbor in-aspathlist and ip bgp neighbor out-
aspathlist commands. The AS path list filters routes based on one or more regular expressions, as
shown in the example below. If the route matches the AS path list filter, then the permit or deny action
(i.e., policy) associated with the regular expression applies, but only in the order designated by the
priority value.
• The higher the priority value specified in the command, the later the matching is processed. For
example, regular expressions with a priority of 1 (the default) are processed before an expression
assigned a priority of 3. When regular expressions have an equal priority, the processing order is
indeterminate.
• General or more specific AS path list information can be displayed by varying the use of the show ip
bgp command.

Examples
-> ip bgp policy aspath-list InboundAspath “^100 200$” priority 1
-> ip bgp policy aspath-list OutboundAspath “^300 400$” priority 5

page 26-104 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy aspath-list priority

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp neighbor in-aspathlist Assigns an inbound AS path list filter to a BGP peer.
ip bgp neighbor out-aspathlist Assigns an outbound AS path list filter to a BGP peer.
ip bgp policy aspath-list Creates or removes an AS path list.
ip bgp policy aspath-list action Configures a policy action (either permit or deny a route from
passing) to be taken for an AS path list when a match is found.

MIB Objects
alaBgpAspathMatchListTable
alaBgpAspathMatchListPriority

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-105
ip bgp policy community-list BGP Commands

ip bgp policy community-list

Creates or deletes a community list.
ip bgp policy community-list name {none | no-export | no-advertise | no-export-subconfed | num:num}
no ip bgp policy community-list name {none | no-export | no-advertise | no-export-subconfed |
num:num}

Syntax Definitions

name Community name, e.g., CommListAIn, ranging from 0 to 70 characters,

or a value of none. The Community name is case sensitive.
none Removes the community restrictions on the community section of the
route map.
no-export Routes in this community are advertised within the AS but not beyond
the local AS.
no-advertise Routes in this community are not advertised to any peer.
no-export-subconfed Routes in this community are not advertised to any external BGP peer.
num:num The community number, given in the form of the AS number and the
community number, separated by a colon, as defined in RFC 1997.

Defaults
No IP BGP peer policy community-list exists.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a community-list.

• This command creates community lists that can be applied to a peer’s inbound and outbound routes
using the ip bgp neighbor in-communitylist and ip bgp neighbor out-communitylist commands.
The community list filters routes based on one or more community match list strings, as shown in the
example below. If the route matches the community list filter, according to the matching type exact or
occur, then the permit or deny policy action associated with the match list string applies.
• General or more specific community list information can be displayed by varying the use of the show
ip bgp command.

Examples
-> ip bgp policy community-list CommListAIn 40:40
-> ip bgp policy community-list CommListAOut 400:20
-> ip bgp policy community-list none
-> no ip bgp policy community-list CommListAIn 400:20

page 26-106 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy community-list

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp neighbor in- Assigns an inbound AS community list filter to a BGP peer.
communitylist
ip bgp neighbor out- Assigns an outbound AS community list filter to a BGP peer.
communitylist
ip bgp policy community-list Configures a policy action (either permit or deny a route from
action passing) to be taken for an AS community list filter when a match is
found.
ip bgp policy community-list Configures type of matching to be performed with a community
match-type string list.
ip bgp policy community-list Configures priority for processing multiple items in a community
priority list filter.

MIB Objects
alaBgpCommunityMatchListTable
alaBgpCommunityMatchListRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-107
ip bgp policy community-list action BGP Commands

ip bgp policy community-list action

Configures the action to be taken for a community list when a match is found.
ip bgp policy community-list name {none | no-export | no-advertise | no-export-subconfed | num:num}
action {permit | deny}

Syntax Definitions

name Community name, e.g., CommListAIn, ranging from 0 to 70 characters,

or a value of none. The Community name is case sensitive.
none Removes the community restrictions on the community section of the
route map.
no-export Routes in this community are advertised within the AS but not beyond
the local AS.
no-advertise Routes in this community are not advertised to any peer.
no-export-subconfed Routes in this community are not advertised to any external BGP peer.
num:num The community number, given in the form of the AS number and the
community number, separated by a colon, as defined in RFC 1997.
permit Allows matching routes to pass.
deny Stops matching routes from passing.

Defaults

parameter default
permit | deny permit

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
By default, this command allows routes that match the criteria specified in the community list to pass.

Examples
-> ip bgp policy community-list commListAIn 600:1 action permit
-> ip bgp policy community-list commListAIn 600:1 action deny

Release History
Release 8.1.1; command was introduced.

page 26-108 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy community-list action

Related Commands

ip bgp neighbor in- Assigns an inbound AS community list filter to a BGP peer.
communitylist
ip bgp neighbor out- Assigns an outbound AS community list filter to a BGP peer.
communitylist
ip bgp policy community-list Configures type of matching to be performed with a community
match-type string list.
ip bgp policy community-list Configures priority for processing multiple items in a community
priority list filter.

MIB Objects
alaBgpCommunityMatchListTable
alaBgpCommunityMatchListAction

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-109
ip bgp policy community-list match-type BGP Commands

ip bgp policy community-list match-type

Configures the type of matching to be performed with a community string list.
ip bgp policy community-list name {none | no-export | no-advertise | no-export-subconfed | num:num}
match-type {exact | occur}

Syntax Definitions

name Community name, e.g., CommListAIn, ranging from 0 to 70 characters,

or a value of none. The Community name is case sensitive.
none Removes the community restrictions on the community section of the
route map.
no-export Routes in this community are advertised within the AS but not beyond
the local AS.
no-advertise Routes in this community are not advertised to any peer.
no-export-subconfed Routes in this community are not advertised to any external BGP peer.
num:num The community number, given in the form of the AS number and the
community number, separated by a colon, as defined in RFC 1997.
exact Checks for an exact match of the community string and the community
attribute.
occur Checks for an occurrence of the community string anywhere in the
community attribute.

Defaults

parameter default
exact | occur exact

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
By default, this command only allows routes to pass if the community string exactly matches the
community attribute of the route.

Examples
-> ip bgp policy community-list commListC 600:1 match-type exact

Release History
Release 8.1.1; command was introduced.

page 26-110 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy community-list match-type

Related Commands

ip bgp neighbor in- Assigns an inbound AS community list filter to a BGP peer.
communitylist
ip bgp neighbor out- Assigns an outbound AS community list filter to a BGP peer.
communitylist
ip bgp policy community-list Configures a policy action (either permit or deny a route from
action passing) to be taken for an AS community list filter when a match is
found.
ip bgp policy community-list Configures priority for processing multiple items in a community
priority list filter.

MIB Objects
alaBgpCommunityMatchListTable
alaBgpCommunityMatchListType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-111
ip bgp policy community-list priority BGP Commands

ip bgp policy community-list priority

Configures the priority for processing multiple items in a community list filter.
ip bgp policy community-list name {none | no-export | no-advertise | no-export-subconfed | num:num}
priority value

Syntax Definitions

name Community name, e.g., CommListAIn, ranging from 0 to 70 characters,

or a value of none. The Community name is case sensitive.
none Removes the community restrictions on the community section of the
route map.
no-export Routes in this community are advertised within the AS but not beyond
the local AS.
no-advertise Routes in this community are not advertised to any peer.
no-export-subconfed Routes in this community are not advertised to any external BGP peer.
num:num The community number, given in the form of the AS number and the
community number, separated by a colon, as defined in RFC 1997.
value Priority value in the range 0 - 255.

Defaults

parameter default
value 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The higher the priority value specified in the command, the later the matching is processed. For example,
items with a priority of 1 (the default) are processed before items assigned a priority of 3. When items
have an equal priority, the processing order is indeterminate.

Examples
-> ip bgp policy community-list commListB 500:1 priority 3

Release History
Release 8.1.1; command was introduced.

page 26-112 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy community-list priority

Related Commands

ip bgp policy community-list Creates or deletes a community list.

ip bgp policy community-list Configures a policy action (either permit or deny a route from
action passing) to be taken for an AS community list filter when a match is
found.
ip bgp policy community-list Configures type of matching to be performed with community
match-type string list.

MIB Objects
alaBgpCommunityMatchListTable
alaBgpCommunityMatchListPriority

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-113
ip bgp policy prefix-list BGP Commands

ip bgp policy prefix-list

Creates or deletes a prefix match list.
ip bgp policy prefix-list name ip_address ip_mask
no ip bgp policy prefix-list name ip_address ip_mask

Syntax Definitions

name Prefix list name.

ip_address IP address for the prefix list.
ip_mask Mask for the prefix list.

Defaults
No IP BGP policy prefix-list exists.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command creates prefix lists that can be applied to a peer’s inbound and outbound routes using the
ip bgp neighbor in-prefixlist and ip bgp neighbor out-prefixlist commands. The prefix list filters
routes based on one or more prefixes, as shown in the example below. If the route matches the prefix
list filter, according to the ge (lower) and le (upper) limits defined, then the permit or deny action
associated with the prefix applies.
• General or more specific prefix list information can be displayed by varying the use of the show ip bgp
command.

Examples
-> ip bgp policy prefix-list prefixListA 12.0.0.0 255.0.0.0

Release History
Release 8.1.1; command was introduced.

page 26-114 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy prefix-list

Related Commands

ip bgp policy prefix-list action Configures action to be taken for a prefix list when a match is
found.
ip bgp policy prefix-list ge Configures lower limit on length of prefix to be matched.
ip bgp policy prefix-list le Configures upper limit on length of prefix to be matched.

MIB Objects
alaBgpPrefixMatchListTable
alaBgpPrefixMatchListRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-115
ip bgp policy prefix-list action BGP Commands

ip bgp policy prefix-list action

Configures the action to be taken for a prefix list when a match is found.
ip bgp policy prefix-list name ip_address ip_mask action {permit | deny}

Syntax Definitions

name Prefix list name.

ip_address IP address of the prefix list.
ip_mask Mask for the prefix list.
permit Allows matching routes to pass.
deny Stops matching routes from passing.

Defaults

parameter default
permit | deny permit

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Configures the action to be taken for a prefix list when a match is found.

Examples
-> ip bgp policy prefix-list prefixListA 12.0.0.0 255.0.0.0 action deny

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy prefix-list Creates or deletes a prefix match list.

ip bgp policy prefix-list ge Configures lower limit on length of prefix to be matched.
ip bgp policy prefix-list le Configures upper limit on length of prefix to be matched.

MIB Objects
alaBgpPrefixMatchListTable
alaBgpPrefixMatchListAction

page 26-116 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy prefix-list ge

ip bgp policy prefix-list ge

Configures the lower limit on the length of the prefix to be matched.
ip bgp policy prefix-list name ip_address ip_mask ge value

Syntax Definitions

name Prefix list name.

ip_address IP address of the prefix list.
ip_mask Mask of the prefix list.
value The lower limit value in the range 0 to 32.

Defaults

parameter default
value 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The default value of zero indicates there is no lower limit on the length of the prefix to be matched.

• This command is used in conjunction with the ip bgp policy prefix-list le command to set the prefix
matching range. The two commands can be combined, as show in the Example section below.
• The ge (lower limit) value must be greater than or equal to the prefix length (8 in the example below)
and less than or equal to the le (upper limit) value.

Examples
-> ip bgp policy prefix-list prefixListA 14.0.0.0 255.0.0.0 ge 8 le 16

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-117
ip bgp policy prefix-list ge BGP Commands

Related Commands

ip bgp policy prefix-list Creates or deletes a prefix match list.

ip bgp policy prefix-list action Configures action to be taken for a prefix list when a match is
found.
ip bgp policy prefix-list le Configures upper limit on length of prefix to be matched.

MIB Objects
alaBgpPrefixMatchListTable
alaBgpPrefixMatchListGE

page 26-118 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy prefix-list le

ip bgp policy prefix-list le

Configures the upper limit on the length of the prefix to be matched.
ip bgp policy prefix-list name ip_address ip_mask le value

Syntax Definitions

name Prefix list name.

ip_address Prefix list IP address for the prefix list.
ip_mask Prefix list mask for the prefix list.
value The upper limit value in the range of 0 to 32.

Defaults

parameter default
value 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The default value of zero indicates there is no upper limit on the length of the prefix to be matched.
This command is used in conjunction with ip bgp policy prefix-list ge to set the prefix matching
range. The two commands can be combined, as show in the Example section below.
• The ge (lower limit) value must be greater than or equal to the prefix length (8 in the example below)
and less than or equal to the le (upper limit) value.

Examples
-> ip bgp policy prefix-list prefixListA 14.0.0.0 255.0.0.0 ge 8 le 16

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-119
ip bgp policy prefix-list le BGP Commands

Related Commands

ip bgp policy prefix-list Creates or deletes a prefix match list.

ip bgp policy prefix-list action Configures action to be taken for a prefix list when a match is
found.
ip bgp policy prefix-list ge Configures lower limit on length of prefix to be matched.

MIB Objects
alaBgpPrefixMatchListTable
alaBgpPrefixMatchListLE

page 26-120 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy prefix6-list

ip bgp policy prefix6-list

Configures a BGP prefix6-list policy for filtering IPv6 prefixes. This policy can be applied to filter unique
local IPv6 addresses.
ip bgp policy prefix6-list pfx_list_name prefix6/pfx_length [action {permit | deny}] [admin-state
{enable | disable}] [ge [masklength]] [le [masklength]]
no ip bgp policy prefix6-list pfx_list_name prefix6/pfx_length [action {permit | deny}] [admin-state
{enable | disable}] [ge [masklength]] [le [masklength]]

Syntax Definitions

pfx_list_name Prefix list name.

prefix6 Prefix list IPv6 address for the prefix list.
pfx_length Prefix length. Prefix length should be in the range of 0 to 128.
permit | deny Action to be taken which can be either permit or deny.
enable | disable Row Status can be either enabled or disabled.
masklength Minimum length of the prefix to be matched. It should be in the range of
0 - 32.

Defaults
NA

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable this feature.

• BGP must be configured on the system.

• The ge (lower limit) value must be greater than or equal to the prefix length and less than or equal to
the le (upper limit) value.

Examples
-> ip bgp policy prefix6-list uniqLocal FC00::/48
-> ip bgp policy prefix6-list uniqLocal FC00::/48 action permit
-> ip bgp policy prefix6-list uniqLocal FC00::/48 admin-state enable
-> no ip bgp policy prefix6-list uniqLocal FC00::/48

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-121
ip bgp policy prefix6-list BGP Commands

Related Commands

show ip bgp policy route-map Displays configured prefix6-list policies on the system.
show ipv6 bgp neighbors Displays the configured IPv6 BGP peers.

MIB Objects
alaBgpPrefix6MatchListTable
alaBgpPrefix6MatchListId
alaBgpPrefix6MatchListAddr
alaBgpPrefix6MatchListAddrLength
alaBgpPrefix6MatchListAction
alaBgpPrefix6MatchListRowStatus
alaBgpPrefix6MatchListGE
alaBgpPrefix6MatchListLE

page 26-122 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy route-map

ip bgp policy route-map

Creates or deletes a policy route map.
ip bgp policy route-map name sequence_number

Syntax Definitions

name Route map name. Case-sensitive.

sequence_number Route map sequence number in the range of 1 to 255. The sequence
number allows for multiple instances of the same route map name.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command creates policy route maps. Each route map can be configured using the following match
commands to specify the match criteria by which routes are allowed to pass. Match criteria is
examined in the order the commands are listed below.
1. ip bgp policy route-map aspath-list

2. ip bgp policy route-map prefix-list

3. ip bgp policy route-map community-list

4. ip bgp policy route-map match-regexp

5. ip bgp policy route-map match-prefix

6. ip bgp policy route-map match-mask

7. ip bgp policy route-map match-community

• Each route map can also be configured using the following set commands to sequentially specify the
actions to be taken when a match is found.
– ip bgp policy route-map community
– ip bgp policy route-map community-mode
– ip bgp policy route-map lpref
– ip bgp policy route-map lpref-mode
– ip bgp policy route-map med
– ip bgp policy route-map med-mode
– ip bgp policy route-map origin
– ip bgp policy route-map weight

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-123
ip bgp policy route-map BGP Commands

• Route maps can be referenced as a filtering mechanism for displaying paths using the show ip bgp
path command. They are also referenced in filtering inbound and outbound routes for BGP peers using
the ip bgp neighbor route-map commands.

Examples
-> ip bgp policy route-map routemap1 1

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy route-map action Configures action to be taken for a route when a match is found.

MIB Objects
alaBgpRouteMapTable
alaBgpRouteMapRowStatus

page 26-124 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy route-map action

ip bgp policy route-map action

Configures the action to be taken for a route when a match is found.
ip bgp policy route-map name sequence_number action {permit | deny}

Syntax Definitions

name A route map name.

sequence_number A route map sequence number. The valid range is 1–255.
permit Allows matching routes to pass.
deny Stops matching routes from passing. In addition, no further instances
(sequence numbers) of the route map are examined.

Defaults

parameter default
permit | deny permit

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
By default, this command allows routes that match the criteria specified in the route map to pass. If no
matching routes are found, any additional instances (sequence numbers) of the route map name are exam-
ined. When all instances have been examined with no match, the route is dropped.

Examples
-> ip bgp policy route-map routemap1 1 action deny

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy prefix6-list Creates or deletes a policy route map.

MIB Objects
alaBgpRouteMapTable
alaBgpRouteMapAction

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-125
ip bgp policy route-map aspath-list BGP Commands

ip bgp policy route-map aspath-list

Assigns an AS path matching list to the route map.
ip bgp policy route-map name sequence_number aspath-list as_name

Syntax Definitions

name The route map name.

sequence_number The route map sequence number. The valid range is 1–255.
as_name The AS path list name or “none”.

Defaults

parameter default
as_name none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• By default, no AS path list is assigned to a route map.

• This default behavior can be reset by changing the value of the AS path list name to “none”.

• The ip bgp policy aspath-list and ip bgp policy aspath-list action commands are used to create and
set permit/deny actions for an AS path list.

Examples
-> ip bgp policy route-map routemap1 1 aspath-list aspathlist1
-> ip bgp policy route-map routemap1 1 aspath-list none

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy prefix6-list Creates or deletes a policy route map.

MIB Objects
alaBgpRouteMapTable
alaBgpRouteMapAsPathMatchListId

page 26-126 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy route-map asprepend

ip bgp policy route-map asprepend

Configures the AS path prepend action to be taken when a match is found.
ip bgp policy route-map name sequence_number asprepend path

Syntax Definitions

name The route map name.

sequence_number The route map sequence number. The valid range is 1–255.
path The AS path to prepend or “none”. Note that multiple AS path entries
must be enclosed in quotes (e.g., “500 600 700”).

Defaults

parameter default
path none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
By default, no AS path is prepended. This command allows AS path numbers to be prepended (added to
the beginning of the AS path list) to the AS path attribute of a matching route. The default behavior can be
reset by changing the value to “none”.

Examples
-> ip bgp policy route-map routemap1 1 asprepend “700 800 900”

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy prefix6-list Creates or deletes a policy route map.

MIB Objects
alaBgpRouteMapTable
alaBgpRouteMapAsPrepend

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-127
ip bgp policy route-map community BGP Commands

ip bgp policy route-map community

Configures the action to be taken on the community attribute when a match is found.
ip bgp policy route-map name sequence_number community [none | no-export | no-advertise | no-
export-subconfed | num:num]

Syntax Definitions

name The route map name.

sequence_number The route map sequence number. The valid range is 1–255.
none Removes the community restrictions on the community section of the
route map.
no-export Routes in this community are advertised within the AS but not beyond
the local AS.
no-advertise Routes in this community are not advertised to any peer.
no-export-subconfed Routes in this community are not advertised to any external BGP peer.
num:num The community number, given in the form of the AS number and the
community number, separated by a colon, as defined in RFC 1997.

Defaults

parameter default
none | no-export | no-advertise none
| no-export-subconfed |
num:num

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• By default, no action is taken on a community attribute when a match on a route is found.

• The default behavior can be reset by setting the value to “none”.

• The ip bgp policy community-list and ip bgp policy community-list action commands are used to
create and set permit/deny actions for a community path list. This command is used in conjunction with
ip bgp policy route-map community-mode.

Examples
-> ip bgp policy route-map routemap1 1 community 400:1 500:1
-> ip bgp policy route-map routemap1 1 community 400:1 500:1 community-mode replace

Release History
Release 8.1.1; command was introduced.

page 26-128 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy route-map community

Related Commands

ip bgp policy prefix6-list Creates or deletes a policy route map.

ip bgp policy route-map Configures the action to be taken for a community string when a
community-mode match is found.

MIB Objects
alaBgpRouteMapTable
alaBgpRouteMapCommunity

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-129
ip bgp policy route-map community-list BGP Commands

ip bgp policy route-map community-list

Assigns a community matching list to the route map.
ip bgp policy route-map name sequence_number community-list [name | none]

Syntax Definitions

name The route map name.

sequence_number The route map sequence number. The valid range is 1–255.
name The community list name.
none No community list name is specified.

Defaults

parameter default
name | none none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
By default, no community list is assigned to the route map. The default behavior can be reset by changing
the value to none.

Examples
-> ip bgp policy route-map routemap1 1 community-list listB
-> ip bgp policy route-map routemap1 1 community-list none

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy prefix6-list Creates or deletes a policy route map.

MIB Objects
alaBgpRouteMapTable
alaBgpRouteMapCommunityMatchListId

page 26-130 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy route-map community-mode

ip bgp policy route-map community-mode

Configures the action to be taken for a community string when a match is found.
ip bgp policy route-map name sequence_number community-mode {add | replace}

Syntax Definitions

name The route map name.

sequence_number The route map sequence number. The valid range is 1–255.
add Adds the community string specified in the command ip bgp policy
route-map community.
replace Replaces the community string specified in the command ip bgp policy
route-map community.

Defaults

parameter default
add | replace add

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command is used in conjunction with ip bgp policy route-map community. The example on the
next line shows the combined usage.

Examples
-> ip bgp policy route-map routemap1 1 community-mode replace
-> ip bgp policy route-map routemap1 1 community 400:1 500:1 community-mode replace

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy prefix6-list Creates or deletes a policy route map.

ip bgp policy route-map Configures the action to be taken on the community attribute when
community a match is found.

MIB Objects
alaBgpRouteMapTable
alaBgpRouteMapSetComunityMode

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-131
ip bgp policy route-map lpref BGP Commands

ip bgp policy route-map lpref

Configures the local preference value for the route map.
ip bgp policy route-map name sequence_number lpref value

Syntax Definitions

name The route map name.

sequence_number The route map sequence number. The valid range is 1–255.
value The local preference value. The valid range is 0–4294967295

Defaults

parameter default
value 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used in conjunction with ip bgp policy route-map lpref-mode. The example on the
next line shows the combined usage.
• In this example, the local preference value will be incremented for a matching route by 555.

Examples
-> ip bgp policy route-map routemap1 1 lpref 555
-> ip bgp policy route-map routemap1 1 lpref 555 lpref-mode inc

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy prefix6-list Creates or deletes a policy route map.

ip bgp policy route-map lpref- Configures the action to be taken when setting local preference
mode attribute for a local matching route.

MIB Objects
alaBgpRouteMapTable
alaBgpRouteMapLocalPref

page 26-132 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy route-map lpref-mode

ip bgp policy route-map lpref-mode

Configures the action to be taken when setting local preference attribute for a local matching route.
ip bgp policy route-map name sequence_number lpref-mode {none | inc | dec | rep}

Syntax Definitions

name The route map name.

sequence_number The route map sequence number. The valid range is 1–255.
none Do not set the local preference attribute.
inc Increment the local preference attribute in the matching route by the
value specified in the ip bgp policy route-map med command. No
action is taken if no local preference attribute is found in the matching
route.
dec Decrement the local preference attribute in the matching route by the
value specified in the ip bgp policy route-map med command. No
action is taken if no local preference attribute is found in the matching
route.
rep Replace the local preference attribute in the matching route by the value
specified in the ip bgp policy route-map med command even if no
local preference attribute is found in the matching route.

Defaults

parameter default
none | inc | dec | rep none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used in conjunction with ip bgp policy route-map lpref. The example below shows
the combined usage.
• In this example, the local preference value is incremented for a matching route by 555.

Examples
-> ip bgp policy route-map routemap1 1 lpref-mode none
-> ip bgp policy route-map routemap1 1 lpref 555 lpref-mode inc

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-133
ip bgp policy route-map lpref-mode BGP Commands

Related Commands

ip bgp policy prefix6-list Creates or deletes a policy route map.

ip bgp policy route-map lpref Configures the local preference value for the route map.
ip bgp policy route-map med Configures the Multi-Exit Discriminator (MED) value for a route
map.

MIB Objects
alaBgpRouteMapTable
alaBgpRouteMapLocalPrefMode

page 26-134 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy route-map match-community

ip bgp policy route-map match-community

Configures a matching community primitive for the route map.
ip bgp policy route-map name sequence_number match-community [none | no-export | no-advertise |
no-export-subconfed | num:num]

Syntax Definitions

name The route map name.

sequence_number The route map sequence number. The valid range is 1–255.
none Removes the community match from the route-map.
no-export Routes in this community are advertised within the AS but not beyond
the local AS.
no-advertise Routes matching the community restricting advertisement to any peer.
no-export-subconfed Routes matching the community restricting advertisement to any exter-
nal BGP peer.
num:num The community number, given in the form of the AS number and the
community number, separated by a colon, as defined in RFC 1997.

Defaults

parameter default
none | no-export | no-advertise none
| no-export-subconfed |
num:num

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command allows a matching community string primitive to be placed directly in the route map. By
default, no community string is specified. The default behavior can be reset by changing the value to
none.

Examples
-> ip bgp policy route-map routemap1 1 match-community 400:1 500 700:1

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-135
ip bgp policy route-map match-community BGP Commands

Related Commands

ip bgp policy prefix6-list Creates or deletes a policy route map.

MIB Objects
alaBgpRouteMapTable
alaBgpRouteMapMatchCommunity

page 26-136 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy route-map match-mask

ip bgp policy route-map match-mask

Configures a matching mask primitive in the route map.
ip bgp policy route-map name sequence_number match-mask ip_address

Syntax Definitions

name The route map name.

sequence_number The route map sequence number. The valid range is 1–255.
ip_address The 32-bit IP address of the matching mask.

Defaults

parameter default
ip_address 0.0.0.0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command allows a matching mask primitive to be placed directly in the route map. By default, no
mask primitive is specified.
• The example on the next line shows usage combined with the ip bgp policy route-map match-prefix
command.

Examples
-> ip bgp policy route-map routemap1 1 match-mask 255.255.0.0
-> ip bgp policy route-map routemap1 1 match-prefix 17.0.0.0 match-mask 255.255.0.0

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy prefix6-list Creates or deletes a policy route map.

ip bgp policy route-map match- Configures a matching prefix primitive in the route map.
prefix

MIB Objects
alaBgpRouteMapTable
alaBgpRouteMapMatchMask

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-137
ip bgp policy route-map match-prefix BGP Commands

ip bgp policy route-map match-prefix

Configures a matching prefix primitive in the route map.
ip bgp policy route-map name sequence_number match-prefix ip_address

Syntax Definitions

name The route map name.

sequence_number The route map sequence number. The valid range is 1–255.
ip_address The 32-bit IP address of the matching prefix.

Defaults

parameter default
ip_address 0.0.0.0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command allows a matching prefix primitive to be placed directly in the route map. By default, no
prefix primitive is specified.
• The example on the next line shows usage combined with the ip bgp policy route-map match-mask
command.

Examples
-> ip bgp policy route-map routemap1 1 match-prefix 17.0.0.0
-> ip bgp policy route-map routemap1 1 match-prefix 17.0.0.0 match-mask 255.255.0.0

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy route-map match- Configures a matching prefix primitive in the route map.
mask
ip bgp policy prefix6-list Configures an AS path matching regular expression primitive in the
route map.

MIB Objects
alaBgpRouteMapTable
alaBgpRouteMapMatchPrefix

page 26-138 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy route-map match-regexp

ip bgp policy route-map match-regexp

Configures an AS path matching regular expression primitive in the route map.
ip bgp policy route-map name sequence_number match-regexp {“regular_expression” | none}

Syntax Definitions

name The route map name.

sequence_number The route map sequence number. The valid range is 1–255.
regular_expression Regular expression. The regular expression must be enclosed by quota-
tion marks.
none No regular expression primitive.

Defaults

parameter default
regular_expression | none none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command allows a regular expression matching directive to be placed directly in the route map.
By default, no matching regular expression is specified. Regular expressions are defined in ip bgp
policy aspath-list on page 26-99.
• When using regular expressions in the CLI, the regular expression must be enclosed by quotation
marks.
• The default behavior can be reset by changing the value to none.

• See the OmniSwitch AOS Release 8 Advanced Routing Configuration Guide for more information on
the use of regular expressions in BGP commands.

Examples
-> ip bgp policy route-map routemap1 1 match-regexp “500 .* 400$”

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-139
ip bgp policy route-map match-regexp BGP Commands

Related Commands

ip bgp policy prefix6-list Configures an AS path matching regular expression primitive in the
route map.

MIB Objects
alaBgpRouteMapTable
alaBgpRouteMapMatchAsRegExp

page 26-140 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy route-map med

ip bgp policy route-map med

Configures the Multi-Exit Discriminator (MED) value for a route map.
ip bgp policy route-map name sequence_number med value

Syntax Definitions

name The route map name.

sequence_number The route map sequence number. The valid range is 1–255.
value The MED value. The valid range is 0–4294967295.

Defaults

parameter default
value 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command is used in conjunction with ip bgp policy route-map med-mode command. The first
example below shows the combined usage. In the second example, the MED value is incremented for a
matching route by 5.

Examples
-> ip bgp policy route-map routemap1 1 med 555
-> ip bgp policy route-map routemap1 1 med 555 med-mode inc

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy route-map med- Configures Multi-Exit Discriminator (MED) value for a route map.
mode
ip bgp policy prefix6-list Configures an AS path matching regular expression primitive in the
route map.

MIB Objects
alaBgpRouteMapTable
alaBgpRouteMapMed

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-141
ip bgp policy route-map med-mode BGP Commands

ip bgp policy route-map med-mode

Configures the action to be taken when setting the Multi-Exit Discriminator (MED) attribute for a match-
ing route.
ip bgp policy route-map name sequence_number med-mode {none | inc | dec | rep}

Syntax Definitions

name The route map name.

sequence_number The route map sequence number. The valid range is 1–255.
none Do not set the MED.
inc Increment the MED in the matching route by the value specified in the
ip bgp policy route-map med command. No action is taken if no MED
is found in the matching route.
dec Decrement the MED in the matching route by the value specified in the
ip bgp policy route-map med command. No action is taken if no MED
is found in the matching route.
rep Replace the MED in the matching route by the value specified in the ip
bgp policy route-map med command even if no MED is found in the
matching route.

Defaults

parameter default
none | inc | dec | rep none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command is used in conjunction with ip bgp policy route-map med. The first example below shows
the combined usage. In the second example, the MED value is incremented for a matching route by 5.

Examples
-> ip bgp policy route-map routemap1 1 med-mode inc
-> ip bgp policy route-map routemap1 1 med 5 med-mode inc

Release History
Release 8.1.1; command was introduced.

page 26-142 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy route-map med-mode

Related Commands

ip bgp policy route-map med Configures action to take when setting Multi-Exit Discriminator
(MED) attribute for a matching route.
ip bgp policy prefix6-list Configures an AS path matching regular expression primitive in the
route map.

MIB Objects
alaBgpRouteMapTable
alaBgpRouteMapMedMode

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-143
ip bgp policy route-map origin BGP Commands

ip bgp policy route-map origin

Configures the action to be taken on the origin attribute when a match is found.
ip bgp policy route-map name sequence_number origin {igp | egp | incomplete | none}

Syntax Definitions

name Route map name.

sequence_number Route map sequence number. Valid range 1–255.
igp Sets the origin attribute to remote internal BGP (IGP).
egp Sets the origin attribute to local external BGP (EGP).
incomplete Sets the origin attribute to incomplete, meaning the origin is unknown.
none Sets the origin attribute to “none”.

Defaults

parameter default
igp | egp | incomplete | none none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
By default, no action is taken on the origin attribute when a match is found. The default behavior can be
reset by changing the value to none.

Examples
-> ip bgp policy route-map routemap1 1 origin egp

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy route-map origin Configures action to take on origin attribute when a match is found.
ip bgp policy prefix6-list Configures an AS path matching regular expression primitive in the
route map.

MIB Objects
alaBgpRouteMapTable
alaBgpRouteMapOrgin

page 26-144 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy route-map prefix-list

ip bgp policy route-map prefix-list

Assigns a prefix matching list to the route map.
ip bgp policy route-map name sequence_number prefix-list {prefix_name | none}

Syntax Definitions

name The route map name.

sequence_number The route map sequence number. The valid range is 1–255.
prefix_name The prefix list name.
none No prefix list name

Defaults

parameter default
prefix_name | none none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• By default, no prefix list is assigned to the route map. The default behavior can be reset by changing
the value to none.
• The ip bgp policy prefix-list, ip bgp policy prefix-list action, ip bgp policy prefix-list ge, and ip
bgp policy prefix-list le commands are used to create and set permit/deny actions for a prefix path list.

Examples
-> ip bgp policy route-map routemap1 1 prefix-list listC

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-145
ip bgp policy route-map prefix-list BGP Commands

Related Commands

ip bgp policy prefix-list Assigns a prefix matching list to the route map.
ip bgp policy prefix-list action Configures action to be taken for a prefix list when a match is
found.
ip bgp policy prefix6-list Configures an AS path matching regular expression primitive in the
route map.

MIB Objects
alaBgpRouteMapTable
alaBgpRouteMapPrefixMatchListId

page 26-146 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp policy route-map weight

ip bgp policy route-map weight

Configures a BGP weight value to be assigned to inbound routes when a match is found.
ip bgp policy route-map name sequence_number weight value

Syntax Definitions

name The route map name.

sequence_number The route map sequence number. The valid range is 1–255.
value The weight value. The valid range is 0–65535.

Defaults

parameter default
value 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command sets the weight value for routes that pass the route map match criteria. It is only applicable
for the inbound policy. The default value of zero means that the weight is not changed by the route map.

Examples
-> ip bgp policy route-map routemap1 1 weight 500

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy prefix6-list Configures an AS path matching regular expression primitive in the
route map.

MIB Objects
alaBgpRouteMapTable
alaBgpRouteMapWeight

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-147
ip bgp policy route-map community-strip BGP Commands

ip bgp policy route-map community-strip

Configures the value to strip from the community attribute of the routes matched by this route map
instance (sequence number).
ip bgp policy route-map name sequence_number community-strip community_list

Syntax Definitions

name The route map name.

sequence_number The route map sequence number. The valid range is 1–255.
community_list The community list name.

Defaults
No IP BGP policy route-map community list exists.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Configures the value to strip from the community attribute of the routes matched by this route map
instance (sequence number).

Examples
-> ip bgp policy route-map routemap1 1 commmunity_strip communitylist

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy prefix6-list Configures an AS path matching regular expression primitive in the
route map.

MIB Objects
alaBgpRouteMapTable
alaBgpRouteMapCommunityStrip

page 26-148 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp

show ip bgp
Displays the current global settings for the local BGP speaker.
show ip bgp

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Most of the parameters in this display can be altered through BGP global commands. See the output defi-
nitions below for references to the CLI commands used to configure individual parameters.

Examples
-> show ip bgp
Admin Status = disabled,
Operational Status = down,
Autonomous system Number = 1,
BGP Router Id = 128.0.1.4,
Confederation Id = 0,
IGP Synchronization Status = disabled,
Minimum AS origin interval (seconds) = 15,
Default Local Preference = 100,
Route Reflection = disabled,
Cluster Id = 0.0.0.0,
Missing MED Status = Best,
Aspath Comparison = enabled,
Always Compare MED = disabled,
Fast External Fail Over = disabled,
Log Neighbor Changes = disabled,
Multi path = disabled,
Graceful Restart = enabled,
Graceful Restart Status = Not Restarting,
Configured Graceful Restart Interval = 90s,
IPv4 Unicast = enabled,
IPv6 Unicast = disabled

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-149
show ip bgp BGP Commands

output definitions
Admin Status Indicates whether the BGP protocol has been enabled or disabled
through the ip bgp admin-state command.
Operational Status Indicates if the local BGP speaker is actively participating in BGP
messages, update, routing advertisements.
Autonomous system Number The AS assigned to the local BGP speaker through the ip bgp
autonomous-system command.
BGP Router Id The IP address for the local BGP speaker.
Confederation Id Shows the confederation number assigned to the local BGP speaker. If
the BGP speaker does not belong to a confederation, then this value
will be zero (0). Confederation numbers are assigned through the ip
bgp confederation identifier command.
IGP Synchronization Status Indicates whether BGP is synchronizing its routing tables with those
on non-BGP routers handling IGP traffic (such as a RIP or OSPF
router). This value is configured through the ip bgp synchronization
command.
Minimum AS origin interval The frequency, in seconds, at which routes local to the autonomous
system are advertised. This value is configured through the ip bgp as-
origin-interval command.
Default Local Preference The local preference that will be assigned to routes that do not already
contain a local preference value. This default value is configured
through the ip bgp default local-preference command.
Route Reflection Indicates whether the local BGP speaker is acting as a route reflector
for its AS. This value is configured through the ip bgp client-to-client
reflection command.
Cluster Id The IP address for cluster in route reflector configurations using
multiple, redundant route reflectors. A value of 0.0.0.0 indicates that a
cluster is not set up. This value is configured through the ip bgp
cluster-id command.
Missing MED Status Indicates the MED value that will be assigned to paths that do not
contain MED values. Missing MED values will either be assigned to
the worst possible value (232-1) or the best possible value (0). This
value is set using the ip bgp bestpath med missing-as-worst
command. By default, missing MED values are treated as best.
Aspath Comparison Indicates whether the AS path will be in used in determining the best
route. This value is configured through the ip bgp bestpath as-path
ignore command.
Always Compare MED Indicates whether multi-exit discriminator (MED) values are being
compared only for internal peers or also for external peers. This value
is configured through the ip bgp always-compare-med command.
Fast External Fail Over Indicates whether Fast External Failover has been enabled or disabled.
When enabled a BGP sessions will be reset immediately after a
connection to a directly connected external peer goes down. This value
is configured through the ip bgp fast-external-failover command.

page 26-150 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp

output definitions (continued)

Log Neighbor Changes Indicates whether logging of peer state changes is enabled or disabled.
This value is configured through the ip bgp log-neighbor-changes
command.
Multi path Indicates whether support for multiple equal cost paths is enabled or
disabled. This value is configured through the ip bgp maximum-
paths command.
Graceful Restart Indicates whether graceful restart is enabled or disabled.
Graceful Restart Status Indicates the graceful restart state. This feature is not supported in
Multiprotocol BGP.
Configured Graceful Restart Indicates the timer for achieving a graceful restart.
Interval
IPv4 Unicast Indicates whether IPv4 unicast is enabled or disabled.
IPv6 Unicast Indicates whether IPv6 unicast is enabled or disabled.

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp unicast Enables or disables unicast IPv4 updates for the BGP routing
process.
ipv6 bgp unicast Enables or disables unicast IPv6 updates for the BGP routing
process
show ip bgp statistics Displays BGP global statistics.

MIB Objects
alabgpMIBGlobalsGroup
alaBgpProtoStatus
alaBgpAutonomousSystemNumber
alaBgpIgpSynchStatus
alaBgpProtoOperState
alaBgpNumActiveRoutes
alaBgpNumEstabExternalPeers
alaBgpNumEstabInternalPeers
alaBgpClusterId
alaBgpDefaultLocalPref
alaBgpFastExternalFailOver
alaBgpMedAlways
alaBgpMissingMed
alaBgpRouterId
alaBgpRouteReflection
alaBgpAsOriginInterval
alaNumIgpSyncWaitPaths
alaBgpManualTag
alaBgpPromiscuousneighbors
alaBgpConfedId
alaBgpMultiPath
alaBgpMaxPeers

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-151
show ip bgp BGP Commands

alaBgpPeersChanges

page 26-152 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp statistics

show ip bgp statistics

Displays BGP global statistics.
show ip bgp statistics

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command show various BGP statistics for the router, such as number of neighbors, active prefixes,
number of paths, etc.

Examples
-> show ip bgp statistics
# of Active Prefixes Known = 0,
# of EBGP Neighbors in Established State = 0,
# of IBGP Neighbors in Established State = 0,
# of Feasible Paths = 0,
# of Dampened Paths = 0,
# of Unsynchronized Paths = 0,
# of Policy unfeasible paths = 0,
Total Number of Paths = 0

output definitions
# of Active Prefixes Known The number of prefixes, or route paths, currently known to the local
BGP speaker, that are currently up and active.
# of EBGP Neighbors in The number of peers outside the AS of the local BGP speaker that the
Established State local BGP speaker can route to.
# of IBGP Neighbors in The number of peers in the same AS as the local BGP speaker that the
Established State local BGP speaker can route to.
# of Feasible Paths The number of route paths that are not active due to one of the follow-
ing reasons: the route is dampened, the route is not permitted based on
BGP policies, or the route is waiting to be synchronized with the IGP
protocol.
# of Dampened Paths The number of route paths that are not active because they have
violated dampening parameters.
# of Unsynchronized Paths The number of route paths that are not active because they are waiting
to be synchronized with the IGP routing protocol.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-153
show ip bgp statistics BGP Commands

output definitions (continued)

# of Unfeasible Paths The number of route paths that are not active because they are not
permitted based on a configured BGP policy.
Total Number of Paths The total number of paths known to the speaker, active or not.

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip bgp Displays the current global settings for the local BGP speaker.

MIB Objects
alaBgpStatsTable

page 26-154 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp dampening

show ip bgp dampening

Displays the BGP route dampening settings.
show ip bgp dampening

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command shows the setting for dampening on the router, assuming it is enabled.

Examples
-> show ip bgp dampening
Admin Status = disabled,
Half life value (seconds) = 300,
Reuse value = 200
Suppress value = 300,
Max suppress time (seconds) = 1800,

output definitions
Admin Status Indicates whether route dampening is enabled or disabled. This value
is configured through the ip bgp dampening command.
Half life value The half-life interval, in seconds, after which the penalty value for a
reachable route will be reduced by half. This value is configured
through the ip bgp dampening command.
Reuse value The value that the route flapping metric must reach before this route is
re-advertised. This value is configured through the ip bgp dampening
command.
Suppress value The number of route withdrawals necessary to begin readvertising a
previously suppressed route. This value is configured through the ip
bgp dampening command.
Max Suppress time The maximum time (in seconds) that a route will be suppressed. This
value is configured through the ip bgp dampening command.

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-155
show ip bgp dampening BGP Commands

Related Commands

ip bgp dampening Enables or disables BGP route dampening or the suppression of

unstable routes.

MIB Objects
alaBgpDampTable
alaBgpDampEntry
alaBgpDampCeil
alaBgpDampCutOff
alaBgpDampMaxFlapHistory
alaBgpDampReuse
alaBgpDampening
alaBgpDampeningClear

page 26-156 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp dampening-stats

show ip bgp dampening-stats

Displays BGP dampening statistics.
show ip bgp dampening-stats [ip_address ip_mask] [peer_address]

Syntax Definitions

ip_address A 32-bit IP address.

ip_mask A 32-bit subnet mask number that determines how many bits of the IP
address parameter denote the network number.
peer_address A 32-bit IP address of peer (neighbor).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays various statistics on routes that have flapped, and are thus subject to the settings of
the dampening feature.

Examples
-> show ip bgp dampening-stats
Network Mask From Flaps Duration FOM
---------------+---------------+---------------+-----+-----------+-----
155.132.44.73 255.255.255.255 192.40.4.121 8 00h:00m:35s 175

output definitions
Network The IP address for the local BGP speaker that is responsible for route
dampening in this router.
Mask The mask for the local BGP speaker that is responsible for route
dampening in this router.
From The IP address for the route that is flapping.
Flaps The number of times this route has moved from an UP state to a
DOWN state or from a DOWN state to an UP state. If the route goes
down and then comes back up, then this statistics would count 2 flaps.
Duration The time since the first route flap occurred. In the above example, this
route has flapped 8 times in a 35 second period.
FOM The Figure Of Merit, or instability metric, for this route. This value
increases with each unreachable event. If it reaches the cutoff value
(configured in ip bgp dampening), then this route will no longer be
advertised.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-157
show ip bgp dampening-stats BGP Commands

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp dampening Enables and disables route dampening.

MIB Objects
N/A

page 26-158 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp path

show ip bgp path

Displays BGP paths.
show ip bgp path
[ip-addr ip_address ip_mask]
[aspath-list aspathlist_name]
[community-list community_list_name]
[prefix-list prefix_name]
[route-map routemap_name]
[cidr-only]
[community community_number]
[neighbor-rcv recv_peer_address]
[neighbor-adv adv_peer_addr]
[regexp “regular_expression”]
[best]

Syntax Definitions

ip_address A 32-bit IP address of the path.

ip_mask A 32-bit subnet mask of the path.
aspathlist_name AS path on which to filter.
community_list_name Community name on which to filter.
prefix_name Prefix on which to filter.
routemap_name Route map on which to filter.
cidr-only Filter out everything except CIDR routes.
community_number Community number on which to filter.
recv_peer_address Filter all except paths received from this path.
adv_peer_addr Filter all except paths sent to this path.
regular_expression Regular expression on which to filter. Regular expressions must be
enclosed by quotes. For example, “$100”.
best Show only the best path.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The basic command displays every path currently in the table. Since the number of paths may run into the
thousands, this command provides a number of parameters for displaying a specific path or matching
entries for a portion of a path or peer address.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-159
show ip bgp path BGP Commands

Examples
-> show ip bgp path
Legends: Sta = Path state
> = best, F = feasible
P = policy changing, U = un-synchronized
D = dampened, N = none
Nbr = Neighbor
(O) = Path Origin (? = incomplete, i = igp, e = egp)
degPref = degree of preference
Sta Network Mask Nbr address Next Hop (O) degPref
---+---------------+---------------+---------------+---------------+---+--------
> 192.40.4.0 255.255.255.0 192.40.4.29 192.40.4.29 i 100
> 192.40.6.0 255.255.255.248 192.40.4.29 192.40.4.29 i 100
> 192.40.6.8 255.255.255.248 192.40.4.29 192.40.4.29 i 100
U 110.100.10.0 255.255.255.0 2001:100:3:4::1 110.100.10.20 ? 100
U 110.100.11.0 255.255.255.0 2001:100:3:4::1 110.100.10.20 ? 100
U 110.100.12.0 255.255.255.0 2001:100:3:4::1 110.100.10.20 ? 100
U 110.100.13.0 255.255.255.0 2001:100:3:4::1 110.100.10.20 ? 100
U 110.100.14.0 255.255.255.0 2001:100:3:4::1 110.100.10.20 ? 100

output definitions
Sta Status flag. A greater-than sign (>) indicates this is the best route to the
destination.
Network The IP address for this route path. This is the destination of the route.
Mask The mask for this route path.
Nbr address The IP or IPv6 address of the BGP peer that is advertising this path.
Next Hop The next hop along the route path.
(0) The origin attribute of this route path. A question mark (?) indicates
incomplete, and i indicates IGP, and an e indicates EGP.
degPref The local preference value assigned to this route path.

-> show ip bgp path ip-addr 192.40.6.72 255.255.255.248

BGP Path parameters
Path address = 192.40.6.72
Path mask = 255.255.255.248
Path protocol = ebgp
Path peer = 192.40.4.29
Path nextHop = 192.40.4.29,
Path origin = igp,
Path local preference = -1,
Path state = active,
Path weight = 0,
Path preference degree = 100,
Path autonomous systems = [nAs=2] : 3 2 ,
Path MED = -1,
Path atomic = no,
Path AS aggregator = <none>,
Path IPaddr aggregator = <none>,
Path community = <none>,
Path unknown attribute = <none>

page 26-160 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp path

output definitions
Path address The IP address for route path.
Path mask The mask for this route path.
Path protocol The protocol from which this route path was learned. Possible values
for this field are as follows: local, static, directhost, rip, ospf, isis,
ibgp, ebgp, and other.
Path peer The IP address of the peer that is advertising this route path.
Path nextHop The next hop along the route path.
Path origin The BGP origin attribute. Possible values will be igp, egp, incom-
plete, and none. The origin attribute is considered during the route
decision process.
Path local preference The local preference value for this route as received in an UPDATE
message. A negative value (for example, the -1 in the above display)
indicates that the local preference value is missing for this route path.
Path state Path state indicates the state of the path.The possible states are best,
feasible, policy-wait, un-synchronized, dampened, or none. When
path state is none, it indicates that there are no paths to this prefix and
the route is being purged from the system.
Path weight The path weight as assigned through inbound and outbound policies.
Path preference degree The local preference assigned to this route through an inbound or
outbound policy, or, if the local preference value is missing, the default
local preference (which is assigned through the ip bgp default local-
preference).
Path autonomous systems The AS path for this route. These numbers show the ASs through
which the route has traversed with the most recent AS listed first. In
the above example, this route began its path in AS 2 and then traveled
through AS 3.
Path MED The multi-exit discriminator (MED) value for this route path. A
negative value (for example, the -1 in the above display) indicates that
the MED value is missing for this route path.
Path atomic Indicates whether the ATOMIC-AGGREGATE attribute has been set
for this route. When set (this field would read yes), this attribute
indicates that an aggregate has caused a loss of information for this
route (a less specific route was chosen over a more specific route
included in the aggregate).
Path AS aggregator Part of the AGGREGATOR attribute. This field indicates the AS for
the BGP speaker that created the aggregate. A value of <none>
indicates this is not an aggregate route.
Path IPaddr aggregator Part of the AGGREGATOR attribute. This field indicates the IP
address for the BGP speaker that created the aggregate. A value of
<none> indicates that this is not an aggregate route.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-161
show ip bgp path BGP Commands

output definitions (continued)

Path community Indicates the community to which this route path belongs, if
applicable. A value of <none> indicates that this route does not belong
to a community.
Path unknown attribute Indicates BGP attributes found in UPDATE messages which the router
does not support. For example, multi-protocol attributes are not
supported by the router in this release, but it is possible for these
attributes to appear in a BGP route.

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip bgp routes Displays BGP route details.

MIB Objects
alaBgpPathTable
alaBgpPathEntry

page 26-162 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp routes

show ip bgp routes

Displays BGP route details.
show ip bgp routes [network_address ip_mask]

Syntax Definitions

network_address A 32-bit IP address.

ip_mask A 32-bit subnet mask number that determines how many bits of the IP
address parameter denote the network number

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays all the routes in the routing table with details.

Examples
-> show ip bgp routes
Legends: ECL = EBGP change list, ICC = IBGP client change list
ICL = IBGP change list, LCL = local change list
AGG = Aggregation, AGC = Aggregation contribution
AGL = Aggregation list, GDL = Deletion list
AGW = Aggregation waiting, AGH = Aggregation hidden
DMP = Dampening, ACT = Active route
Address Mask ECL ICC ICL LCL AGG AGC AGL AGW AGH GDL DMP ACT
---------------+---------------+---+---+---+---+---+---+---+---+---+---+---+---
192.40.4.0 255.255.255.0 No No No No No No No No No No No Yes
192.40.6.0 255.255.255.248 No No No No No No No No No No No Yes
192.40.6.8 255.255.255.248 No No No No No No No No No No No Yes
192.40.6.72 255.255.255.248 No No No No No No No No No No No Yes
192.40.6.80 255.255.255.248 No No No No No No No No No No No Yes
192.40.6.104 255.255.255.248 No No No No No No No No No No No Yes
192.40.6.112 255.255.255.248 No No No No No No No No No No No Yes
192.40.6.144 255.255.255.248 No No No No No No No No No No No Yes

output definitions
Address The route destination network address.
Mask The route destination network mask.
ECL External BGP change list. When Yes, this route will be advertised as
soon as the route advertisement timer expires.
ICC Internal BGP client change list. When Yes, this route will be
advertised to internal non-clients.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-163
show ip bgp routes BGP Commands

output definitions (continued)

ICL Internal BGP change list. When Yes, this route has changes that need
to be advertised.
LCL Local change list. When Yes, this route is local.
AGG Aggregation. When Yes, this route is an aggregate route.
AGC Aggregation contribution. When Yes, this route is part of an aggregate
route.
AGL Aggregation list. When Yes, this route is placed on an aggregate list.
AGW Aggregation waiting. When Yes, this route is waiting for an aggregate
contributor.
AGH Aggregation hidden. When Yes, this route is hidden as part of an
aggregate route.
GDL Deletion list. When Yes, this route will be deleted.
DMP Dampening. Indicate whether this route has been dampened. If ‘Yes’,
then this route has been dampened and a dampening history exists.
ACT Active route. When Yes, the route is active.

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip bgp path Displays BGP paths.

MIB Objects
alaBgpRouteTable
alaBgpRouteEntry

page 26-164 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp aggregate-address

show ip bgp aggregate-address

Displays aggregate route status.
show ip bgp aggregate-address [ip_address ip mask]

Syntax Definitions

ip_address The 32-bit IP address of the aggregate address.

ip_mask The 32-bit subnet mask number that determines how many bits of the IP
address parameter denote the network number.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays a specific aggregate address, or all aggregate addresses on the router.

Examples
-> show ip bgp aggregate-address
Network Mask Summarize As-Set Admin state Oper state
---------------+---------------+---------+--------+-----------+----------
155.132.44.73 255.255.255.255 disabled disabled disabled not_active
192.40.6.0 255.255.255.255 disabled disabled disabled not_active

-> show ip bgp aggregate-address 192.40.6.0 255.255.255.255

Aggregate address = 192.40.6.0,
Aggregate mask = 255.255.255.255,
Aggregate admin state = disabled,
Aggregate oper state = not_active,
Aggregate as-set = disabled,
Aggregate summarize = disabled,
Aggregate metric = 0,
Aggregate local preference = 0,
Aggregate community string = 0:500 400:1 300:2

output definitions
Network or Aggregate address The IP address for this aggregate route. This value is configured
through the ip bgp aggregate-address command.
Mask or Aggregate mask The mask for this aggregate route. This value is configured through the
ip bgp aggregate-address command.
Summarize or Indicates whether aggregate summarization is enabled or disabled for
Aggregate summarize this aggregate route. This value is configured through the ip bgp
aggregate-address summary-only command.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-165
show ip bgp aggregate-address BGP Commands

output definitions (continued)

As-Set or Aggregate as-set Indicates whether AS path aggregate is enabled or disabled. This value
is configured through the ip bgp aggregate-address as-set command.
Admin State or Indicates whether this aggregate route is administratively enabled or
Aggregate admin state disabled. This value is configured through the ip bgp aggregate-
address admin-state command.
Oper State or Indicates whether this aggregate route is operational and participating
Aggregate oper state in BGP message exchanges.
Aggregate metric The multi-exit discriminator (MED) value configured for this
aggregate route. This value is configured through the ip bgp
aggregate-address metric command.
Aggregate local preference The local preference value for this aggregate route. This value is
configured through the ip bgp aggregate-address local-preference
command.
Aggregate community string The community string value for this aggregate route. This value is
configured through the ip bgp aggregate-address community
command.

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp aggregate-address Creates and deletes a BGP aggregate route.

MIB Objects
alabgpMIBAggrGroup
alaBgpAggrSet
alaBgpAggrLocalPref
alaBgpAggrMetric
alaBgpAggrSummarize
alaBgpAggrCommunity

page 26-166 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp network

show ip bgp network

Displays currently defined network configurations.
show ip bgp network [network_address ip_mask]

Syntax Definitions

network_address A 32-bit IP address.

ip_mask A 32-bit subnet mask number that determines how many bits of the IP
address parameter denote the network number

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays all the configured networks, or a single network.

Examples
-> show ip bgp network
Network Mask Admin state Oper state
---------------+---------------+-----------+----------
155.132.1.2 255.255.255.255 disabled not_active
155.132.1.3 255.255.255.255 disabled not_active

-> show ip bgp network 155.132.1.2 255.255.255.255

Network address = 155.132.1.2,
Network mask = 255.255.255.255,
Network admin state = disabled,
Network oper state = not_active,
Network metric = 0,
Network local preference = 0,
Network community string = 0:500 400:1 300:2

output definitions
Network or Network address The IP address configured for this local BGP network. This value is
configured through the ip bgp network command.
Mask or Network mask The mask configured for this local BGP network. This value is
configured through the ip bgp network command.
Admin state or Indicates whether this local BGP network is administratively enabled
Network admin state or disabled. This value is configured through the ip bgp network
admin-state command.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-167
show ip bgp network BGP Commands

output definitions (continued)

Oper state or Indicates whether this BGP local network is operationally active or
Network oper state inactive.
Network metric The multi-exit discriminator (MED) value configured for this local
BGP network. This value is configured through the ip bgp network
metric command.
Network local preference The local preference value for this local BGP network. This value is
configured through the ip bgp network local-preference command.
Network community string The community string value for this local BGP network. This value is
configured through the ip bgp network community command.

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp network Configures a local BGP network.

MIB Objects
alabgpMIBNetworkGroup
alaBgpNetworkEntry

page 26-168 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp neighbors

show ip bgp neighbors

Displays the configured IPv4 BGP peers.
show ip bgp neighbors [ip_address]

Syntax Definitions

ip_address A 32-bit IP address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
There are two output options for this command. If you specify show ip bgp peer without a peer IP address,
then you see summary information for all peers known to the local BGP speaker. If you enter a specific
peer IP address with the command, then you see detailed parameter information for that peer only.

Examples
-> show ip bgp neighbors
Legends:Nbr = Neighbor
As = Autonomous System
Nbr address As Admin state Oper state BgpId Up/Down
---------------+-----+-----------+------------+---------------+-----------
192.40.4.29 3 enabled estab 192.40.4.29 00h:14m:48s
192.40.4.121 5 disabled idle 0.0.0.0 00h:00m:00s

output definitions
Nbr address The IP address for this BGP peer. Assign this address through the ip
bgp neighbor command.
As The autonomous system to which this peer belongs. A peer’s AS num-
ber is assigned through the ip bgp neighbor remote-as command.
Admin state Indicates whether this peer has been enabled or disabled through the ip
bgp neighbor admin-state command.
Oper state The current BGP state for this peer. Possible states are idle, connect,
active, opensent, openconfirm, and established.
BgpId The unique BGP identifier of the peer. This value is configured
through the ip bgp neighbor update-source command.
Up/Down The time since this peer has transitioned to its current UP or DOWN
state. If the peer is currently Established, then this is the time that the
peer has been UP. If the peer is currently Idle, then this is the time the
peer has been DOWN.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-169
show ip bgp neighbors BGP Commands

-> show ip bgp neighbors 0.0.0.1

Neighbor address = 0.0.0.1,
Neighbor autonomous system = 1,
Neighbor Admin state = enabled,
Neighbor Oper state = connect,
Neighbor passive status = disabled,
Neighbor name = peer(0.0.0.1),
Neighbor local address = vlan-215,
Neighbor EBGP multiHop = enabled,
Neighbor next hop self = disabled,
Neighbor Route Refresh = enabled,
Neighbor Ipv4 unicast = enabled,
Neighbor Ipv4 multicast = disabled,
Neighbor type = internal,
Neighbor auto-restart = enabled,
Neighbor route-reflector-client = disabled,
Neighbor confederation status = disabled,
Neighbor remove private AS = disabled,
Neighbor default originate = disabled,
Neighbor maximum prefixes = 5000,
Neighbor max prefixes warning = enabled,
# of prefixes received = 0,
Neighbor MD5 key = <none>,
Neighbor local port = 0,
Neighbor TCP window size = 32768
Graceful Restart State = None,
Advertised Restart Interval = 0s,
Forwarding State during restart = NotPreserved,
Activate IPv6 unicast = enabled,
Configured IPv6 NextHop Address = ::,
Neighbor Ipv6 unicast = advertised

output definitions
Neighbor address The IP address for this BGP peer. Assign this address through the ip
bgp neighbor command.
Neighbor autonomous system The autonomous system to which this peer belongs. A peer’s AS
number is assigned through the ip bgp neighbor remote-as command.
Neighbor Admin state Indicates whether this peer has been enabled or disabled through the ip
bgp neighbor admin-state command.
Neighbor Oper state The current BGP state for this peer. Possible states are idle, connect,
active, opensent, openconfirm, and established.
Neighbor passive status Indicates whether the local BGP speaker is “passive” (i.e., waiting for
this peer to initiate a session). This value is configured through the ip
bgp neighbor passive command.
Neighbor name The name assigned to this peer through the ip bgp neighbor descrip-
tion command.
Neighbor local address The interface assigned to this peer. This value is configured through
the ip bgp neighbor update-source command.
Neighbor EBGP multihop Indicates whether BGP multi-hop support is enabled or disabled. This
supports allows external BGP peers to communicate with each other
even when they are not directly connected. This value is configured
through the ip bgp neighbor ebgp-multihop command.

page 26-170 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp neighbors

output definitions (continued)

Neighbor next hop self Indicates whether this peer is using next hop processing. This value is
configured through the ip bgp neighbor next-hop-self command.
Neighbor Route Refresh Indicates whether this peer supports Route Refresh capability as
defined in RFC 2918. This capability is an alternative to soft-reconfig-
uration that can save CPU and memory resources. It allows peers to
dynamically request the re-advertisement of BGP routing tables. Since
this router supports route refresh all BGP peers are automatically
enabled for this capability.
Neighbor Ipv4 unicast Indicates whether this peer is multi-protocol IP version 4 unicast capa-
ble. This router is IPv4 unicasts capable so all peers will be enabled for
this capability.
Neighbor Ipv4 multicast Indicates whether this peer is multi-protocol IP version 4 multicast
capable. This router is not IPv4 multicasts capable so all peers will be
disabled for this capability.
Neighbor type Indicates whether this peer is internal or external to the router.
Neighbor auto-restart Indicates whether peer auto-restart is enabled or disabled. This value is
configured through the ip bgp neighbor auto-restart command.
Neighbor route-reflector- cli- Indicates whether this peer is a client to the local route reflector, if
ent configured. This value is configured through the ip bgp neighbor
route-reflector-client command.
Neighbor confederation status Indicates whether this peer is a member of a BGP confederation. This
value is configured through the ip bgp confederation neighbor com-
mand.
Neighbor remove private AS Indicates whether the stripping of private AS numbers (64512 to
65535) from AS paths is enabled or disabled. This value is configured
through the ip bgp neighbor remove-private-as command.
Neighbor default originate Indicates whether peer default origination is enabled or disabled.
When enabled, the local BGP speaker advertises itself as a default to
the peer. This value is configured through the ip bgp neighbor
default-originate command.
Neighbor maximum prefixes The maximum number of prefixes the local router can receive in
UPDATE from this peer. This value is configured through the ip bgp
neighbor maximum-prefix command.
Neighbor max prefixes warn- Indicates whether a warning will be issued when this peer exceeds 80
ing percent of the maximum prefix value. This value is configured through
the ip bgp neighbor update-source command.
# of prefixes received Displays the total number of prefixes received by this neighbor.
Neighbor MD5 key [32- 47] When present, shows an encrypted version of the MD5 password.
When not present, and MD5 password has not been configured. This
value is configured through the ip bgp neighbor md5 key command.
Neighbor local port The TCP port used for the session with this peer.
Neighbor TCP window size The size of the TCP window for this BGP session. This value will
always be 32768 as that is the maximum size of a BGP message.
Graceful Restart State Indicates the graceful restart state. This feature is not supported in
Multiprotocol BGP.
Advertised Restart Interval Indicates the restart interval in seconds.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-171
show ip bgp neighbors BGP Commands

output definitions (continued)

Forwarding State during Indicates whether the peer has preserved the forwarding state during
restart the graceful restart.
Activate IPv6 unicast Indicates if the IPv6 unicast updates are enabled or not. Options
include enabled or disabled.
Configured IPv6 NextHop Specifies the IPv6 nexthop address. This is specified using the ipv6
Address bgp neighbor ipv6-nexthop command.
Neighbor Ipv6 unicast Indicates whether Multiprotocol IPv6 Unicast capability is
enabled or disabled between the peers.

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp neighbor Creates or deletes a BGP peer.

MIB Objects
alabgpMIBPeerGroup
alaBgpPeerAddr
alaBgpPeerAS
alaBgpPeerPassive
alaBgpPeerName
alaBgpPeerMultiHop
alaBgpPeerMaxPrefix
alaBgpPeerMaxPrefixWarnOnly
alaBgpPeerNextHopSelf
alaBgpPeerSoftReconfig
alaBgpPeerInSoftReset
alaBgpPeerIpv4Unicast
alaBgpPeerIpv4Multicast
alaBgpPeerRcvdRtRefreshMsgs
alaBgpPeerSentRtRefreshMsgs
alaBgpPeerRouteMapOut
alaBgpPeerRouteMapIn
alaBgpPeerLocalAddr
alaBgpPeerLastDownReason
alaBgpPeerLastDownTime
alaBgpPeerLastReadTime
alaBgpPeerRcvdNotifyMsgs
alaBgpPeerSentNotifyMsgs
alaBgpPeerLastSentNotifyReason
alaBgpPeerLastRecvNotifyReason
alaBgpPeerRcvdPrefixes
alaBgpPeerDownTransitions
alaBgpPeerType
alaBgpPeerAutoReStart
alaBgpPeerClientStatus
alaBgpPeerConfedStatus
alaBgpPeerRemovePrivateAs
alaBgpPeerClearCounter
alaBgpPeerTTL

page 26-172 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp neighbors

alaBgpPeerAspathListOut
alaBgpPeerAspathListIn
alaBgpPeerPrefixListOut
alaBgpPeerPrefixListIn
alaBgpPeerCommunityListOut
alaBgpPeerCommunityListIn
alaBgpPeerRestart
alaBgpPeerDefaultOriginate
alaBgpPeerReconfigureInBound
alaBgpPeerReconfigureOutBound
alaBgpPeerMD5Key
alaBgpPeerMD5KeyEncrypt
alaBgpPeerRowStatus
alaBgpPeerUpTransitions
alaBgpPeerLocalIntfName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-173
show ip bgp neighbors policy BGP Commands

show ip bgp neighbors policy

Displays BGP peer policy information.
show ip bgp neighbors policy [ip_address]

Syntax Definitions

ip_address A 32-bit IP address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays all of the configured policies for the router, or the polices configured for a specific
peer.

Examples
-> show ip bgp neighbors policy
Neighbor address = 0.0.0.0,
Neighbor autonomous system = 1,
Neighbor output policy map name = <none>,
Neighbor input policy map name = <none>,
Neighbor output aspath-list name = <none>,
Neighbor input aspath-list name = <none>,
Neighbor output prefix-list name = <none>,
Neighbor input prefix-list name = <none>,
Neighbor output community-list name = <none>,
Neighbor input community-list name = <none>,
Neighbor soft reconfiguration = enabled
Neighbor address = 0.0.0.1,
Neighbor autonomous system = 1,
Neighbor output policy map name = <none>,
Neighbor input policy map name = <none>,
Neighbor output aspath-list name = <none>,
Neighbor input aspath-list name = <none>,
Neighbor output prefix-list name = <none>,
Neighbor input prefix-list name = <none>,
Neighbor output community-list name = <none>,
Neighbor input community-list name = <none>,
Neighbor soft reconfiguration = enabled

page 26-174 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp neighbors policy

output definitions
Neighbor autonomous system The AS to which the peer is assigned. This can be assigned by using
the ip bgp neighbor remote-as command.
Neighbor output policy map The outbound route map policy for the peer. This can be assigned by
name using the ip bgp neighbor route-map command.
Neighbor input policy map The inbound route map policy for the peer. This can be assigned by
name using the ip bgp neighbor route-map command.
Neighbor output aspath-list The outbound AS path list policy for the peer. This can be assigned by
name using the ip bgp neighbor out-aspathlist command.
Neighbor input aspath-list The inbound AS path list policy for the peer. This can be assigned by
name using the ip bgp neighbor in-aspathlist command.
Neighbor output prefix-list The outbound prefix list policy for the peer. This can be assigned by
name using the ip bgp neighbor out-prefixlist command.
Neighbor input prefix-list The inbound prefix list policy for the peer. This can be assigned by
name using the ip bgp neighbor in-prefixlist command.
Neighbor output community- The outbound community list policy for the peer. This can be assigned
list name by using the ip bgp neighbor out-communitylist command.
Neighbor input community-list The inbound community list policy for the peer. This can be assigned
name by using the ip bgp neighbor in-communitylist command.
Neighbor soft reconfiguration Lists whether soft reconfigurations are enabled or disabled for this
peer. This is configured using the ip bgp neighbor soft-
reconfiguration command.

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip bgp neighbors Displays BGP peer main status.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-175
show ip bgp neighbors timer BGP Commands

show ip bgp neighbors timer

Displays BGP peer timer statistics.
show ip bgp neighbors timer [ip_address]

Syntax Definitions

ip_address A 32-bit IP address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays the timer values for all peer associated with this speaker, or for a specific peer.

Examples
-> show ip bgp neighbors timer
Legends: Nbr = Neighbor
As = Autonomous System
RtAdv = Route Advertisement
Kalive = Keep Alive (actual)
Ka(C) = Configured Keep Alive
Nbr address As Hold Hold(C) RtAdv Retry Kalive Ka(C)
---------------+-----+-----+-------+-----+-----+------+-----
192.40.4.29 3 90 90 30 120 30 30
192.40.4.121 5 0 90 30 120 0 30

output definitions
Nbr address The IP address for this BGP peer. Assign this address through the ip
bgp neighbor command.
As The autonomous system to which this peer belongs. A peer’s AS
number is assigned through the ip bgp neighbor remote-as command.
Hold The current count for the holdtime value.
Hold(C) The holdtime value configured through the ip bgp neighbor timers
command.
RtAdv The route advertisement interval, in seconds, for updates between
external BGP peers. This value is configured through the ip bgp
neighbor advertisement-interval command.
Retry The interval, in seconds, between retries by this peer to set up a
connection through TCP with another peer. This value is configured
through the ip bgp neighbor timers command.

page 26-176 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp neighbors timer

output definitions (continued)

Kalive The current count, in seconds, between keepalive messages. Keepalive
messages do not contain route or status updates; they serve only to tell
other peers that the connection is still live and this peer is reachable.
Ka(C) The keepalive interval as configured through the ip bgp neighbor
timers command.

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip bgp neighbors Displays BGP peer main status.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-177
show ip bgp neighbors statistics BGP Commands

show ip bgp neighbors statistics

Displays BGP peer message statistics.
show ip bgp neighbors statistics [ip_address]

Syntax Definitions

ip_address A 32-bit IP address of the peer.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays message statistics for all peers associated with this speaker, or with a specific
peer.

Examples
-> show ip bgp neighbors statistics
Legends: RMSGS = number of received messages, SMSGS = number of sent messages
RUPDS = number of Update messages received,
SUPDS = number of Update messages sent,
RNOFY = number of Notify messages received,
SNOFY = number of Notify messages sent
RPFXS = number of prefixes received
UPTNS = number of UP transitions
DNTNS = number of DOWN transitions

Nbr address As RMSGS SMSGS RUPDS SUPDS RNOFY SNOFY RPFXS UPTNS DNTNS
---------------+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----
192.40.4.29 3 110 123 5 0 0 1 8 2 2
192.40.4.121 5 0 0 0 0 0 0 0 0 0

output definitions
Nbr address The IP address for this peer. This value is configured through the ip
bgp neighbor command.
As The autonomous system to which this peer belongs. This value is
configured through the ip bgp neighbor remote-as command.
RMSGS Total number of messages (UPDATE, NOTIFY, OPEN, KEEPALIVE)
received by this peer.
SMSGS Total number of messages (UPDATE, NOTIFY, OPEN, KEEPALIVE)
sent by this peer.

page 26-178 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp neighbors statistics

output definitions (continued)

RUPDS The number of route UPDATE messages received by this peer.
UPDATE messages contain route reachability information, BGP
attributes, and route feasibility information.
SUPDS The number of route UPDATE messages sent by this peer. UPDATE
messages contain route reachability information, BGP attributes, and
route feasibility information.
RNOFY The number of NOTIFY messages received by this peer. NOTIFY
messages contain error information, such as unsupported parameters,
invalid attributes, and holdtime expirations.
SNOFY The number of NOTIFY messages sent by this peer. NOTIFY
messages contain error information, such as unsupported parameters,
invalid attributes, and holdtime expirations.
RPFXS The number of unique route prefixes received by this peer.
UPTNS The number of times this peer has come up, operationally.
DNTNS Number of times this peer has gone down, operationally.

-> show ip bgp neighbors statistics 0.0.0.1

Neighbor address = 0.0.0.1,
# of UP transitions = 0,
Time of last UP transition = 00h:00m:00s,
# of DOWN transitions = 0,
Time of last DOWN transition = 00h:00m:00s,
Last DOWN reason = none,
# of msgs rcvd = 0,
# of Update msgs rcvd = 0,
# of prefixes rcvd = 0,
# of Route Refresh msgs rcvd = 0,
# of Notification msgs rcvd = 0,
Last rcvd Notification reason = none [none]
Time last msg was rcvd = 00h:00m:00s,
# of msgs sent = 0,
# of Update msgs sent = 0,
# of Route Refresh msgs sent = 0
# of Notification msgs sent = 0,
Last sent Notification reason = none [none]
Time last msg was sent = 00h:00m:00s,

output definitions
Neighbor address The IP address for this peer. This value is configured through the ip
bgp neighbor command.
# of UP transitions The number of times this peer has come up, operationally.
Time of last UP transition The duration that this peer has been up.
# of DOWN transitions Number of times this peer has gone down, operationally.
Time of last DOWN transition The duration since this peer last went down.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-179
show ip bgp neighbors statistics BGP Commands

output definitions (continued)

Last DOWN reason Provides a message as the last reason why a peer went down. The
possible reasons for going down are:

user_request - user initiated

conn_timeout - connection timer expired
hold_timeout - hold timer expired
bad_msg - received a bad message from neighbor
fsm_blink - BGP FSM error
peer_closed - neighbor closed connection
peer_notify - neighbor sent fatal notification
tcp_error - Fatal TCP error
none - None
# of msgs rcvd Total number of messages (UPDATE, NOTIFY, OPEN, KEEPALIVE)
received from this peer.
# of Update msgs rcvd The number of route UPDATE messages received from this peer.
UPDATE messages contain route reachability information, BGP
attributes, and route feasibility information.
# of prefixes rcvd The number of unique route prefixes received by this peer.
# of Route Refresh msgs rcvd The number of route refresh requests this peer has received. Route
refresh requests all routes learned be a peer.
# of Notification msgs rcvd The number of NOTIFY messages received from this peer. NOTIFY
messages contain error information, such as unsupported parameters,
invalid attributes, and holdtime expirations.

page 26-180 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp neighbors statistics

output definitions (continued)

Last rcvd Notification reason NOTIFY messages include errors codes. These error codes are listed
in this field. They apply to the last NOTIFY message received from
this peer. The notification reasons are listed in two parts separated by a
dash (-). The following are possible notification reasons:
message header error - synchronization loss
message header error - bad length
message header error - bad type
open message error - unsupported version
open message error - bad peer autonomous system
open message error - bad peer bgp id
open message error - unsupported option
open message error - authentication failure
open message error - unacceptable hold time
open message error - unsupported capability
update message error - malformed attribute
update message error - unknown attribute
update message error - missing wellknown attribute
update message error - attribute flags error
update message error - attribute length error
update message error - invalid origin
update message error - as loop
update message error - invalid nexthop
update message error - optional attribute error
update message error - invalid network
update message error - malformed aspath
cease - maximum number of prefixes reached
cease - administrative shutdown
cease - peer de-configured
cease- administrative reset
cease- connection rejected
cease - other configuration change
cease - connection collision resolution
cease - out of resources
hold time out - none
fsm error - none
none - none
Time last msg was rcvd The duration since a message was received from this peer.
# of msgs sent Total number of messages (UPDATE, NOTIFY, OPEN, KEEPALIVE)
sent to this peer.
# of Update msgs sent The number of route UPDATE messages sent to this peer. UPDATE
messages contain route reachability information, BGP attributes, and
route feasibility information.
# of Route Refresh msgs sent The number of route refresh requests this peer has sent. Route refresh
requests request all routes learned be a peer.
# of Notification msgs sent The number of NOTIFY messages sent to this peer. NOTIFY mes-
sages contain error information, such as unsupported parameters,
invalid attributes, and holdtime expirations.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-181
show ip bgp neighbors statistics BGP Commands

output definitions (continued)

Last sent Notification reason NOTIFY messages include errors codes. These error codes are listed
in this field. They apply to the last NOTIFY message sent by this peer.
The notification reasons are listed in two parts separated by a dash (-).
See the list of possible notification reasons under the description for
the Peer last received notification reason field above.
Time last msg was sent The duration since a message was sent to this peer.

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp neighbor Creates or deletes a BGP peer.

MIB Objects
N/A

page 26-182 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp policy aspath-list

show ip bgp policy aspath-list

Displays AS path list parameters.
show ip bgp policy aspath-list [name] [“regular_expression”]

Syntax Definitions

name An AS path name.

regular_expression A regular expression. The regular expression must be enclosed by
quotation marks.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command displays a list of all of the AS path policies for the router, or a single policy selected by
the list name or regular expression.
• Regular expressions are defined in the ip bgp policy aspath-list command on page 26-99.

• When using regular expressions in the CLI, the regular expression must be enclosed by quotation
marks.

Examples
-> show ip bgp policy aspath-list
Aspath List Name Aspath regular expression
-------------------------+--------------------------------------------------
aspl1 (500 | 400) ? 300$
aspl2 (500 | 400)

-> show ip bgp policy aspath-list aspl1

Aspath List name = aspl1
Aspath Regexp = (500 | 400) ? 300$
Admin state = disabled,
Priority = 1,
Action = deny,
Primary index = 0,

output definitions
Aspath List name The name of the AS path list. This is defined using the ip bgp policy
aspath-list command.
Aspath regular expression The regular expression that defines the AS path list. This is defined
using the ip bgp policy aspath-list command.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-183
show ip bgp policy aspath-list BGP Commands

output definitions (continued)

Admin state The administration state of the AS path policy. It is either enable or
disable.
Priority The AS path list priority. This is defined using the ip bgp policy
aspath-list priority command.
Action The AS path list action, either permit or deny. This is defined using the
ip bgp policy aspath-list action command.
Primary index The instance identifier for the AS path list. This value is not
configurable.

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy aspath-list Creates or removes an AS path list.

MIB Objects
alabgpMIBAspathListGroup
alaBgpAspathMatchListId
alaBgpAspathMatchListRegExp
alaBgpAspathMatchListPriority
alaBgpAspathMatchListAction
alaBgpAspathMatchListRowStatus

page 26-184 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp policy community-list

show ip bgp policy community-list

Displays community list parameters.
show ip bgp policy community-list [name] [string]

Syntax Definitions

name Community name.

string Community match list string

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays a list of the community policies for the speaker, or a specific policy defined by its
name or community match string.

Examples
-> show ip bgp policy community-list
Community list name Community string
-------------------------+--------------------------------------------------
adfasdf 0:0

-> show ip bgp policy community-list coml1

Community List name = coml1
Community string = 600:1
Admin state = disabled,
Match type = exact,
Priority = 1,
Action = deny,
Primary index = 0

output definitions
Community List name The community list name. This is defined using the ip bgp policy
community-list command.
Community string The community list definition. This is defined using the ip bgp policy
community-list command.
Admin state The administration state of the community list policy, either enabled or
disabled.
Match type The match type of the community list. This is defined using the ip bgp
policy community-list match-type command.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-185
show ip bgp policy community-list BGP Commands

output definitions (continued)

Priority The community list priority. This is defined using the ip bgp policy
community-list priority command.
Action The community list action. This is defined using the ip bgp policy
community-list action command.
Primary index The instance indentifier for the community list. This value is not
configurable.

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy community-list Creates or deletes a community list.

MIB Objects
alabgpMIBCommunityListGroup
alaBgpCommunityMatchListId
alaBgpCommunityMatchListString
alaBgpCommunityMatchListPriority
alaBgpCommunityMatchListType
alaBgpCommunityMatchListAction
alaBgpCommunityMatchListRowStatus

page 26-186 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp policy prefix-list

show ip bgp policy prefix-list

Displays prefix list parameters.
show ip bgp policy prefix-list [name] [ip_address ip_mask]

Syntax Definitions

name A prefix list name.

ip_address A prefix list IP address.
ip_mask An IP address mask.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays the list of prefix-list policies configured for the speaker, or a specific list
determined by the list name or IP address and mask.

Examples
-> show ip bgp policy prefix-list
Prefix List name Prefix address Prefix mask
-------------------------+---------------+---------------
pfxl1 155.132.33.0 255.255.255.0
pfxl2 155.148.32.0 255.255.255.0

-> show ip bgp policy prefix-list pfxl1

Prefix List name = pfxl1
Address = 155.132.33.0
Mask = 255.255.255.0
Admin state = disabled,
Match Mask >= (GE) = 0,
Match Mask <= (LE) = 0,
Action = deny

output definitions
Prefix List name The name of the prefix list. This is defined using the ip bgp policy
prefix-list command.
Address The IP address of the prefix list. This is defined using the ip bgp
policy prefix-list command.
Mask The mask of the prefix list. This is defined using the ip bgp policy
prefix-list command.
Admin state The administrative state of the prefix list, either enabled or disabled.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-187
show ip bgp policy prefix-list BGP Commands

output definitions (continued)

Match Mask >= (GE) The GE match mask of the prefix list. This is defined using the ip bgp
policy prefix-list ge command.
Match Mask <= (LE) The GE match mask of the prefix list. This is defined using the ip bgp
policy prefix-list le command.
Action The action of the prefix list. This is defined using the ip bgp policy
prefix-list action command.

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy prefix-list Creates or deletes a prefix match list.

MIB Objects
alabgpMIBPrefixListGroup
alaBgpPrefixMatchListId
alaBgpPrefixMatchListAddr
alaBgpPrefixMatchListMask
alaBgpPrefixMatchListGE
alaBgpPrefixMatchListLE
alaBgpPrefixMatchListAction
alaBgpPrefixMatchListRowStatus

page 26-188 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp policy route-map

show ip bgp policy route-map

Displays policy route map parameters.
show ip bgp policy route-map [name] [sequence_number]

Syntax Definitions

name Route map name.

sequence_number A sequence number. The valid range is 1–255.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The route map is displayed as a summary table by entering only the route map name, or as a detailed list
by specifying the sequence number.

Examples
-> show ip bgp policy route-map
RouteMap name Instance
-------------------------+--------
rmap1 1
rmap1 2
rmap2 1

-> show ip bgp policy route-map rmap1

RouteMap name = rmap1
RouteMap instance = 1
Admin state = disabled,
Local pref (mode/value) = <none> / 0,
Route map action = permit,
Origin = <none>,
MED (mode/value) = <none> / 0,
Weight = 0,
Aspath-List name = aspl1,
Aspath prepend = <none>,
Aspath match primitive = 500 .* 400$,
Prefix-List name = <none>,
Prefix match primitive = 0.0.0.0 0.0.0.0,
Community-List name = coml2,
Community match primitive = <none>,
Community string [mode] = [Additive]

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-189
show ip bgp policy route-map BGP Commands

output definitions
RouteMap name The name of the route map policy. This is determined using the ip bgp
policy prefix6-list command.
RouteMap instance The instance of the route map policy. This is determined using the ip
bgp policy prefix6-list command.
Admin state The administrative state of the route map policy, either enabled or
disabled.
Local pref (mode/value) The local preference of the route map policy. This is determined using
the ip bgp policy route-map lpref command.
Route map action The action of the route map policy. This is determined using the ip bgp
policy route-map action command.
Origin The origin of the route map policy. This is determined using the ip bgp
policy route-map origin command.
MED (mode/value) The MED of the route map policy. This is determined using the ip bgp
policy route-map med command.
Weight The weight of the route map policy. This is determined using the ip
bgp policy route-map weight command.
Aspath-List name The name of the AS path list attached to this route map.This is set
using the show ip bgp policy aspath-list command.
Aspath prepend The value to prepend to the AS_PATH attribute of the routes matched
by this RouteMap instance (Empty quotes indicates no AS_PATH
prepending is to be done).
Aspath match primitive The regular expression used to match AS Path for this route map.
Prefix-List name The name of the prefix list attached to this route map. This is set using
the show ip bgp policy prefix-list command.
Prefix match primitive The prefix to match for this route map.
Community-List name The name of the community list attached to this route map. This is set
using the show ip bgp policy community-list command.
Community match primitive The community string to match for this route map.
Community string [mode] The name of the community mode attached to this route map. This is
set using the ip bgp policy route-map community-mode command.

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp policy prefix6-list Creates or deletes a policy route map.

page 26-190 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ip bgp policy route-map

MIB Objects
alabgpMIBRouteMapGroup
alaBgpRouteMapName
alaBgpRouteMapInst
alaBgpRouteMapAsPathMatchListId
alaBgpRouteMapPrefixMatchListId
alaBgpRouteMapCommunityMatchListId
alaBgpRouteMapOrigin
alaBgpRouteMapLocalPref
alaBgpRouteMapLocalPrefMode
alaBgpRouteMapMed
alaBgpRouteMapMedMode
alaBgpRouteMapAsPrepend
alaBgpRouteMapSetCommunityMode
alaBgpRouteMapCommunity
alaBgpRouteMapMatchAsRegExp
alaBgpRouteMapMatchPrefix
alaBgpRouteMapMatchMask
alaBgpRouteMapMatchCommunity
alaBgpRouteMapWeight
alaBgpRouteMapAction
alaBgpRouteMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-191
ip bgp graceful-restart BGP Commands

ip bgp graceful-restart
Configures support for the graceful restart feature on a BGP router.
ip bgp graceful-restart
no ip bgp graceful-restart

Syntax Definitions

N/A

Defaults
Graceful restart is enabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable support for the graceful restart feature on a BGP router. It
has only unplanned graceful restart.
• The minimum hardware configuration for this command is a redundant CMM configuration. This
command is not supported on an OmniSwitch 10K with a single CMM.
• Note that graceful restart does not support IPv6 prefixes at this time.

Examples
-> ip bgp graceful restart
-> no ip bgp graceful restart

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip bgp Displays the current global settings for the local BGP speaker.

MIB Objects
alaBgpGlobal
alaBgpGracefulRestart
alaBgpRestartInterval

page 26-192 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp graceful-restart restart-interval

ip bgp graceful-restart restart-interval

Configures the grace period for achieving a graceful BGP restart.
ip bgp graceful-restart restart-interval [seconds]

Syntax Definitions

seconds The hitless restart timeout interval, in seconds. The valid range is 1–
3600.

Defaults

parameter default
seconds 90

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The minimum hardware configuration for this command is a redundant CMM configuration. This
command is not supported on an OmniSwitch 10K with a single CMM.
• Note that graceful restart does not support IPv6 prefixes at this time.

Examples
-> ip bgp graceful-restart restart-interval 600

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip bgp Displays the current global settings for the local BGP speaker.

MIB Objects
alaBgpGlobal
alaBgpGracefulRestart
alaBgpRestartInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-193
ip bgp unicast BGP Commands

ip bgp unicast
Enables or disables unicast IPv4 advertisements for the BGP routing process.
ip bgp unicast
no ip bgp unicast

Syntax Definitions

N/A

Defaults
By default, BGP IPv4 advertisements are enabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to turn off IPv4 unicast advertisements.

• BGP should be disabled before enabling or disabling IPv4 unicast advertisements.

• IPv4 unicast advertisements may be turned off on homogeneous IPv6 networks that are not aware of
IPv4 routing. In such cases, the command, ip router router-id, must be used to explicitly configure the
32-bit unique router identifier.

Examples
-> ip bgp unicast
-> no ip bgp unicast

Release History
Release 8.1.1; command was introduced.

Related Commands

ipv6 bgp unicast Enables or disables unicast IPv6 updates for the BGP routing process.
show ip bgp Displays the current global settings for the local BGP speaker.
ip router router-id Configures the router ID for the router.

MIB Objects
alaBgpGlobal
alaBgpMultiProtocolIpv4

page 26-194 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ipv6 bgp unicast

ipv6 bgp unicast

Enables or disables unicast IPv6 advertisements for the BGP routing process.
ipv6 bgp unicast
no ipv6 bgp unicast

Syntax Definitions

N/A

Defaults
By default, IPv6 BGP advertisements are disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to turn off IPv6 unicast advertisements.

• BGP should be disabled before enabling or disabling IPv6 unicast advertisements.

Examples
-> ipv6 bgp unicast
-> no ipv6 bgp unicast

Release History
Release 8.1.1; command was introduced.

Related Commands

ip bgp unicast Enables or disables unicast IPv4 updates for the BGP routing process.
show ip bgp Displays the current global settings for the local BGP speaker.

MIB Objects
alaBgpGlobal
alaBgpMultiProtocolIpv6

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-195
ip bgp neighbor activate-ipv6 BGP Commands

ip bgp neighbor activate-ipv6

Enables or disables the exchange of IPv6 unicast routes between BGP peer routers identified by their IPv4
addresses.
ip bgp neighbor ip_address activate-ipv6
no ip bgp neighbor ip_address activate-ipv6

Syntax Definitions

ip_address The 32-bit IPv4 address of the neighbor.

Defaults
This command is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to disable the exchange of IPv6 unicast routes between BGP peer
routers identified by their IPv4 addresses.

Examples
-> ip bgp neighbor 1.0.0.1 activate-ipv6
-> no ip bgp neighbor 1.0.0.1 activate-ipv6

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip bgp neighbors Displays BGP peer main status.

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
alaBgpPeerIpv6Unicast

page 26-196 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ip bgp neighbor ipv6-nexthop

ip bgp neighbor ipv6-nexthop

Configures the IPv6 next hop addresses for the IPv6 prefixes advertised between BGP peers. These BGP
peers are identified by their IPv4 addresses.
ip bgp neighbor ip_address ipv6-nexthop ipv6_address

Syntax Definitions

ip_address The 32-bit IPv4 address of the neighbor.

ipv6_address A 128-bit global IPv6 address to be used as the next hop for IPv6 routes
being advertised to this BGP speaker.

Defaults
By default, the IPv6 next hop value is set to all zeros.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• To reset the IPv6 next hop value, enter an all-zero address.

• For internal BGP (IBGP) peers, the IPv6 next hop is used only if the peer next-hop-self option is
configured.
• For external BGP (EBGP) peers, the IPv6 next hop is used for all the advertised IPv6 routes.

Examples
-> ip bgp neighbor 1.0.0.1 ipv6-nexthop 2001:100:3:4::1
-> ip bgp neighbor 1.0.0.1 ipv6-nexthop ::

Release History
Release 8.1.1; command was introduced.

Related Commands

show ipv6 bgp neighbors Displays the configured IPv6 BGP peers.

MIB Objects
alaBgpPeerTable
alaBgpPeerAddr
alaBgpPeerIpv6NextHop

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-197
show ipv6 bgp path BGP Commands

show ipv6 bgp path

Displays the known IPv6 BGP paths for all the routes or a specific route.
show ipv6 bgp path [ipv6-addr ipv6_address/prefix_length]

Syntax Definitions

ipv6_address The 128-bit IPv6 address.

/prefix_length The number of bits that are significant in the IPv6 address (mask) (3–
128)

Defaults
By default, IPv6 BGP paths for all the routes will be displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the ipv6_address/prefix_length parameter to display the IPv6 BGP paths for a specified route.

Examples
-> show ipv6 bgp path
Legends: Sta = Path state
> = best, F = feasible, S = stale
U = un-synchronized
Nbr = Neighbor
(O) = Path Origin (? = incomplete, i = igp, e = egp)
degPref = degree of preference
Sta Prefix Nbr Address (O) degPref
---+-----------------------------+------------------------------------+---+-------
> 2020:100:200:1::/64 2001:100:3:4::1 i 100
> 2020:100:200:2::/64 2001:100:3:4::1 i 100
> 2020:100:200:3::/64 2001:100:3:4::1 i 100
> 2020:100:200:4::/64 2001:100:3:4::1 i 100
> 2020:100:200:5::/64 2001:100:3:4::1 i 100
> 2525:2525:1::/48 100.3.4.1 i 100
> 2525:2525:2::/48 100.3.4.1 i 100
> 2525:2525:3::/48 100.3.4.1 i 100
> 2525:2525:4::/48 100.3.4.1 i 100
> 2525:2525:5::/48 100.3.4.1 i 100

output definitions
Sta Status flag. A greater-than sign (>) indicates this is the best route to the
destination.
Prefix The destination address of the IPv6 route in the hexadecimal format.
Nbr Address The IP or IPv6 address of the BGP peer that advertises this path.

page 26-198 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ipv6 bgp path

output definitions (continued)

(0) The origin attribute of this route path. A question mark (?) indicates
incomplete, and i indicates IGP, and an e indicates EGP.
degPref The local preference value assigned to this route path.

-> show ipv6 bgp path ipv6-addr 2020:100:200:1::/64

BGP Path parameters
Path address = 2020:100:200:1::
Path Length = 64
Path protocol = ibgp
Path neighbor = peer(2001:100:3:4::1)
Path nextHop = 2001:100:3:4::1,
Path origin = igp,
Path local preference = 100,
Path state = active,
Path weight = 0,
Path preference degree = 100,
Path autonomous systems = [nAs=0] : <none>,
Path MED = <none>,
Path atomic = no,
Path AS aggregator = <none>,
Path IPaddr aggregator = <none>,
Path community = <none>,
Path Originator Id = <none>,
Path Cluster List = <none>,
Path unknown attribute = <none>

output definitions
Path address The IPv6 address for route path.
Path Length The prefix length of the IPv6 path.
Path protocol The protocol from which this route path was learned. Possible values
for this field are as follows: local, static, directhost, rip, ospf, isis,
ibgp, ebgp, and other.
Path neighbor The IPv6 address of the BGP peer.
Path nextHop The next hop along the route path.
Path origin The BGP origin attribute. Possible values will be igp, egp, incomplete,
and none. The origin attribute is considered during the route decision
process.
Path local preference The local preference value for this route as received in an UPDATE
message. A negative value (for example, the -1 in the above display)
indicates that the local preference value is missing for this route path.
Path state Indicates the state of the path.The possible states are best, feasible,
policy-wait, un-synchronized, dampened, or none. When path state
is none, it indicates that there are no paths to this prefix and the route is
being purged from the system.
Path weight The path weight as assigned through inbound and outbound policies.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-199
show ipv6 bgp path BGP Commands

output definitions (continued)

Path preference degree The local preference assigned to this route through an inbound or
outbound policy, or, if the local preference value is missing, the default
local preference (which is assigned through the ip bgp default local-
preference).
Path autonomous systems The AS path for this route. These numbers show the ASs through which
the route has traversed with the most recent AS listed first. In the above
example, this route began its path in AS 2 and then traveled through AS
3.
Path MED The multi-exit discriminator (MED) value for this route path. A
negative value (for example, the -1 in the above display) indicates that
the MED value is missing for this route path.
Path atomic Indicates whether the ATOMIC-AGGREGATE attribute has been set
for this route. When set (this field would read yes), this attribute
indicates that an aggregate has caused a loss of information for this
route (a less specific route was chosen over a more specific route
included in the aggregate).
Path AS aggregator Part of the AGGREGATOR attribute. This field indicates the AS for the
BGP speaker that created the aggregate. A value of <none> indicates
this is not an aggregate route.
Path IPaddr aggregator Part of the AGGREGATOR attribute. This field indicates the IP address
for the BGP speaker that created the aggregate. A value of <none>
indicates that this is not an aggregate route.
Path community Indicates the community to which this route path belongs, if applicable.
A value of <none> indicates that this route does not belong to a
community.
Path Originator Id The Router Id of the BGP4 speaker that performed route reflection
Path Cluster List Sequence of Cluster Id values representing the reflection path that the
route has passed, if this is a reflected route in the local AS.
Path unknown attribute Indicates BGP attributes found in UPDATE messages which the router
does not support. For example, multi-protocol attributes are not
supported by the router in this release, but it is possible for these
attributes to appear in a BGP route.

Release History
Release 8.1.1; command was introduced.

Related Commands

show ipv6 bgp routes Displays the known IPv6 BGP routes.

page 26-200 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ipv6 bgp path

MIB Objects
alaBgpPath6Table
alaBgpPath6Addr
alaBgpPath6MaskLen
alaBgpPath6PeerBgpId
alaBgpPath6SrcProto
alaBgpPath6Weight
alaBgpPath6Pref
alaBgpPath6State
alaBgpPath6Origin
alaBgpPath6NextHop
alaBgpPath6As
alaBgpPath6LocalPref
alaBgpPath6Med
alaBgpPath6Atomic
alaBgpPath6AggregatorAs
alaBgpPath6AggregatorAddr
alaBgpPath6Community
alaBgpPath6OriginatorId
alaBgpPath6ClusterList
alaBgpPath6PeerName
alaBgpPath6UnknownAttr

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-201
show ipv6 bgp routes BGP Commands

show ipv6 bgp routes

Displays the known IPv6 BGP routes.
show ipv6 bgp routes

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 bgp routes
Legends: ECL = EBGP change list, ICC = IBGP client change list
ICL = IBGP change list, LCL = local change list
AGG = Aggregation, AGC = Aggregation contribution
AGL = Aggregation list, GDL = Deletion list
AGW = Aggregation waiting, AGH = Aggregation hidden
DMP = Dampening, ACT = Active route
Prefix ECL ICC ICL LCL AGG AGC AGL AGW AGH GDL DMP ACT
--------------------------------+---+---+---+---+---+---+---+---+---+---+---+----
2020:100:200:1::/64 No No No No No No No No No No No Yes
2020:100:200:2::/64 No No No No No No No No No No No Yes
2020:100:200:3::/64 No No No No No No No No No No No Yes
2020:100:200:4::/64 No No No No No No No No No No No Yes
2020:100:200:5::/64 No No No No No No No No No No No Yes
2525:2525:1::/48 No No No No No No No No No No No Yes
2525:2525:2::/48 No No No No No No No No No No No Yes
2525:2525:3::/48 No No No No No No No No No No No Yes
2525:2525:4::/48 No No No No No No No No No No No Yes
2525:2525:5::/48 No No No No No No No No No No No Yes

output definitions
Prefix The destination address of the IPv6 route in the hexadecimal format.
ECL External BGP change list. When Yes, this route will be advertised as
soon as the route advertisement timer expires.
ICC Internal BGP client change list. When Yes, this route will be advertised
to internal non-clients.

page 26-202 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ipv6 bgp routes

output definitions (continued)

ICL Internal BGP change list. When Yes, this route has changes that need to
be advertised.
LCL Local change list. When Yes, this route is local.
AGG Aggregation. When Yes, this route is an aggregate route.
AGC Aggregation contribution. When Yes, this route is part of an aggregate
route.
AGL Aggregation list. When Yes, this route is placed on an aggregate list.
AGW Aggregation waiting. When Yes, this route is waiting for an aggregate
contributor.
AGH Aggregation hidden. When Yes, this route is hidden as part of an
aggregate route.
GDL Deletion list. When Yes, this route will be deleted.
DMP Dampening. Indicate whether this route has been dampened. If ‘Yes’,
then this route has been dampened and a dampening history exists.
ACT Active route. When Yes, the route is active.

Release History
Release 8.1.1; command was introduced.

Related Commands

show ipv6 bgp path Displays the known IPv6 BGP paths for all the routes or a specific
route.

MIB Objects
alaBgpRoute6Table
alaBgpRoute6Addr
alaBgpRoute6MaskLen
alaBgpRoute6State
alaBgpRoute6IsHidden
alaBgpRoute6IsAggregate
alaBgpRoute6IsAggregateContributor
alaBgpRoute6IsAggregateList
alaBgpRoute6IsAggregateWait
alaBgpRoute6IsOnEbgpChgList
alaBgpRoute6IsOnIbgpClientChgList
alaBgpRoute6IsOnIbgpChgList
alaBgpRoute6IsOnLocalChgList
alaBgpRoute6IsOnDeleteList
alaBgpRoute6IsDampened

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-203
ipv6 bgp network BGP Commands

ipv6 bgp network

Advertises a locally reachable IPv6 address as an IPv6 BGP network to other BGP peers.
ipv6 bgp network ipv6_address/prefix_length
no ipv6 bgp network ipv6_address/prefix_length

Syntax Definitions

ipv6_address The 128-bit IPv6 address.

/prefix_length The number of bits that are significant in the IPv6 address (mask). The
valid range is 3–128)

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to turn off the advertisement of locally reachable IPv6 networks.

Examples
-> ipv6 bgp network 2001::1/64
-> no ipv6 bgp network 2001::1/64

Release History
Release 8.1.1; command was introduced.

Related Commands

ipv6 bgp network admin- Enables or disables a BGP network.

state
show ipv6 bgp network Displays the status of all the IPv6 BGP networks or a specific IPv6
BGP network.

MIB Objects
alaBgpNetwork6Table
alaBgpNetwork6Addr
alaBgpNetwork6MaskLen

page 26-204 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ipv6 bgp network community

ipv6 bgp network community

Defines a community for a route created by the ipv6 bgp network command. Communities are a way of
grouping BGP peers that do not share an IPv6 subnet or an AS.
ipv6 bgp network ipv6_address/prefix_length [community {none | no-export | no-advertise | no-
export-subconfed | num | num:num}]

Syntax Definitions

ipv6_address The 128-bit IPv6 address.

/prefix_length The number of bits that are significant in the IPv6 address (mask). The
valid range is 3–128
none Removes a prefix from a community.
no-export Routes in this community are advertised within the AS but not beyond
the local AS.
no-advertise Routes in this community are not advertised to any peer.
no-export-subconfed Routes in this community are not advertised to any external BGP peer.
num The community attribute number.
num:num Community attribute in the AA : NN format. AA indicates the
autonomous system and NN indicates the community number.

Defaults
By default, a route is not assigned to a community.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The IPv6 BGP route created with the ipv6 bgp network command should exist before the community
attribute is defined.

Examples
-> ipv6 bgp network 2004::2/64 community 23:20

Release History
Release 8.1.1; command was introduced.

Related Commands

ipv6 bgp network Advertises a locally reachable IPv6 address as an IPv6 BGP
network to other BGP peers.
show ipv6 bgp network Displays the status of all the IPv6 BGP networks or a specific IPv6
BGP network

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-205
ipv6 bgp network community BGP Commands

MIB Objects
alaBgpNetwork6Table
alaBgpNetwork6Addr
alaBgpNetwork6MaskLen
alaBgpNetwork6Community

page 26-206 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ipv6 bgp network local-preference

ipv6 bgp network local-preference

Defines the local preference value for a route generated by the ipv6 bgp network command. This value
will override the default local preference value; it is used when announcing this network to internal peers.
ipv6 bgp network ipv6_address/prefix_length [local-preference num]

Syntax Definitions

ipv6_address The 128-bit IPv6 address.

/prefix_length The number of bits that are significant in the IPv6 address (mask). The
valid range is 3–128.
num The local preference attribute value. The valid range is 0–4294967295.

Defaults

parameter default
num 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The IPv6 BGP route created with the ipv6 bgp network command should exist before the local-
preference attribute is defined.

Examples
-> ipv6 bgp network 2004::1/24 local-preference 6

Release History
Release 8.1.1; command was introduced.

Related Commands

ipv6 bgp network Advertises a locally reachable IPv6 address as an IPv6 BGP
network to other BGP peers
show ipv6 bgp network Displays the status of all the IPv6 BGP networks or a specific IPv6
BGP network

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-207
ipv6 bgp network local-preference BGP Commands

MIB Objects
alaBgpNetwork6Table
alaBgpNetwork6Addr
alaBgpNetwork6MaskLen
alaBgpNetwork6LocalPref

page 26-208 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ipv6 bgp network metric

ipv6 bgp network metric

Configures the Multi-Exit Discriminator (MED) attribute value for an network generated by the ipv6 bgp
network command. This value is sent from routers of one AS to another to indicate the path that the
remote AS can use to send data to the local AS.
ipv6 bgp network ipv6_address/prefix_length [metric num]

Syntax Definitions

ipv6_address The 128-bit IPv6 address.

/prefix_length The number of bits that are significant in the IPv6 address (mask). The
valid range is 3–128.
num The MED attribute value. The valid range is 0–4294967295.

Defaults

parameter default
num 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The IPv6 BGP route created with the ipv6 bgp network command should exist before the metric attribute
is defined for the same route.

Examples
-> ipv6 bgp network 2001::1/64 metric 20

Release History
Release 8.1.1; command was introduced.

Related Commands

ipv6 bgp network Advertises a locally reachable IPv6 address as a IPv6 BGP network
to other BGP peers.
show ipv6 bgp network Displays the status of all the IPv6 BGP networks or a specific IPv6
BGP network

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-209
ipv6 bgp network metric BGP Commands

MIB Objects
alaBgpNetwork6Table
alaBgpNetwork6Addr
alaBgpNetwork6MaskLen
alaBgpNetwork6Metric

page 26-210 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ipv6 bgp network admin-state

ipv6 bgp network admin-state

Enables or disables a BGP network. The BGP status must be manually enabled after configuring all the
BGP neighbor and network parameters.
ipv6 bgp network ipv6_address/prefix_length [admin-state {enable | disable}]

Syntax Definitions

ipv6_address The 128-bit IPv6 address.

/prefix_length The number of bits that are significant in the IPv6 address (mask). The
valid range is 3–128.
enable Enables the BGP network.
disable Disables the BGP network.

Defaults
By default, the BGP network is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The IPv6 BGP route created with the ipv6 bgp network command should exist before the status attribute
is defined.

Examples
-> ipv6 bgp network 2001::1/64 admin-state enable

Release History
Release 8.1.1; command was introduced.

Related Commands

show ipv6 bgp network Displays the status of all the IPv6 BGP networks or a specific IPv6
BGP network.

MIB Objects
alaBgpNetwork6Table
alaBgpNetwork6Addr
alaBgpNetwork6MaskLen
alaBgpNetwork6RowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-211
show ipv6 bgp network BGP Commands

show ipv6 bgp network

Displays the status of all the IPv6 BGP networks or a specific IPv6 BGP network.
show ipv6 bgp network [ipv6_address/prefix_length]

Syntax Definitions

ipv6_address The 128-bit IPv6 address.

/prefix_length The number of bits that are significant in the IPv6 address (mask). The
valid range is 3–128.

Defaults
By default, all IPv6 BGP networks and their status will be displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the ipv6_address/prefix_length parameter to display the status of a specific IPv6 BGP nework.

Examples
show ipv6 bgp network
Network Admin state Oper state
------------------------------------+-----------+----------
2525:500:600::/64 enabled active

show ipv6 bgp network 2525:500:600::/64

Network address = 2525:500:600::/64,
Network admin state = enabled,
Network oper state = active,
Network metric = 0,
Network local preference = 0,
Network community string = <none>

output definitions
Network or Network address The IPv6 address configured for this local BGP network. This value is
configured through the ipv6 bgp network command.
Admin state or Network admin Indicates whether this local BGP network is administratively enabled
state or disabled. This value is configured through the
ipv6 bgp network admin-state command.
Oper state or Network oper Indicates whether this BGP local network is operationally active or
state inactive.

page 26-212 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ipv6 bgp network

output definitions (continued)

Network metric The multi-exit discriminator (MED) value configured for this local
BGP network. This value is configured through the ipv6 bgp network
metric command.
Network local preference The local preference value for this local BGP network. This value is
configured through the ipv6 bgp network local-preference command.
Network community string The community string value for this local BGP network. This value is
configured through the ipv6 bgp network community command.

Release History
Release 8.1.1; command was introduced.

Related Commands

ipv6 bgp network Advertises a locally reachable IPv6 address as an IPv6 BGP
network to other BGP peers.

MIB Objects
alaBgpNetwork6Table
alaBgpNetwork6Addr
alaBgpNetwork6MaskLen
alaBgpNetwork6State
alaBgpNetwork6Metric
alaBgpNetwork6LocalPref
alaBgpNetwork6Community
alaBgpNetwork6RowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-213
ipv6 bgp neighbor BGP Commands

ipv6 bgp neighbor

Creates or deletes a BGP peer relationship using IPv6 addresses.
ipv6 bgp neighbor ipv6_address
no ipv6 bgp neighbor ipv6_address

Syntax Definitions

ipv6_address The 128-bit IPv6 address of the new BGP peer.

Defaults
By default, no BGP peers are configured in the BGP network.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete a BGP peer.

• To establish a BGP session, the BGP peer should be reachable.

• You must manually enable a BGP peer after creating it. A BGP peer is enabled using the ipv6 bgp
neighbor admin-state command.
• Once created, a BGP peer must be assigned an autonomous system number using the ipv6 bgp
neighbor remote-as command.
• Use update-source keyword to configure the IPv6 interface when link-local address is used as
neighbor address.

Examples
-> ipv6 bgp neighbor 2001::1
-> no ipv6 bgp neighbor 2001::1

Release History
Release 8.1.1; command was introduced.

page 26-214 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ipv6 bgp neighbor

Related Commands

ipv6 bgp neighbor admin-state Enables or disables the BGP peer status.
ipv6 bgp neighbor remote-as Assigns an AS number to the BGP peer.

MIB Objects
alaBgpPeer6Table
alaBgpPeer6Addr

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-215
ipv6 bgp neighbor activate-ipv6 BGP Commands

ipv6 bgp neighbor activate-ipv6

Enables the exchange of IPv6 unicast routes between BGP peer routers identified by their IPv6 addresses.
ipv6 bgp neighbor ipv6_address [activate-ipv6]
no ipv6 bgp neighbor ipv6_address [activate-ipv6]

Syntax Definitions

ipv6_address The 128-bit IPv6 address.

Defaults
This command is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to disable the exchange of IPv6 unicast routes between BGP peer
routers identified by their IPv6 addresses.

Examples
-> ipv6 bgp neighbor 1.0.0.1 activate-ipv6
-> no ipv6 bgp neighbor 1.0.0.1 activate-ipv6

Release History
Release 8.1.1; command was introduced.

Related Commands

show ipv6 bgp neighbors Displays the configured IPv6 BGP peers.

MIB Objects
alaBgpPeer6Table
alaBgpPeer6Addr
alaBgpPeer6ActivateIpv6

page 26-216 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ipv6 bgp neighbor ipv6-nexthop

ipv6 bgp neighbor ipv6-nexthop

Configures the IPv6 next hop addresses for IPv6 prefixes advertised between BGP peers. These BGP
peers are identified by their IPv6 addresses.
ipv6 bgp neighbor ipv6_address [ipv6-nexthop ipv6_address]

Syntax Definitions

ipv6_address The 128-bit IPv6 address of the next hop router.

Defaults
By default, the IPv6 next hop address is set to all zeros.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• To reset the IPv6 next hop value, enter an all-zero address.

• For internal BGP (IBGP) peers, the IPv6 next hop is used only if the peer next-hop-self option is
configured.
• For external BGP (EBGP) peers, the IPv6 next hop is used for all the advertised IPv6 routes.

• For BGP peers configured with their link-local addresses, the configured IPv6 next hop is used while
advertising IPv6 prefixes.

Examples
-> ipv6 bgp neighbor 2001::1 ipv6-nexthop fe80::/24
-> no ipv6 bgp neighbor 2001::1 ipv6-nexthop fe80::/24

Release History
Release 8.1.1; command was introduced.

Related Commands

show ipv6 bgp neighbors Displays the configured IPv6 BGP peers.

MIB Objects
alaBgpPeer6Table
alaBgpPeer6Addr
alaBgpPeerIpv6NextHop

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-217
ipv6 bgp neighbor admin-state BGP Commands

ipv6 bgp neighbor admin-state

Enables or disables the BGP peer status. These peers are identified by their IPv6 addresses.
ipv6 bgp neighbor ipv6_address [admin-state {enable | disable}]

Syntax Definitions

ipv6_address The 128-bit IPv6 address of the new BGP peer.

enable Enables the BGP peer.
disable Disables the BGP peer.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• You should first create a BGP peer and assign it an IPv6 address using the ipv6 bgp neighbor
command before enabling the peer.
• You should configure all the BGP peer related commands before enabling a BGP peer. Once you have
enabled the peer, it will begin sending BGP connection and route advertisement messages.

Examples
-> ipv6 bgp neighbor 2001::1 admin-state enable
-> ipv6 bgp neighbor 2001::1 admin-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

show ipv6 bgp neighbors Displays the configured IPv6 BGP peers.

MIB Objects
alaBgpPeer6Table
alaBgpPeer6Addr
alaBgpPeer6RowStatus

page 26-218 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ipv6 bgp neighbor remote-as

ipv6 bgp neighbor remote-as

Assigns an AS number to the BGP peer.
ipv6 bgp neighbor ipv6_address [remote-as num]

Syntax Definitions

ipv6_address The 128-bit IPv6 address of the BGP peer.

num Autonomous system number in the range 1–65535.

Defaults

parameter default
num 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• A BGP peer created with the ipv6 bgp neighbor command cannot be enabled until it is assigned an
autonomous system number. If the AS number assigned to the peer matches the AS number of the local
BGP speaker (assigned using the ip bgp autonomous-system command), the peer is considered
internal to the local autonomous system. Otherwise, the peer is considered external to the local BGP
speaker’s AS.
• The BGP peer is restarted after issuing this command.

Examples
-> ipv6 bgp neighbor 2001::1 remote-as 100

Release History
Release 8.1.1; command was introduced.
Related Commands
ip bgp autonomous-system Sets the AS for the local BGP speaker.

MIB Objects
alaBgpPeer6Table
alaBgpPeer6Addr
alaBgpPeer6AS

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-219
ipv6 bgp neighbor timers BGP Commands

ipv6 bgp neighbor timers

Configures the KEEPALIVE message interval and hold time interval (in seconds) with regards to the spec-
ified BGP peer.
ipv6 bgp neighbor ipv6_address [timers num num]

Syntax Definitions

ipv6_address A 128-bit IPv6 address for the BGP peer.

num The KEEPALIVE message interval in seconds.
num The hold time interval in seconds.

Defaults

parameter default
num (keepalive) 30 seconds
num (holdtime) 90 seconds

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• KEEPALIVE messages do not contain route updates or indicate a change in the status of the BGP peer;
they indicate to the receiving BGP peer that the connection is still live and the peer is reachable.
• By default, the KEEPALIVE interval of 30 seconds is one-third the default hold time interval of 90
seconds. The KEEPALIVE interval can never be more than one-third the value of the hold time
interval. When the hold time interval is reached without receiving KEEPALIVE or other updates
messages, the peer is considered dead.
• Setting the KEEPALIVE value to zero means no KEEPALIVE messages will be sent.

• Once a connection is established with a peer and a time period of the length specified in this command
transpires with no messages from the remote peer, then the connection with that remote peer will be
considered dead.
• The hold timer is used during the connection setup process and for on-going connection maintenance
with BGP peers. If the peer does not receive a KEEPALIVE, UPDATE, or NOTIFICATION message
within this time period, then the BGP connection will be closed.
• Both the KEEPALIVE and hold time interval should be set at the same time.

• Using this command without the variables resets the variables to their default value.

Examples
-> ipv6 bgp neighbor 2001::1 timers 80 240

page 26-220 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ipv6 bgp neighbor timers

Release History
Release 8.1.1; command was introduced.

Related Commands

ipv6 bgp neighbor conn-retry- The interval, in seconds, between BGP retries to set up a
interval connection with another peer through the transport protocol.

MIB Objects
alaBgpPeer6Table
alaBgpPeer6Addr
alaBgpPeer6HoldTime
alaBgpPeer6KeepAlive

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-221
ipv6 bgp neighbor maximum-prefix BGP Commands

ipv6 bgp neighbor maximum-prefix

Configures the maximum number of prefixes, or paths, the local router can receive from a BGP peer in
UPDATE messages.
ipv6 bgp neighbor ipv6_address [maximum-prefix num [warning-only]]
no ipv6 bgp neighbor ipv6_address [maximum-prefix num [warning-only]]

Syntax Definitions

ipv6_address A 128-bit IPv6 address for the BGP peer.

num The number of prefixes. The valid range is 0–4294967295.

Defaults

parameter default
num 5000

By default, warning-only is enabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When the number of prefixes sent by the BGP peer reaches the maximum limit, the peer is restarted.

• You can use BGP logging to receive a warning when the number of prefixes received from the peer
reaches 80 percent of the value you configure in this command.
• If the warning-only prefix is used, the operator will be warned when the peer exceeds 80 percent of the
configured number of maximum prefixes.
• The BGP peer is restarted after issuing this command.

Examples
-> ipv6 bgp neighbor 2001::2 maximum-prefix 1000 warning-only
-> no ipv6 bgp neighbor 2001::2 maximum-prefix 1000

Release History
Release 8.1.1; command was introduced.

Related Commands

show ipv6 bgp neighbors Displays the configured IPv6 BGP peers.

page 26-222 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ipv6 bgp neighbor maximum-prefix

MIB Objects
alaBgpPeer6Table
alaBgpPeer6Addr
alaBgpPeer6MaxPrefix
alaBgpPeer6MaxPrefixWarnOnly

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-223
ipv6 bgp neighbor next-hop-self BGP Commands

ipv6 bgp neighbor next-hop-self

Configures router to advertise its peering address as the next hop address for the specified neighbor.
ipv6 bgp neighbor ipv6_address [next-hop-self]
no ipv6 bgp neighbor ipv6_address [next-hop-self]

Syntax Definitions

ipv6_address A 128-bit IPv6 address for the BGP peer.

Defaults
By default, the next-hop-self parameter of BGP updates is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable the next-hop-self parameter.

• In meshed networks, the BGP peer may not have direct connections to other peers. When such a peer
receives route updates from these distant peers (through other peers), it may treat the remote peer as if
it were the next hop in the routing path. Packet forwarding will not work in such a case because no
direct connection exists. This command allows the peer to deem itself the next hop on the routing path
so that the two non-connected peers can route packets. This peer would have a direct connection to
both peers that want to exchange packets.
• The BGP peer is restarted after issuing this command.

Examples
-> ipv6 bgp neighbor 2001::2 next-hop-self
-> no ipv6 bgp neighbor 2001::2 next-hop-self

Release History
Release 8.1.1; command was introduced.

Related Commands

show ipv6 bgp neighbors Displays the configured IPv6 BGP peers.

MIB Objects
alaBgpPeer6Table
alaBgpPeer6Addr
alaBgpPeer6NextHopSelf

page 26-224 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ipv6 bgp neighbor conn-retry-interval

ipv6 bgp neighbor conn-retry-interval

The interval, in seconds, between BGP retries to set up a connection with another peer through the
transport protocol. In the connect state, BGP tries to set up a connection with a remote peer. If the
connection fails, then the connection retry interval starts. Once this interval elapses, BGP retries
setting up the connection.
ipv6 bgp neighbor ipv6_address [conn-retry-interval num]

Syntax Definitions

ipv6_address A 128-bit IPv6 address for the BGP neighbor.

num The time interval (in seconds) between retries. The valid range is 0–
65535.

Defaults

parameter default
num 120

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The connection retry time interval starts when a connection to a peer is lost.

• Using this command without the num variable resets the variable to its default value.

Examples
-> ipv6 bgp neighbor 2001::2 conn-retry-interval 60

Release History
Release 8.1.1; command was introduced.

Related Commands

show ipv6 bgp neighbors Displays the configured IPv6 BGP peers.

MIB Objects
alaBgpPeer6Table
alaBgpPeer6Addr
alaBgpPeer6ConnRetryInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-225
ipv6 bgp neighbor default-originate BGP Commands

ipv6 bgp neighbor default-originate

Enables or disables the BGP local speaker to advertise a default route to the peer.
ipv6 bgp neighbor ipv6_address [default-originate]
no ipv6 bgp neighbor ipv6_address [default-originate]

Syntax Definitions

ipv6_address The 128-bit IPv6 address for the neighbor.

Defaults
This default-originate parameter is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable the BGP peer default origination.

• When this command is enabled, the local BGP speaker advertises the default route to the peer. Such a
default route overrides any learned default (propagation) and outbound policy. The default route ::/0
does not need to exist on the local router.
• If the peer is capable of exchanging IP as well as IPv6 prefixes, the default route for both IP and IPv6
is advertised.

Examples
-> ipv6 bgp neighbor 2001::1 default-originate
-> no ipv6 bgp neighbor 2001::1 default-originate

Release History
Release 8.1.1; command was introduced.

Related Commands

show ipv6 bgp neighbors Displays the configured IPv6 BGP peers.

MIB Objects
alaBgpPeer6Table
alaBgpPeer6Addr
alaBgpPeer6DefaultOriginate

page 26-226 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands ipv6 bgp neighbor update-source

ipv6 bgp neighbor update-source

Configures the local IPv6 interface from which a BGP peer will be connected. This local IPv6 interface
can be configured for internal and external BGP peers.
ipv6 bgp neighbor ipv6_address [update-source interface_name]
no ipv6 bgp neighbor ipv6_address [update-source interface_name]

Syntax Definitions

ipv6_address The 128-bit IPv6 address for the BGP peer.

interface_name The name of the local IPv6 interface that provides the TCP connection
for this BGP peer.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The BGP peer is restarted after issuing this command.

• If a BGP peer is configured with its link-local address, use the update-source parameter to specify the
name of the IPv6 interface from which this peer is reachable. This is required to establish a BGP peer-
ing session.

Examples
-> ipv6 bgp neighbor 2004::1 update-source bgp_ipv6
-> no ipv6 bgp neighbor 2004::1 update-source bgp_ipv6

Release History
Release 8.1.1; command was introduced.

Related Commands

show ipv6 bgp neighbors Displays the configured IPv6 BGP peers.
ipv6 interface Configures an IPv6 interface on a VLAN or IPv6 tunnel.

MIB Objects
alaBgpPeer6Table
alaBgpPeer6Addr
alaBgpPeer6LocalIntfName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-227
ipv6 bgp neighbor ipv4-nexthop BGP Commands

ipv6 bgp neighbor ipv4-nexthop

Configures the IPv4 next hop addresses for IPv4 prefixes advertised between BGP peers. These BGP peers
are identified by their IPv6 addresses.
ipv6 bgp neighbor ipv6_address [ipv4-nexthop ip_address]

Syntax Definitions

ipv6_address The 128-bit IPv6 address for the BGP peer.

ip_address The 32-bit IP address of the next hop.

Defaults
By default, the IPv4 next hop value is set to all zeros.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
To reset the IPv4 next hop value, enter an all-zero address.

Examples
-> ipv6 bgp neighbor 2004::1 ipv4-nexthop 172.22.2.115
-> ipv6 bgp neighbor 2004::1 ipv4-nexthop 0.0.0.0

Release History
Release 8.1.1; command was introduced.

Related Commands

show ipv6 bgp neighbors .Displays the configured IPv6 BGP peers.

MIB Objects
alaBgpPeer6Table
alaBgpPeer6Addr
alaBgpPeer6Ipv4NextHop

page 26-228 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ipv6 bgp neighbors

show ipv6 bgp neighbors

Displays the configured IPv6 BGP peers.
show ipv6 bgp neighbors [ipv6_address]

Syntax Definitions

ipv6_address The 128-bit IPv6 address of the BGP neighbor.

Defaults
By default, all the configured IPv6 BGP peers will be displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the ipv6_address parameter to display the details of a specified IPv6 BGP peer.

Examples
-> show ipv6 bgp neighbors
Legends: Nbr = Neighbor
As = Autonomous System
Nbr address As Admin state Oper state BGP Id Up/Down
--------------------------+-----+-----------+------------+------------+---------
2001:100:3:4::1 30 enabled established 11.4.0.1 01h:42m:08s
fe80::200:57ff:fe28:7e89 10 enabled established 11.5.0.1 01h:40m:58s

-> show ipv6 bgp neighbors 2001:100:3:4::1

Neighbor address = 2001:100:3:4::1,
Neighbor autonomous system = 30,
Neighbor Admin state = enabled,
Neighbor Oper state = established,
Neighbor passive status = disabled,
Neighbor name = peer(2001:100:3:4::1),
Neighbor local address = 2001:100:3:4::10,
Neighbor EBGP multiHop = disabled,
Neighbor next hop self = disabled,
Neighbor Route Refresh = enabled,
Neighbor Ipv4 unicast = enabled,
Neighbor Ipv4 multicast = disabled,
Neighbor type = internal,
Neighbor auto-restart = enabled,
Neighbor route-reflector-client = disabled,
Neighbor confederation status = disabled,
Neighbor remove private AS = disabled,
Neighbor default originate = disabled,
Neighbor maximum prefixes = 5000,
Neighbor max prefixes warning = enabled,
# of prefixes received = 10,

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-229
show ipv6 bgp neighbors BGP Commands

Neighbor MD5 key = <none>,

Neighbor local port = 49154,
Neighbor TCP window size = 32768,
Graceful Restart State = None,
Advertised Restart Interval = 0s,
Forwarding State during restart = NotPreserved,
Activate IPv6 unicast = enabled,
Configured IPv4 NextHop Address = 0.0.0.0,
Configured IPv6 NextHop Address = ::,
Neighbor Ipv6 unicast = advertised

output definitions
Nbr address or Neighbor The IPv6 address for this BGP peer. Assign this address through the
address ipv6 bgp neighbor command.
As or Neighbor autonomous The autonomous system to which this peer belongs. A peer’s AS
system number is assigned through the ipv6 bgp neighbor remote-as
command.
Admin state or Neighbor Indicates whether this peer has been enabled or disabled through the
Admin state ipv6 bgp neighbor admin-state command.
Oper state or Neighbor Oper The current BGP state for this peer. Possible states are idle, connect,
state active, opensent, openconfirm, and established.
BGP Id The unique BGP identifier of the peer.
Up/Down The time since this peer has transitioned to its current UP or DOWN
state. If the peer is currently Established, then this is the time that the
peer has been UP. If the peer is currently Idle, then this is the time the
peer has been DOWN.
Neighbor passive status Indicates whether the local BGP speaker is “passive” (i.e., waiting for
this peer to initiate a session).
Neighbor name The name assigned to this peer.
Neighbor local address The interface assigned to this peer. This value is configured through
the ipv6 bgp neighbor update-source command.
Neighbor EBGP multiHop Indicates whether BGP multi-hop support is enabled or disabled. This
supports allows external BGP peers to communicate with each other
even when they are not directly connected.
Neighbor next hop self Indicates whether this peer is using next hop processing. This value is
configured through the ipv6 bgp neighbor next-hop-self command.
Neighbor Route Refresh Indicates whether this peer supports Route Refresh capability as
defined in RFC 2918. This capability is an alternative to soft-
reconfiguration that can save CPU and memory resources. It allows
peers to dynamically request the re-advertisement of BGP routing
tables. Since this router supports route refresh all BGP peers are
automatically enabled for this capability.
Neighbor Ipv4 unicast Indicates whether this peer is multiprotocol IPv4 unicast capable.
Neighbor Ipv4 multicast Indicates whether this peer is multiprotocol IPv4 multicast capable.
Neighbor type Indicates whether this peer is internal or external to the AS.
Neighbor auto-restart Indicates whether peer auto-restart is enabled or disabled.

page 26-230 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ipv6 bgp neighbors

output definitions (continued)

Neighbor route-reflector-client Indicates whether this peer is a client to the local route reflector, if
configured.
Neighbor confederation status Indicates whether this peer is a member of a BGP confederation.
Neighbor remove private AS Indicates whether the stripping of private AS numbers (64512 to
65535) from AS paths is enabled or disabled.
Neighbor default originate Indicates whether peer default origination is enabled or disabled.
When enabled, the local BGP speaker advertises the default route to
the peer. This value is configured through the ipv6 bgp neighbor
default-originate command.
Neighbor maximum prefixes The maximum number of prefixes the local router can receive in
UPDATE from this peer. This value is configured through the ipv6
bgp neighbor maximum-prefix command.
Neighbor max prefixes Indicates whether a warning will be issued when this peer exceeds 80
warning percent of the maximum prefix value. This value is configured through
the ipv6 bgp neighbor update-source command.
# of prefixes received Displays the total number of prefixes received by this neighbor.
Neighbor MD5 key When present, shows an encrypted version of the MD5 password.
When not present, and MD5 password has not been configured.
Neighbor local port The TCP port used for the session with this peer.
Neighbor TCP window size The size of the TCP window for this BGP session. This value will
always be 32768 as that is the maximum size of a BGP message.
Graceful Restart State Indicates the graceful restart state. This feature does not support IPv6
prefixes.
Advertised Restart Interval Indicates the restart interval in seconds.
Forwarding State during Indicates whether the peer has preserved the forwarding state
restart during the graceful restart.
Activate IPv6 unicast Indicates whether or not IPv6 unicast advertisements are enabled.
Options include enabled or disabled.
Configured IPv4 NextHop Specifies the IPv4 nexthop address. This is specified using the ipv6
Address bgp neighbor ipv4-nexthop command.
Configured IPv6 NextHop Specifies the IPv6 nexthop address. This is specified using the ipv6
Address bgp neighbor ipv6-nexthop command.
Neighbor Ipv6 unicast Indicates whether or not IPv6 unicast capability is advertised
between the peers. Options include enabled or disabled.

Release History
Release 8.1.1; command was introduced.

Related Commands

ipv6 bgp neighbor Creates or deletes a BGP peer relationship using IPv6 addresses
ipv6 bgp neighbor admin-state Enables or disables the BGP peer status.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-231
show ipv6 bgp neighbors BGP Commands

MIB Objects
alaBgpPeer6Table
alaBgpPeer6Addr
alaBgpPeer6AS
alaBgpPeer6Passive
alaBgpPeer6Name
alaBgpPeer6MultiHop
alaBgpPeer6MaxPrefix
alaBgpPeer6MaxPrefixWarnOnly
alaBgpPeer6NextHopSelf
alaBgpPeer6SoftReconfig
alaBgpPeer6InSoftReset
alaBgpPeer6Ipv4Unicast
alaBgpPeer6Ipv4Multicast
alaBgpPeer6RcvdRtRefreshMsgs
alaBgpPeer6SentRtRefreshMsgs
alaBgpPeer6RouteMapOut
alaBgpPeer6RouteMapIn
alaBgpPeer6LocalAddr
alaBgpPeer6LastDownReason
alaBgpPeer6LastDownTime
alaBgpPeer6LastReadTime
alaBgpPeer6RcvdNotifyMsgs
alaBgpPeer6SentNotifyMsgs
alaBgpPeer6LastSentNotifyReason
alaBgpPeer6LastRecvNotifyReason
alaBgpPeer6RcvdPrefixes
alaBgpPeer6DownTransitions
alaBgpPeer6Type
alaBgpPeer6AutoReStart
alaBgpPeer6ClientStatus
alaBgpPeer6ConfedStatus
alaBgpPeer6RemovePrivateAs
alaBgpPeer6ClearCounter
alaBgpPeer6TTL
alaBgpPeer6AspathListOut
alaBgpPeer6AspathListIn
alaBgpPeer6PrefixListOut
alaBgpPeer6PrefixListIn
alaBgpPeer6CommunityListOut
alaBgpPeer6CommunityListIn
alaBgpPeer6Restart
alaBgpPeer6DefaultOriginate
alaBgpPeer6ReconfigureInBound
alaBgpPeer6ReconfigureOutBound
alaBgpPeer6MD5Key
alaBgpPeer6MD5KeyEncrypt
alaBgpPeer6RowStatus
alaBgpPeer6UpTransitions
alaBgpPeer6LastWriteTime
alaBgpPeer6AdminStatus
alaBgpPeer6State
alaBgpPeer6LocalPort
alaBgpPeer6TcpWindowSize
alaBgpPeer6ActivateIpv6

page 26-232 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ipv6 bgp neighbors statistics

show ipv6 bgp neighbors statistics

Displays the neighbor statistics of the configured IPv6 BGP peers.
show ipv6 bgp neighbors statistics [ipv6_address]

Syntax Definitions

ipv6_address The 128-bit IPv6 address.

Defaults
By default, the neighbor statistics for all the IPv6 BGP peers will be displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the ipv6_address parameter to display the neighbor statistics of a specified IPv6 BGP peer.

Examples
-> show ipv6 bgp neighbors statistics
Legends: Nbr = Neighbor
As = Autonomous System
RMSGS = # of received messages
SMSGS = # of sent messages
RUPDS = # of Update messages received
SUPDS = # of Update messages sent
RNOFY = # of Notify messages received
SNOFY = # of Notify messages sent
RPFXS = # of prefixes received
UPTNS = # of UP transitions
DNTNS = # of DOWN transitions

Nbr address As RMSGS SMSGS RUPDS SUPDS RNOFY SNOFY RPFXS UPTNS DNTNS
-----------------------+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----
2001:100:3:4::1 30 225 260 2 3 0 0 10 1 1

output definitions
Nbr address The IPv6 address for this peer. This value is configured using the ipv6
bgp neighbor command.
As The autonomous system to which this peer belongs. This value is
configured using the ipv6 bgp neighbor remote-as command.
RMSGS Total number of messages (UPDATE, NOTIFY, OPEN, KEEPALIVE)
received by this peer.
SMSGS Total number of messages (UPDATE, NOTIFY, OPEN, KEEPALIVE)
sent by this peer.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-233
show ipv6 bgp neighbors statistics BGP Commands

output definitions (continued)

RUPDS The number of route UPDATE messages received by this peer.
UPDATE messages contain route reachability information, BGP
attributes, and route feasibility information.
SUPDS The number of route UPDATE messages sent by this peer. UPDATE
messages contain route reachability information, BGP attributes, and
route feasibility information.
RNOFY The number of NOTIFY messages received by this peer. NOTIFY
messages contain error information, such as unsupported parameters,
invalid attributes, and holdtime expirations.
SNOFY The number of NOTIFY messages sent by this peer. NOTIFY messages
contain error information, such as unsupported parameters, invalid
attributes, and holdtime expirations.
RPFXS Number of unique route prefixes received by this peer.
UPTNS Number of times this peer has come up, operationally.
DNTNS Number of times this peer has gone down, operationally.

-> show ipv6 bgp neighbors statistics 2001:100:3:4::1

Neighbor address = 2001:100:3:4::1,
# of UP transitions = 1,
Time of last UP transition = 01h:50m:36s,
# of DOWN transitions = 1,
Time of last DOWN transition = 00h:00m:00s,
Last DOWN reason = none,
# of msgs rcvd = 226,
# of Update msgs rcvd = 2,
# of prefixes rcvd = 10,
# of Route Refresh msgs rcvd = 0,
# of Notification msgs rcvd = 0,
Last rcvd Notification reason = none [none]
Time last msg was rcvd = 00h:00m:04s,
# of msgs sent = 260,
# of Update msgs sent = 3,
# of Route Refresh msgs sent = 0
# of Notification msgs sent = 0,
Last sent Notification reason = none [none]
Time last msg was sent = 00h:00m:18s,

output definitions
Neighbor address The IPv6 address for this peer. This value is configured using the ipv6
bgp neighbor command.
# of UP transitions Number of times this peer has come up, operationally.
Time of last UP transition The duration that this peer has been up.
# of DOWN transitions Number of times this peer has gone down, operationally.
Time of last DOWN transition The duration since this peer last went down.

page 26-234 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ipv6 bgp neighbors statistics

output definitions (continued)

Last DOWN reason Provides a message as the last reason why a peer went down. The
possible reasons for going down are:

user_request - user initiated

conn_timeout - connection timer expired
hold_timeout - hold timer expired
bad_msg - received a bad message from neighbor
fsm_blink - BGP FSM error
peer_closed - neighbor closed connection
peer_notify - neighbor sent fatal notification
tcp_error - Fatal TCP error
none - None
# of msgs rcvd Total number of messages (UPDATE, NOTIFY, OPEN, KEEPALIVE)
received by this peer.
# of Update msgs rcvd The number of route UPDATE messages received from this peer.
UPDATE messages contain route reachability information, BGP
attributes, and route feasibility information.
# of prefixes rcvd Number of unique route prefixes received by this peer.
# of Route Refresh msgs rcvd Number of route refresh requests this peer has received. Route refresh
requests all routes learned be a peer.
# of Notification msgs rcvd Number of NOTIFY messages received from this peer. NOTIFY
messages contain error information, such as unsupported parameters,
invalid attributes, and holdtime expirations.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-235
show ipv6 bgp neighbors statistics BGP Commands

output definitions (continued)

Last rcvd Notification reason NOTIFY messages include errors codes. These error codes are listed in
this field. They apply to the last NOTIFY message received from this
peer. The notification reasons are listed in two parts separated by a dash
(-). The following are possible notification reasons:
message header error - synchronization loss
message header error - bad length
message header error - bad type
open message error - unsupported version
open message error - bad peer autonomous system
open message error - bad peer bgp id
open message error - unsupported option
open message error - authentication failure
open message error - unacceptable hold time
open message error - unsupported capability
update message error - malformed attribute
update message error - unknown attribute
update message error - missing wellknown attribute
update message error - attribute flags error
update message error - attribute length error
update message error - invalid origin
update message error - as loop
update message error - invalid nexthop
update message error - optional attribute error
update message error - invalid network
update message error - malformed aspath
cease - maximum number of prefixes reached
cease - administrative shutdown
cease - peer de-configured
cease- administrative reset
cease- connection rejected
cease - other configuration change
cease - connection collision resolution
cease - out of resources
hold time out - none
fsm error - none
none - none
Time last msg was rcvd The duration since a message was received from this peer.
# of msgs sent Total number of messages (UPDATE, NOTIFY, OPEN, KEEPALIVE)
sent to this peer.
# of Update msgs sent Number of route UPDATE messages sent to this peer. UPDATE mes-
sages contain route reachability information, BGP attributes, and route
feasibility information.
# of Route Refresh msgs sent Number of route refresh requests this peer has sent. Route refresh
requests request all routes learned be a peer.
# of Notification msgs sent Number of NOTIFY messages sent to this peer. NOTIFY messages
contain error information, such as unsupported parameters, invalid
attributes, and holdtime expirations.

page 26-236 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ipv6 bgp neighbors statistics

output definitions (continued)

Last sent Notification reason NOTIFY messages include errors codes. These error codes are listed in
this field. They apply to the last NOTIFY message sent by this peer.
The notification reasons are listed in two parts separated by a dash (-).
See the list of possible notification reasons under the description for the
Peer last received notification reason field above.
Time last msg was sent The duration since a message was sent to this peer.

Release History
Release 8.1.1; command was introduced.

Related Commands

show ipv6 bgp neighbors Displays the configured IPv6 BGP peers.

MIB Objects
alaBgpPeer6Table
alaBgpPeer6Addr
alaBgpPeer6RcvdMsgs
alaBgpPeer6SentMsgs
alaBgpPeer6RcvdUpdMsgs
alaBgpPeer6SentUpdMsgs
alaBgpPeer6LastTransitionTime
alaBgpPeer6LastUpTime
alaBgpPeer6BgpId
alaBgpPeer6LocalIntfName
alaBgpPeer6RestartTime
alaBgpPeer6RestartState
alaBgpPeer6RestartFwdState
alaBgpPeer6Ipv6Unicast
alaBgpPeer6HoldTime
alaBgpPeer6KeepAlive
alaBgpPeer6ConnRetryInterval
alaBgpPeer6HoldTimeConfigured
alaBgpPeer6KeepAliveConfigured
alaBgpPeer6Ipv4NextHop
alaBgpPeer6Ipv6NextHop

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-237
show ipv6 bgp neighbors policy BGP Commands

show ipv6 bgp neighbors policy

Displays the incoming and outgoing prefix6 list policy identifiers configured for BGP IPv6 peer.
show ipv6 bgp neighbors policy ipv6_address

Syntax Definitions

ipv6_address The 128-bit IPv6 address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays all of the configured policies for the router, or the polices configured for a specific
BGP IPv6 peer.

Examples
OS6860::> show ipv6 bgp neighbors policy
Neighbor address = 2001::1,
Neighbor autonomous system = 1,
Neighbor output policy map name = <none>,
Neighbor input policy map name = <none>,
Neighbor output aspath-list name = <none>,
Neighbor input aspath-list name = <none>,
Neighbor output prefix-list name = <none>,
Neighbor input prefix-list name = <none>,
Neighbor output community-list name = <none>,
Neighbor input community-list name = <none>,
Neighbor soft reconfiguration = enabled
Neighbor output prefix6-list name = <none>,
Neighbor input prefix6-list name = <none>

output definitions
Neighbor autonomous system The AS to which the peer is assigned. This can be assigned by using
the ip bgp neighbor remote-as command.
Neighbor output policy map The outbound route map policy for the peer. This can be assigned by
name using the ip bgp neighbor route-map command.
Neighbor input policy map The inbound route map policy for the peer. This can be assigned by
name using the ip bgp neighbor route-map command.
Neighbor output aspath-list The outbound AS path list policy for the peer. This can be assigned by
name using the ip bgp neighbor out-aspathlist command.

page 26-238 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ipv6 bgp neighbors policy

output definitions (continued)

Neighbor input aspath-list The inbound AS path list policy for the peer. This can be assigned by
name using the ip bgp neighbor in-aspathlist command.
Neighbor output prefix-list The outbound prefix list policy for the peer. This can be assigned by
name using the ip bgp neighbor out-prefixlist command.
Neighbor input prefix-list The inbound prefix list policy for the peer. This can be assigned by
name using the ip bgp neighbor in-prefixlist command.
Neighbor output community- The outbound community list policy for the peer. This can be assigned
list name by using the ip bgp neighbor out-communitylist command.
Neighbor input community-list The inbound community list policy for the peer. This can be assigned
name by using the ip bgp neighbor in-communitylist command.
Neighbor soft reconfiguration Lists whether soft reconfigurations are enabled or disabled for this
peer. This is configured using the ip bgp neighbor soft-
reconfiguration command.
Neighbor output prefix6-list The outbound prefix6-list policy for the peer.
name
Neighbor input prefix6-list The inbound prefix6-list policy for the peer.
name

Release History
Release 8.1.1; command was introduced.

Related Commands

show ipv6 bgp neighbors Displays configured IPv6 BGP peers

MIB Objects
alaBgpPeer6Table
alaBgpPeer6Prefix6ListIn
alaBgpPeer6Prefix6ListOut

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-239
show ipv6 bgp neighbors timers BGP Commands

show ipv6 bgp neighbors timers

Displays the timers for configured IPv6 BGP peers.
show ipv6 bgp neighbors timers [ipv6_address]

Syntax Definitions

ipv6_address The 128-bit IPv6 address.

Defaults
By default, the timer values for all the IPv6 BGP peers will be displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the ipv6_address parameter to display the timer value for a specified IPv6 BGP peer.

Examples
-> show ipv6 bgp neighbors timers
Legends: Nbr = Neighbor
As = Autonomous System
RtAdv = Route Advertisement
Kalive = Keep Alive (actual)
Ka(C) = Configured Keep Alive
Nbr address As Hold Hold(C) RtAdv Retry Kalive Ka(C)
----------------------------------+-----+-----+-------+-----+-----+------+-----
2001:100:3:4::1 30 90 90 30 120 30 30

output definitions
Nbr address The IPv6 address for this BGP peer. Assign this address using the ipv6
bgp neighbor command.
As The autonomous system to which this peer belongs. A peer’s AS
number is assigned using the ipv6 bgp neighbor remote-as command.
Hold The actual negotiated hold time value.
Hold (C) The hold time value. This value is configured using the ipv6 bgp
neighbor timers command.
RtAdv The route advertisement interval, in seconds, for updates between
external BGP peers.
Retry The interval, in seconds, between retries by this peer to set up a
connection through TCP with another peer. This value is configured
using the ipv6 bgp neighbor timers command.

page 26-240 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
BGP Commands show ipv6 bgp neighbors timers

output definitions (continued)

Kalive The actual negotiated value, in seconds, between KEEPALIVE
messages. KEEPALIVE messages do not contain route or status
updates; they serve only to tell other peers that the connection is still
live and this peer is reachable.
Ka (C) The KEEPALIVE interval as configured using the ipv6 bgp neighbor
timers command.

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip bgp statistics Displays BGP global statistics.

MIB Objects
alaBgpPeer6Table
alaBgpPeer6Addr
alaBgpPeer6ConnRetryInterval
alaBgpPeer6MinRouteAdvertisementInterval
alaBgpPeer6HoldTime

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 26-241
show ipv6 bgp neighbors timers BGP Commands

page 26-242 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 27 Server Load Balancing
Commands

Server Load Balancing (SLB) allows clients to send requests to servers logically grouped together in
clusters. Each cluster logically aggregates a set of servers running identical applications with access to the
same content (for example, web servers). Clients access clusters through the use of a Virtual IP (VIP)
address.
MIB information for the SLB commands is as follows:
Filename AlcatellIND1Slb.mib
Module: ALCATEL-IND1-SLB-MIB
A summary of available commands is listed here:

Global SLB Commands ip slb admin-state

ip slb reset statistics
show ip slb
SLB Cluster Commands ip slb cluster
ip slb cluster admin-state
ip slb cluster ping period
ip slb cluster ping timeout
ip slb cluster ping retries
ip slb cluster probe
show ip slb clusters
show ip slb cluster
SLB Server Commands ip slb server ip cluster
ip slb server ip cluster probe
show ip slb cluster server
show ip slb servers
SLB Probe Commands ip slb probe
ip slb probe timeout
ip slb probe period
ip slb probe port
ip slb probe retries
ip slb probe username
ip slb probe password
ip slb probe url
ip slb probe status
ip slb probe send
ip slb probe expect
show ip slb probes

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-1
ip slb admin-state Server Load Balancing Commands

ip slb admin-state
Enables or disables the administrative status for Server Load Balancing (SLB) on a switch.
ip slb admin-state {enable | disable}

Syntax Definitions

enable Enables the administrative status for Server Load Balancing on a switch.
disable Disables the administrative status for Server Load Balancing on the
switch.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Disabling the administrative status for the SLB feature does not delete the SLB configuration from the
switch. The next time the feature is enabled, the existing configuration becomes active.

Examples
-> ip slb admin-state enable
-> ip slb admin-state disable

Release History
Release 8.1.1; command introduced.

Related Commands

show ip slb Displays the status of Server Load Balancing on a switch.

ip slb cluster Configures a Server Load Balancing cluster on a switch.
ip slb server ip cluster Adds, deletes, or modifies parameters of physical servers in logical
Server Load Balancing clusters.

MIB Objects
slbFeatureGroup
slbAdminStatus

page 27-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands ip slb reset statistics

ip slb reset statistics

Resets SLB statistics for all clusters configured on the switch.
ip slb reset statistics

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Note that the qos apply command resets both QoS statistics and SLB cluster statistics. The ip slb reset
statistics command only resets SLB statistics.

Examples
-> ip slb reset statistics

Release History
Release 8.1.1; command introduced.

Related Commands

show ip slb clusters Displays the status and configuration of all Server Load Balancing
clusters on a switch.
show ip slb cluster Displays detailed status and configuration information for a single
Server Load Balancing cluster on a switch.

MIB Objects
slbFeatureGroup
slbResetStatistics

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-3
ip slb cluster Server Load Balancing Commands

ip slb cluster
Configures a Server Load Balancing (SLB) cluster on a switch.
ip slb cluster name {vip ip_address | condition string} [l3 | l2]
no ip slb cluster name

Syntax Definitions

name The name of the Server Load Balancing (SLB) cluster. The name can
consist a maximum of 23 characters. Names with spaces must be
enclosed within quotation marks (for example, “mail server”).
ip_address The Virtual IP (VIP) address for the Server Load Balancing cluster. This
IP address must be in dotted decimal format.
string The name of an existing QoS policy condition that identifies the Server
Load Balancing cluster.
l3 Specifies Layer 3 Server Load Balancing mode. The source and
destination MAC and TTL of each packet is modified before the packet
is bridged or routed to the server.
l2 Specifies Layer 2 Server Load Balancing mode. Packets are not
modified before they are bridged to the server. This parameter is only
available when using the condition parameter.

Defaults

parameter default
l3 | l2 l3

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete a Server Load Balancing cluster.

• Once a cluster is created, the Virtual IP or condition cannot be modified. To modify these values,
delete the cluster and re-create the cluster with the different VIP and conditions.
• The VIP address of the SLB cluster must be an address that is in the same subnet as the servers.

• Specifying the l3 parameter when configuring a VIP cluster is not required. VIP clusters only use the
Layer-3 mode to route traffic to the servers. Layer-2 mode is not supported with this type of cluster.
• The QoS policy condition must exist before it is assigned to an SLB cluster. Use the policy condition
command to create the QoS policy condition. See the “QoS Policy Commands” chapter for more
information.

page 27-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands ip slb cluster

• SLB clusters are not active if the Server Load Balancing feature is disabled for the switch. Use the ip
slb admin-state command to enable this feature.

Note. It is possible to configure clusters and add or remove servers from a cluster even when SLB is
disabled for the switch

Examples
-> ip slb cluster corporate_servers vip 1.2.3.4
-> ip slb cluster "mail servers" vip 1.2.3.6
-> ip slb cluster cluster_1 condition intranet_cond l2
-> ip slb cluster cluster_2 condition slb_cond l3
-> no ip slb cluster hr_servers

Release History
Release 8.1.1; command introduced.

Related Commands

show ip slb clusters Displays the status and configuration of all Server Load Balancing
clusters on a switch.
show ip slb cluster Displays detailed status and configuration information for a single
Server Load Balancing cluster on a switch.
ip slb admin-state Enables or disables Server Load Balancing on a switch.
ip slb server ip cluster Adds, deletes, or modifies parameters of physical servers in logical
Server Load Balancing clusters.

MIB Objects
slbClusterTable
slbClusterName
slbClusterVIP
slbClusterRowStatus
slbClusterPackets
slbClusterCondition
slbClusterType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-5
ip slb cluster admin-state Server Load Balancing Commands

ip slb cluster admin-state

Administratively enables or disables a Server Load Balancing (SLB) cluster on a switch.
ip slb cluster cluster_name admin-state {enable | disable}

Syntax Definitions

cluster_name The name of an existing Server Load Balancing cluster.

enable Administratively enables a Server Load Balancing cluster on a switch.
disable Administratively disables a Server Load Balancing cluster on a switch.

Defaults
By default, a cluster is administratively enabled when the cluster is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The SLB cluster name specified with this command must already exist in the switch configuration.

Examples
-> ip slb cluster hr_servers admin-state enable
-> ip slb cluster "mail servers" admin-state disable

Release History
Release 8.1.1; command introduced.

Related Commands

show ip slb clusters Displays the status and configuration of all Server Load Balancing
clusters on a switch.
show ip slb cluster Displays detailed status and configuration information for a single
Server Load Balancing cluster on a switch.
ip slb cluster Configures Server Load Balancing clusters.
ip slb server ip cluster Adds, deletes, or modifies parameters of physical servers in logical
Server Load Balancing clusters.

MIB Objects
slbClusterTable
slbClusterAdminStatus

page 27-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands ip slb cluster ping period

ip slb cluster ping period

Modifies the number of seconds to check the health of the servers in a Server Load Balancing cluster.
ip slb cluster cluster_name ping period seconds

Syntax Definitions

cluster_name The name of the Server Load Balancing (SLB) cluster.

seconds The number of seconds for the ping period. Specifying 0 (zero) disables
the ping.

Defaults

parameter default
seconds 60

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If you do not set the ping period to zero, then the ping period must be greater than or equal to the ping
timeout value divided by 1000. Use the ip slb cluster ping timeout command to modify the ping timeout
value.

Examples
-> ip slb cluster hr_servers ping period 120
-> ip slb cluster "mail servers" ping period 0

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-7
ip slb cluster ping period Server Load Balancing Commands

Related Commands

show ip slb clusters Displays the status and configuration of all Server Load Balancing
clusters on a switch.
show ip slb cluster Displays detailed status and configuration information for a single
Server Load Balancing cluster on a switch.
ip slb cluster ping timeout Modifies the ping timeout value.
ip slb cluster ping retries Modifies the number of ping retries.

MIB Objects
slbClusterTable
slbClusterPingPeriod

page 27-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands ip slb cluster ping timeout

ip slb cluster ping timeout

Configures the ping timeout value for a Server Load Balancing (SLB) cluster before it retries.
ip slb cluster cluster_name ping timeout milliseconds

Syntax Definitions

cluster_name The name of the Server Load Balancing (SLB) cluster.

milliseconds The number of milliseconds for the ping timeout. The valid range for the
ping timeout value is 0 to 1000 times the ping period. For example, if
the ping period is 10 seconds, then maximum value for the ping timeout
is 10000.

Defaults

parameter default
milliseconds 3000

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the ip slb cluster ping period command to modify the ping period value.

Examples
-> ip slb cluster "mail servers" ping timeout 1000
-> ip slb cluster hr_servers ping timeout 6000

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-9
ip slb cluster ping timeout Server Load Balancing Commands

Related Commands

show ip slb clusters Displays the status and configuration of all Server Load Balancing
clusters on a switch.
show ip slb cluster Displays detailed status and configuration information for a single
Server Load Balancing cluster on a switch.
ip slb cluster ping period Modifies the ping period value.
ip slb cluster ping retries Modifies the number of ping retries.

MIB Objects
slbClusterTable
slbClusterPingTimeout

page 27-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands ip slb cluster ping retries

ip slb cluster ping retries

Configures the number of ping attempts for a Server Load Balancing (SLB) cluster.
ip slb cluster cluster_name ping retries count

Syntax Definitions

cluster_name The name of the Server Load Balancing (SLB) cluster.

count The number of ping retries.

Defaults

parameter default
count 3

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip slb cluster "mail servers" ping retries 5
-> ip slb cluster hr_servers ping retries 10

Release History
Release 8.1.1; command introduced.

Related Commands

show ip slb clusters Displays the status and configuration of all Server Load Balancing
clusters on a switch.
show ip slb cluster Displays detailed status and configuration information for a single
Server Load Balancing cluster on a switch.
ip slb cluster ping period Modifies the ping period value.
ip slb cluster ping timeout Modifies the ping timeout value.

MIB Objects
slbClusterTable
slbClusterPingRetries

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-11
ip slb cluster probe Server Load Balancing Commands

ip slb cluster probe

Configures a probe for a Server Load Balancing (SLB) cluster.
ip slb cluster cluster_name probe probe_name

Syntax Definitions

cluster_name The name of the Server Load Balancing (SLB) cluster.

probe_name The name of the Server Load Balancing (SLB) probe.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
You must create the probe with the ip slb probe before you can use this command.

Examples
-> ip slb cluster mail_servers probe mail_server_probe

Release History
Release 8.1.1; command introduced.

Related Commands

show ip slb clusters Displays the status and configuration of all Server Load Balancing
clusters on a switch.
ip slb probe Configures and deletes SLB probes.
show ip slb cluster Displays detailed status and configuration information for a single
Server Load Balancing cluster on a switch.
ip slb server ip cluster Adds, deletes, or modifies parameters of physical servers in logical
Server Load Balancing clusters.

MIB Objects
slbClusterTable
slbClusterProbeName

page 27-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands ip slb server ip cluster

ip slb server ip cluster

Adds a physical server to a Server Load Balancing (SLB) cluster, deletes a physical server from an SLB
cluster, or modifies the administrative status of a physical server in an SLB cluster.
ip slb server ip ip_address cluster cluster_name [admin-state {enable | disable}] [weight weight]
no ip slb server ip ip_address cluster cluster_name

Syntax Definitions

ip_address The IP address for the physical server.

cluster_name The name of an existing Server Load Balancing cluster.
enable Enables a server.
disable Disables a server.
weight Specifies the weight of the server.

Defaults

parameter default
enable | disable enable
weight 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a physical server from a Server Load Balancing cluster.

• Use the weight parameter to assign the server preference value. Each server or server cluster can be
assigned a weight to set their preference value for distribution of incoming network traffic. The
weights assigned are relative. For example, if Servers A and B have respective weights of 10 and 20
within a cluster, Server A would get half the traffic of Server B.
• Assigning a weight of 0 (zero) to a server prevents the server from being assigned any new
connections. This server is a backup server.
• A higher weight value indicates that the server can accept more network traffic.

Examples
-> ip slb server ip 10.255.11.127 cluster corporate_servers
-> ip slb server ip 10.255.11.109 cluster "mail servers" admin-state enable
weight 5
-> no ip slb server ip 10.255.11.105 cluster hr_servers

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-13
ip slb server ip cluster Server Load Balancing Commands

Release History
Release 8.1.1; command introduced.

Related Commands

show ip slb clusters Displays the status and configuration of all Server Load Balancing
clusters on a switch.
show ip slb cluster Displays detailed status and configuration information for a single
Server Load Balancing cluster on a switch.
ip slb admin-state Enables or disables Server Load Balancing on a switch.
ip slb cluster Configures Server Load Balancing clusters.

MIB Objects
slbServerTable
slbServerRowStatus
slbServerAdminStatus
slbServerAdminWeight

page 27-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands ip slb server ip cluster probe

ip slb server ip cluster probe

Configures a probe for a Server Load Balancing (SLB) server.
ip slb server ip ip_address cluster cluster_name probe probe_name

Syntax Definitions

ip_address The IP address for the physical server.

cluster_name The name of the Server Load Balancing (SLB) cluster.
probe_name The name of the Server Load Balancing (SLB) probe.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
You must create the probe with the ip slb probe before you can use this command.

Examples
-> ip slb server ip 10.255.11.127 cluster corporate_servers probe p_http

Release History
Release 8.1.1; command introduced.

Related Commands

show ip slb clusters Displays the status and configuration of all Server Load Balancing
clusters on a switch.
show ip slb cluster Displays detailed status and configuration information for a single
Server Load Balancing cluster on a switch.
ip slb probe Configures and deletes SLB probes.
ip slb admin-state Enables or disables Server Load Balancing on a switch.
ip slb cluster Configures Server Load Balancing clusters.

MIB Objects
slbServerTable
slbServerProbeName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-15
ip slb probe Server Load Balancing Commands

ip slb probe
Configures a Server Load Balancing (SLB) probe used to check the health of servers or clusters.
ip slb probe probe_name {ftp | http | https | imap | imaps | nntp | ping | pop | pops | smtp | tcp | udp}
no ip slb probe probe_name

Syntax Definitions

probe_name Specifies the name of the Server Load Balancing (SLB) probe.
ftp Specifies an FTP probe.
http Specifies an HTTP probe.
https Specifies an HTTPS probe.
imap Specifies an IMAP probe.
imaps Specifies an IMAPS probe.
nntp Specifies an NNTP probe.
ping Specifies a ping probe.
pop Specifies a POP probe.
pops Specifies a POPS probe.
smtp Specifies an SMTP probe.
tcp Specifies a TCP probe.
udp Specifies a UDP probe.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to delete an SLB probe.

Examples
-> ip slb probe mail_server_probe smtp
-> no ip slb probe mail_server_probe

Release History
Release 8.1.1; command introduced.

page 27-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands ip slb probe

Related Commands

show ip slb probes Displays the configuration of SLB probes.

MIB Objects
slbProbeTable
slbProbeName
slbProbeMethod

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-17
ip slb probe timeout Server Load Balancing Commands

ip slb probe timeout

Configures the amount of time to wait for Server Load Balancing (SLB) probe answers.
ip slb probe probe_name {ftp | http | https | imap | imaps | nntp | ping | pop | pops | smtp | tcp | udp}
timeout seconds

Syntax Definitions

probe_name Specifies the name of the Server Load Balancing (SLB) probe.
ftp Specifies an FTP probe.
http Specifies an HTTP probe.
https Specifies an HTTPS probe.
imap Specifies an IMAP probe.
imaps Specifies an IMAPS probe.
nntp Specifies an NNTP probe.
ping Specifies a ping probe.
pop Specifies a POP probe.
pops Specifies a POPS probe.
smtp Specifies an SMTP probe.
tcp Specifies a TCP probe.
udp Specifies a UDP probe.
seconds Specifies the timeout in seconds.

Defaults

parameter default
seconds 3000

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip slb probe mail_server smtp timeout 12000

Release History
Release 8.1.1; command introduced.

page 27-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands ip slb probe timeout

Related Commands

ip slb probe Configures and deletes SLB probes.

show ip slb probes Displays the configuration of SLB probes.

MIB Objects
slbProbeTable
slbProbeName
slbProbeMethod
slbProbeTimeout

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-19
ip slb probe period Server Load Balancing Commands

ip slb probe period

Configures the length of time between each SLB probe to check the health of the servers.
ip slb probe probe_name {ftp | http | https | imap | imaps | nntp | ping | pop | pops | smtp | tcp | udp}
period seconds

Syntax Definitions

probe_name Specifies the name of the Server Load Balancing (SLB) probe.
ftp Specifies an FTP probe.
http Specifies an HTTP probe.
https Specifies an HTTPS probe.
imap Specifies an IMAP probe.
imaps Specifies an IMAPS probe.
nntp Specifies an NNTP probe.
ping Specifies a ping probe.
pop Specifies a POP probe.
pops Specifies a POPS probe.
smtp Specifies an SMTP probe.
tcp Specifies a TCP probe.
udp Specifies a UDP probe.
seconds Specifies the length of time for the SLB probe period.

Defaults

parameter default
seconds 60

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip slb probe web_server http period 120

Release History
Release 8.1.1; command introduced.

page 27-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands ip slb probe period

Related Commands

ip slb probe Configures and deletes SLB probes.

show ip slb probes Displays the configuration of SLB probes.

MIB Objects
slbProbeTable
slbProbeName
slbProbeMethod
slbProbePeriod

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-21
ip slb probe port Server Load Balancing Commands

ip slb probe port

Configures the TCP/UDP port on which the Server Load Balancing (SLB) probe is sent.
ip slb probe probe_name {ftp | http | https | imap | imaps | nntp | ping | pop | pops | smtp | tcp | udp}
port port_number

Syntax Definitions

probe_name Specifies the name of the Server Load Balancing (SLB) probe.
ftp Specifies an FTP probe.
http Specifies an HTTP probe.
https Specifies an HTTPS probe.
imap Specifies an IMAP probe.
imaps Specifies an IMAPS probe.
nntp Specifies an NNTP probe.
ping Specifies a ping probe.
pop Specifies a POP probe.
pops Specifies a POPS probe.
smtp Specifies an SMTP probe.
tcp Specifies a TCP probe.
udp Specifies a UDP probe.
port_number Specifies the TDP/UDP port number.

Defaults

parameter default
port_number 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip slb probe mis_server udp port 200

Release History
Release 8.1.1; command introduced.

page 27-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands ip slb probe port

Related Commands

ip slb probe Configures and deletes SLB probes.

show ip slb probes Displays the configuration of SLB probes.

MIB Objects
slbProbeTable
slbProbeName
slbProbeMethod
slbProbePort

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-23
ip slb probe retries Server Load Balancing Commands

ip slb probe retries

Configures the number of Server Load Balancing (SLB) probe retries that are performed before deciding
that a server is out of service.
ip slb probe probe_name {ftp | http | https | imap | imaps | nntp | ping | pop | pops | smtp | tcp | udp}
retries retries

Syntax Definitions

probe_name Specifies the name of the Server Load Balancing (SLB) probe.
ftp Specifies an FTP probe.
http Specifies an HTTP probe.
https Specifies an HTTPS probe.
imap Specifies an IMAP probe.
imaps Specifies an IMAPS probe.
nntp Specifies an NNTP probe.
ping Specifies a ping probe.
pop Specifies a POP probe.
pops Specifies a POPS probe.
smtp Specifies an SMTP probe.
tcp Specifies a TCP probe.
udp Specifies a UDP probe.
retries Specifies the number of retries.

Defaults

parameter default
retries 3

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip slb probe mail_server smtp retries 5

Release History
Release 8.1.1; command introduced.

page 27-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands ip slb probe retries

Related Commands

ip slb probe Configures and deletes SLB probes.

show ip slb probes Displays the configuration of SLB probes.

MIB Objects
slbProbeTable
slbProbeName
slbProbeMethod
slbProbeRetries

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-25
ip slb probe username Server Load Balancing Commands

ip slb probe username

Configures a user name that is sent to a server as credentials for an HTTP GET operation to verify the
health of the server.
ip slb probe probe_name {http | https} username user_name

Syntax Definitions

probe_name Specifies the name of the Server Load Balancing (SLB) probe.
http Specifies an HTTP probe.
https Specifies an HTTPS probe.
user_name Specifies user name.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip slb probe web_server http username subnet1

Release History
Release 8.1.1; command introduced.

Related Commands

ip slb probe Configures and deletes SLB probes.

show ip slb probes Displays the configuration of SLB probes.

MIB Objects
slbProbeTable
slbProbeName
slbProbeMethod
slbProbeHttpUsername

page 27-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands ip slb probe password

ip slb probe password

Configures a password that is sent to a server as credentials for an HTTP GET to verify the health of the
server.
ip slb probe probe_name {http | https} password password

Syntax Definitions

probe_name Specifies the name of the Server Load Balancing (SLB) probe.
http Specifies an HTTP probe.
https Specifies an HTTPS probe.
password Specifies the password.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The password is encrypted in the configuration file so that it is not readable.

Examples
-> ip slb probe web_server http password h1f45xc

Release History
Release 8.1.1; command introduced.

Related Commands

ip slb probe Configures and deletes SLB probes.

show ip slb probes Displays the configuration of SLB probes.

MIB Objects
slbProbeTable
slbProbeName
slbProbeMethod
slbProbeHttpPassword

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-27
ip slb probe url Server Load Balancing Commands

ip slb probe url

Configures a URL that is sent to a server for an HTTP GET to verify the health of the server.
ip slb probe probe_name {http | https} url url

Syntax Definitions

probe_name Specifies the name of the Server Load Balancing (SLB) probe.
http Specifies an HTTP probe.
https Specifies an HTTPS probe.
url Specifies the URL of the server.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip slb probe web_server http url pub/index.html

Release History
Release 8.1.1; command introduced.

Related Commands

ip slb probe Configures and deletes SLB probes.

show ip slb probes Displays the configuration of SLB probes.

MIB Objects
slbProbeTable
slbProbeName
slbProbeMethod
slbProbeHttpUrl

page 27-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands ip slb probe status

ip slb probe status

Configures the expected status returned from an HTTP GET to verify the health of a server.
ip slb probe probe_name {http | https} status status_value

Syntax Definitions

probe_name Specifies the name of the Server Load Balancing probe.

http Specifies an HTTP probe.
https Specifies an HTTPS probe.
status_value Specifies the expected status returned.

Defaults

parameter default
status_value 200

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip slb probe web_server http status 404

Release History
Release 8.1.1; command introduced.

Related Commands

ip slb probe Configures and deletes SLB probes.

show ip slb probes Displays the configuration of SLB probes.

MIB Objects
slbProbeTable
slbProbeName
slbProbeMethod
slbProbePeriod
slbProbeHttpStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-29
ip slb probe send Server Load Balancing Commands

ip slb probe send

Configures an ASCII string that is sent to a server to invoke a server response and verify the health of the
server.
ip slb probe probe_name {tcp | udp} send send_string

Syntax Definitions

probe_name Specifies the name of the Server Load Balancing (SLB) probe.
tcp Specifies a TCP probe.
udp Specifies a UDP probe.
send_string Specifies the ASCII string sent to a server to invoke a response.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
NA

Examples
-> ip slb probe web_server tcp send test

Release History
Release 8.1.1; command introduced.

Related Commands

ip slb probe Configures and deletes SLB probes.

show ip slb probes Displays the configuration of SLB probes.

MIB Objects
slbProbeTable
slbProbeName
slbProbeMethod
slbProbeSend

page 27-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands ip slb probe expect

ip slb probe expect

Configures an ASCII string used to compare a response from a server to verify the health of the server.
ip slb probe probe_name {http | https | tcp | udp} expect expect_string

Syntax Definitions

probe_name Specifies the name of the Server Load Balancing (SLB) probe.
http Specifies an HTTP probe.
https Specifies an HTTPS probe.
tcp Specifies a TCP probe.
udp Specifies a UDP probe.
expect_string Specifies the ASCII string used to compare a response from a server.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip slb probe web_server http expect test

Release History
Release 8.1.1; command introduced.

Related Commands

ip slb probe Configures and deletes SLB probes.

show ip slb probes Displays the configuration of SLB probes.

MIB Objects
slbProbeTable
slbProbeName
slbProbeMethod
slbProbeExpect

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-31
show ip slb Server Load Balancing Commands

show ip slb
Displays the status of Server Load Balancing on a switch.
show ip slb

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip slb

Admin status : Enabled,

Operational status : In Service,
Number of clusters = 3

Output fields are described here:

output definitions
Admin status The current administrative status of Server Load Balancing (SLB) on
this switch (Enabled or Disabled).
Operational status The current operational status of Server Load Balancing (SLB) on this
switch, which is either In service (at least one SLB cluster is in service)
or Out of service (all SLB clusters are out of service).
Number of clusters The total number of Server Load Balancing (SLB) clusters on this
switch.

Release History
Release 8.1.1; command introduced.

page 27-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands show ip slb

Related Commands

show ip slb servers Displays the status of all physical servers belonging to Server Load
Balancing clusters on a switch.
show ip slb clusters Displays the status and configuration of all Server Load Balancing
clusters on a switch.
show ip slb cluster Displays detailed status and configuration information for a single
Server Load Balancing cluster on a switch.
show ip slb cluster server Displays detailed status and configuration information for a single
physical server in a Server Load Balancing cluster.

MIB Objects
slbFeature
slbAdminStatus
slbOperStatus
slbClustersCount

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-33
show ip slb clusters Server Load Balancing Commands

show ip slb clusters

Displays the status and basic configuration for all Server Load Balancing (SLB) clusters on a switch. This
command also displays traffic statistics for QoS policy condition clusters.
show ip slb clusters [statistics]

Syntax Definitions

statistics Displays SLB statistics for QoS policy condition clusters.

Defaults
By default, the status and basic configuration for all clusters is displayed; statistics are not shown.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the statistics parameter to display the total number of packets that were passed to clusters because
they met the QoS condition criteria configured for that cluster. The polling interval used to obtain such
statistics is every 15 minutes. See the second example below.

Examples
-> show ip slb clusters
Admin Operational # %
Cluster Name VIP/COND Status Status Srv Avail
----------------+----------------+--------+-------------------+-----+---------
WorldWideWeb 128.241.130.204 Enabled In Service 3 95
Intranet 128.241.130.205 Enabled In Service 2 100
FileTransfer 128.241.130.206 Enabled Out of Service 2 50

Output fields are described here:

output definitions
Cluster Name The name of the SLB cluster.
VIP/COND The virtual IP (VIP) address or the policy condition name for the SLB
cluster.
Admin Status The administrative status of the SLB cluster (Enabled or Disabled).
Operational Status The operational status of the SLB cluster; In Service (at least one
physical server is operational in the cluster) or Out of Service.
# Srv The total number of physical servers that belong to the SLB cluster.
% Avail The percentage of time that the physical server has been available for
processing client requests. In other words, the actual ratio of up time
(In Service plus Retrying) versus down time (No Answer plus Link
Down). Please note that the Disabled and the initial Discovery states
are not counted as down time.

page 27-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands show ip slb clusters

-> show ip slb clusters statistics

Admin Operational
Cluster Name Status Status Count
-----------------------+--------+--------------------+--------
Cluster1 Enabled In Service 4 Servers
Cluster2 Enabled In Service 4 Servers

Dst IP 101.113.113.1/255.255.255.255 4503911

Src IP 202.202.1.0/255.255.255.0 6527831
Src Port 2/49

output definitions
Cluster Name The name of the SLB cluster. This field also contains the administrative
and operational status for the cluster and either the VIP address or QoS
policy condition value that identifies the cluster.
Admin Status The administrative state of this physical server (Enabled or Disabled).
Operational Status The operational state of this server. The possible states are described as
follows:
• Disabled (this server is administratively disabled).
• No Answer (this server has not responded to ping requests).
• Link Down (there is a bad connection to this server).
• In Service (this server is used for SLB cluster client connections).
• Discovery (the SLB cluster is pinging this physical server).
• Retrying (the SLB cluster is making another attempt to bring up
this server).
Count The total number of physical servers that belong to the cluster, and the
total number of packets serviced by the cluster.
Dst The destination Virtual IP address assigned to the cluster.
Src Source IP address assigned to the cluster.
Src Port Source slot and port number of the SLB cluster.

Release History
Release 8.1.1; command introduced.

Related Commands

ip slb reset statistics Resets SLB statistics for all clusters.

show ip slb cluster Displays detailed status and configuration information for a single SLB
cluster.
show ip slb servers Displays the status of all physical servers belonging to each SLB cluster
on a switch.
show ip slb cluster server Displays detailed status and configuration information for a single
physical server in an SLB cluster.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-35
show ip slb clusters Server Load Balancing Commands

MIB Objects
slbClusterTable
slbClusterName
slbClusterVIP
slbClusterCondition
slbClusterAdminStatus
slbClusterOperStatus
slbClusterNumberOfServers
slbClusterNewFlows
slbStatsTable
slbStatsClusterName
slbStatsIndex
slbStatsCounter
slbStatsQualTable
slbStatsQualType
slbStatsQualData

page 27-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands show ip slb cluster

show ip slb cluster

Displays detailed statistics and configuration information and operational status for a single Server Load
Balancing (SLB) cluster. This command also displays traffic statistics for single QoS policy condition
cluster.
show ip slb cluster name [statistics]

Syntax Definitions

name Specifies the name of the SLB cluster.

statistics Displays SLB statistics for the specified cluster.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the statistics parameter to display the total number of packets that were passed to the cluster because
they met the QoS condition criteria configured for that cluster. The polling interval used to obtain such
statistics is every 15 minutes. See the second example below:

Examples
-> show ip slb cluster Intranet

Cluster Intranet
VIP : 128.241.130.204,
Type : L3
Admin status : Enabled,
Operational status : In Service,
Ping period (seconds) = 60,
Ping timeout (milliseconds) = 3000,
Ping retries = 3,
Probe = None,
Number of packets = 25346,
Number of servers = 3
Server 128.241.130.107
Admin status = Enabled, Operational status = In Service,
Weight = 4, Availability (%) = 0
Server 128.241.130.117
Admin status = Enabled, Operational status = Discovery,
Weight = 6, Availability (%) = 0
Server 128.241.130.127
Admin status = Enabled, Operational status = Discovery,
Weight = 1, Availability (%) = 0

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-37
show ip slb cluster Server Load Balancing Commands

output definitions
Cluster The name of this Server Load Balancing (SLB) cluster.
VIP The virtual IP (VIP) address for this Server Load Balancing (SLB)
cluster.
Type The classifier for the hypothetical packet, which can be L2 or L3.
Admin status The current administrative status of this Server Load Balancing (SLB)
cluster (Enabled or Disabled).
Operational status The current operational status of this Server Load Balancing (SLB)
cluster, which is In Service (at least one physical server is operational
in the cluster) or Out of Service.
Ping period (seconds) The ping period (in seconds) used by this Server Load Balancing (SLB)
cluster to check the health of physical servers.
Ping timeout (milliseconds) The timeout (in milliseconds) used by this Server Load Balancing
(SLB) cluster to wait for ping answers from physical servers.
Ping retries The number of ping retries that this Server Load Balancing (SLB)
cluster executes before switching the status to No answer.
Probe The probe configured for this cluster.
Number of packets The number of packets balanced for this Server Load Balancing (SLB)
cluster.
Number of servers The total number of physical servers that belong to this Server Load
Balancing (SLB) cluster.
Server The IP address for this physical server.
Admin Status The administrative state of this physical server (Enabled or Disabled).
Operational Status The operational state of this server. The possible states are described as
follows:
• Disabled (this server is administratively disabled).
• No Answer (this server has not responded to ping requests).
• Link Down (there is a bad connection to this server).
• In Service (this server is used for SLB cluster client connections).
• Discovery (the SLB cluster is pinging this physical server).
• Retrying (the SLB cluster is making another attempt to bring up
this server).
Availability (%) The percentage of time that this physical server has been available for
processing client requests. In other words, the actual ratio of up time
(In Service plus Retrying) versus down time (No Answer plus Link
Down). Please note that the Disabled and the initial Discovery states
are not counted as down time.

page 27-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands show ip slb cluster

-> show ip slb cluster Intranet statistics

Admin Operational
Cluster Name Status Status Count
-----------------------+--------+--------------------+--------
Intranet Enabled In Service 3 Servers
Src IP 15.2.3.2/255.255.255.255 195
Src Port 1/4

output definitions
Cluster Name The name of the SLB cluster. This field also contains the administrative
and operational status for the cluster and either the VIP address or QoS
policy condition value that identifies the cluster.
Admin status The current administrative status of this physical server (Enabled or
Disabled).
Oper status The operational state of this server. The possible states are described as
follows:
• Disabled (this server is administratively disabled).
• No Answer (this server has not responded to ping requests).
• Link Down (there is a bad connection to this server).
• In Service (this server is used for SLB cluster client connections).
• Discovery (the SLB cluster is pinging this physical server).
• Retrying (the SLB cluster is making another attempt to bring up
this server).
Count The total number of physical servers that belong to the cluster, and the
total number of packets serviced by the cluster.

Release History
Release 8.1.1; command introduced.

Related Commands

ip slb reset statistics Resets SLB statistics for all clusters.

show ip slb clusters Displays detailed status and configuration information for all Server
Load Balancing clusters on a switch.
show ip slb servers Displays the status of all physical servers belonging to Server Load
Balancing clusters on a switch.
show ip slb cluster server Displays detailed status and configuration information for a single
physical server in a Server Load Balancing cluster.
ip slb cluster probe Configures a probe for an SLB cluster.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-39
show ip slb cluster Server Load Balancing Commands

MIB Objects
slbClusterTable
slbClusterName
slbClusterVIP
slbClusterAdminStatus
slbClusterOperStatus
slbClusterUpTime
slbClusterPingPeriod
slbClusterPingTimeout
slbClusterPingRetries
slbClusterRedirectAlgorithm
slbClusterIdleTimer
slbClusterNumberOfServers
slbClusterProbeName
slbClusterRowStatus
slbClusterPackets
slbClusterCondition
slbClusterType
slbServerTable
slbServerClusterName
slbServerIpAddress
slbServerAdminStatus
slbServerOperStatus
slbStatsTable
slbStatsClusterName
slbStatsIndex
slbStatsCounter
slbStatsQualTable
slbStatsQualType
slbStatsQualData

page 27-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands show ip slb cluster server

show ip slb cluster server

Displays detailed statistics and configuration information for a single physical server in a Server Load
Balancing (SLB) cluster.
show ip slb cluster name server ip_address

Syntax Definitions

name Specifies the name of the Server Load Balancing (SLB) cluster.
ip_address Specifies the IP address for the physical server.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Specifying a value for the name and ip_address parameters is required.

Examples
-> show ip slb cluster Intranet server 128.220.40.4
Cluster cl1
VIP 128.220.40.205
Server 128.220.40.4
Admin status : Enabled,
Oper status : In Service,
Probe = phttp,
Availability time (%) = 95,
Ping failures = 0,
Last ping round trip time (milliseconds) = 20,
Probe status = ,

Output fields are described here:

output definitions
Cluster The name of the Server Load Balancing (SLB) cluster.
VIP The virtual IP (VIP) address for this Server Load Balancing (SLB)
cluster.
Server The IP address for this physical server.
Admin status The current administrative status of this physical server (Enabled or
Disabled).

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-41
show ip slb cluster server Server Load Balancing Commands

output definitions (continued)

Oper status The operational state of this server. The possible states are described as
follows:
• Disabled (this server is administratively disabled).
• No Answer (this server has not responded to ping requests).
• Link Down (there is a bad connection to this server).
• In Service (this server is used for SLB cluster client connections).
• Discovery (the SLB cluster is pinging this physical server).
• Retrying (the SLB cluster is making another attempt to bring up
this server).
Probe The name of the probe configured for this server.
Availability time (%) The percentage of time that this physical server has been available for
processing client requests. In other words, the actual ratio of up time
(In Service plus Retrying) versus down time (No Answer plus Link
Down). Please note that the Disabled and the initial Discovery states
are not counted as down time.
Ping failures The total number of pings that have failed on this physical server.
Last ping round trip time The total amount of time (in milliseconds) measured for the last valid
(milliseconds) ping to this physical server to make a round trip.
Probe status The status of the probe configured for this server.

Release History
Release 8.1.1; command introduced.

Related Commands

show ip slb servers Displays the status of all physical servers belonging to Server Load
Balancing clusters on a switch.
show ip slb clusters Displays detailed status and configuration information for all Server
Load Balancing clusters on a switch.
show ip slb cluster Displays detailed status and configuration information for a single
Server Load Balancing cluster.

page 27-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands show ip slb cluster server

MIB Objects
slbClusterTable
slbClusterVIP
slbServerTable
slbServerClusterName
slbServerIpAddress
slbServerAdminStatus
slbServerOperStatus
slbServerMacAddress
slbServerSlotNumber
slbServerPortNumber
slbServerUpTime
slbServerProbeName
slbServerLastRTT
slbServerPingFails
slbServerProbeStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-43
show ip slb servers Server Load Balancing Commands

show ip slb servers

Displays the status and configurations of all physical servers in Server Load Balancing clusters.
show ip slb servers

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip slb servers
Admin Operational %
IP addr Cluster Name Status Status Avail
--------------------+----------------+----------+---------------+-----------
128.220.40.4 Intranet Enabled In Service 98
128.220.40.5 Intranet Enabled Retrying 80
128.220.40.6 FileTransfer Enabled No answer 50
128.220.40.7 FileTransfer Disabled Disabled ---
128.220.40.1 WorldWideWeb Enabled In Service 100
128.220.40.2 WorldWideWeb Enabled Discovery 50
128.220.40.3 WorldWideWeb Enabled Link Down 75

Output fields are described here:

output definitions
IP addr The IP address for this physical server.
Cluster Name The name of the Server Load Balancing (SLB) cluster to which this
physical server belongs.
Admin Status The current administrative status of this physical server (Enabled or
Disabled).

page 27-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands show ip slb servers

output definitions (continued)

Operational Status The operational state of this server. The possible states are described as
follows:
• Disabled (this server is administratively disabled).
• No Answer (this server has not responded to ping requests).
• Link Down (there is a bad connection to this server).
• In Service (this server is used for SLB cluster client connections).
• Discovery (the SLB cluster is pinging this physical server).
• Retrying (the SLB cluster is making another attempt to bring up
this server).
% Avail The percentage of time that this physical server has been available for
processing client requests. In other words, the actual ratio of up time
(In Service plus Retrying) versus down time (No Answer plus Link
Down). Please note that the Disabled and the initial Discovery states
are not counted as down time.

Release History
Release 8.1.1; command introduced.

Related Commands

show ip slb cluster server Displays the detailed status and configuration of a single physical server
in a Server Load Balancing cluster.
show ip slb clusters Displays detailed status and configuration information for all Server
Load Balancing clusters on a switch.
show ip slb cluster Displays detailed status and configuration information for a single
Server Load Balancing cluster.

MIB Objects
slbServers
slbServerIpAddress
slbServerClusterName
slbServerAdminStatus
slbServerOperStatus
slbServerFlows

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-45
show ip slb probes Server Load Balancing Commands

show ip slb probes

Displays the configuration of Server Load Balancing (SLB) probes.
show ip slb probes [probe_name]

Syntax Definitions

probe_name Specifies the name of the Server Load Balancing (SLB) probe.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If you do not specify the name of an SLB probe then all SLB probes are displayed.

Examples
No probe name is specified:
-> show ip slb probes

Probe Name Period Retries Timeout Method

-----------------------+-------+-------+--------+------
web_server 60000 3 12000 HTTP
mail_server 60000 3 3000 SMTP
mis_servers 3600000 5 24000 Ping

Output fields are described here:

output definitions
Probe Name The user-specified name of the probe.
Period The period (in seconds) to check the health of servers.
Retries The number of probe retries before deciding that a server is out of
service.
Timeout The timeout (in seconds) used to wait for probe answers.
Method The type of probe.

page 27-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Server Load Balancing Commands show ip slb probes

The name of a probe that is not an HTTP/HTTPS probe is specified:

-> show ip slb probes mail_server

Probe mail_server
Type = SMTP,
Period (seconds) = 60,
Timeout (milliseconds) = 3000,
Retries = 3,
Port = 0,

The name of an HTTP/HTTPS probe is specified:

-> show ip slb probes phttp

Probe phttp
Type = HTTP,
Period (seconds) = 60,
Timeout (milliseconds) = 3000,
Retries = 3,
Port = 0,
Username = ,
Password = ,
Expect = ,
Status = 200,
URL = /,

Output fields are described here:

output definitions
Probe The user-specified name of the probe.
Type The type of probe.
Period The period (in seconds) to check the health of servers.
Timeout The timeout (in seconds) used to wait for probe answers.
Retries The number of probe retries before deciding that a server is out of
service.
Port The TCP/UDP port on which the probe is sent.
Username The configured user name sent to a server as credentials for an HTTP
GET operation for the probe.
Password The configured password for the probe.
Expect The configured ASCII string used to compare a response from a server
to verify the health of the server.
Status The expected status returned from an HTTP GET to verify the health of
a server.
URL The configured URL sent to a server for an HTTP GET to verify the
health of the server.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 27-47
show ip slb probes Server Load Balancing Commands

Related Commands

ip slb probe Configures and deletes SLB probes.

ip slb probe period Configures the probe period to check the health of servers.
ip slb probe timeout Configures the timeout used to wait for probe answers.
ip slb probe retries Configures the number of probe retries before deciding that a server is
out of service.
ip slb probe port Configures the TCP/UDP port that the probe should be sent on.
ip slb probe username Configures a user name sent to a server as credentials for an HTTP GET
operation
ip slb probe password Configures a password sent to a server as credentials for an HTTP GET
to verify the health of the server
ip slb probe expect Configures an ASCII string used to compare a response from a server to
verify the health of the server.
ip slb probe status Configures the expected status returned from an HTTP GET to verify
the health of a server.
ip slb probe url Configures a URL sent to a server for an HTTP GET to verify the health
of the server.

MIB Objects
slbProbeTable
slbProbeName
slbProbeMethod
slbProbePeriod
slbProbeTimeout
slbProbeRetries
slbProbePort
slbProbeHttpUsername
slbProbeHttpPassword
slbProbeExpect
slbProbeHttpStatus
slbProbeHttpUrl

page 27-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 28 IP Multicast Switching
Commands

IP Multicast Switching (IPMS) is a one-to-many communication technique employed by emerging appli-

cations such as video distribution, news feeds, conferencing, netcasting, and resource discovery (OSPF,
RIP2, and BOOTP). Unlike unicast, which sends one packet per destination, multicast sends one packet to
all devices in any subnetwork that has at least one device requesting the multicast traffic.
Alcatel-Lucent’s IPMS software is compatible with the following RFCs:
RFC 1112 — Host Extensions for IP Multicasting
RFC 2236 — Internet Group Management Protocol, Version 2
RFC 2933 — Internet Group Management Protocol MIB
RFC 3376 — Internet Group Management Protocol, Version 3
Alcatel-Lucent’s IPv6MS software is compatible with the following RFCs:
RFC 2710 — Multicast Listener Discovery for IPv6
RFC 3019 — IPv6 MIB for Multicast Listener Discovery Protocol
RFC 3810 — Multicast Listener Discovery Version 2 for IPv6
MIB information for the IPMS commands is as follows:
Filename: AlcatelIND1Igmp.mib
Module: ALCATEL-IGMP-IND1-MIB
MIB information for the IPv6MS commands is as follows:
Filename: AlcatelIND1Mld.mib
Module: ALCATEL-MLD-IND1-MIB

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-1
 IP Multicast Switching Commands

The following table summarizes the available IP and IPv6 multicast commands:

ip multicast admin-state
ip multicast querier-forwarding
ip multicast flood-unknown
ip multicast version
ip multicast max-group
ip multicast vlan max-group
ip multicast port max-group
ip multicast static-querier
ip multicast static-group
ip multicast query-interval
ip multicast last-member-query-interval
ip multicast query-response-interval
ip multicast unsolicited-report-interval
ip multicast router-timeout
ip multicast source-timeout
ip multicast querying
ip multicast robustness
ip multicast spoofing
ip multicast zapping
ip multicast proxying
ip multicast helper-address
ip multicast initial-packet-buffer admin-state
ip multicast initial-packet-buffer max-packet
ip multicast initial-packet-buffer max-flow
ip multicast initial-packet-buffer timeout
ip multicast initial-packet-buffer min-delay
ipv6 multicast admin-state
ipv6 multicast querier-forwarding
ipv6 multicast flood-unknown
ipv6 multicast max-group
ipv6 multicast vlan max-group
ipv6 multicast port max-group
ipv6 multicast static-querier
ipv6 multicast static-group
ipv6 multicast query-interval
ipv6 multicast last-member-query-interval
ipv6 multicast query-response-interval
ipv6 multicast unsolicited-report-interval
ipv6 multicast router-timeout
ipv6 multicast source-timeout
ipv6 multicast querying
ipv6 multicast robustness
ipv6 multicast spoofing
ipv6 multicast zapping
ipv6 multicast proxying
ipv6 multicast initial-packet-buffer admin-state
ipv6 multicast initial-packet-buffer max-packet
ipv6 multicast initial-packet-buffer max-flow
ipv6 multicast initial-packet-buffer timeout
ipv6 multicast initial-packet-buffer min-delay
show ip multicast port
show ip multicast neighbor
show ip multicast querier
show ip multicast group
show ip multicast source
show ip multicast tunnel
show ip multicast initial-packet-buffer

page 28-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands

show ipv6 multicast

show ipv6 multicast port
show ipv6 multicast neighbor
show ipv6 multicast querier
show ipv6 multicast group
show ipv6 multicast source
show ipv6 multicast tunnel
show ipv6 multicast initial-packet-buffer

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-3
ip multicast admin-state IP Multicast Switching Commands

ip multicast admin-state
Enables or disables IP Multicast Switching and Routing on the specified VLAN, or on the system if no
VLAN is specified.
ip multicast [vlan vid] admin-state [{enable | disable}]

Syntax Definitions

vid VLAN on which to apply the configuration.

enable Enable IP Multicast Switching and Routing.
disable Disable IP Multicast Switching and Routing.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If an IP Multicast Routing protocol is already running on the system, the ip multicast admin-state
command will override the existing configuration and always enable IP Multicast Switching and Rout-
ing.
• If the IP Multicast Switching and Routing is already enabled on the system, then the VLAN configura-
tion will override the system's configuration.
• You can also restore the IP Multicast Switching and Routing to its default (i.e., disabled) status on the
system if no VLAN is specified, by using only ip multicast admin-state.
• You can also restore the IP Multicast Switching and Routing to its default (i.e., disabled) status on the
specified VLAN, by using only ip multicast vlan vid admin-state.

Examples
-> ip multicast admin-state enable
-> ip multicast admin-state disable
-> ip multicast vlan 2 admin-state enable
-> ip multicast vlan 2 admin-state disable
-> ip multicast vlan 2 admin-state

Release History
Release 8.1.1; command introduced.

page 28-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast admin-state

Related Commands

ipv6 multicast initial-packet- Displays the IP Multicast Switching and Routing status and the general
buffer min-delay configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmp
alaIgmpStatus
alaIgmpVlan
alaIgmpVlanStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-5
ip multicast querier-forwarding IP Multicast Switching Commands

ip multicast querier-forwarding
Enables or disables IGMP querier forwarding on the specified VLAN or on the system if no VLAN is
specified.
ip multicast [vlan vid] querier-forwarding [{enable | disable}]
no ip multicast [vlan vid] querier-forwarding

Syntax Definitions

vid The VLAN on which configuration is applied.

enable Enable IGMP querier forwarding.
disable Disable IGMP querier forwarding.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an IGMP querier forwarding entry on the specified VLAN
or on the system and return to its default behavior.
• If the IGMP querier forwarding is already enabled on the system, then the VLAN configuration will
override the system's configuration.
• IGMP querier forwarding refers to promoting detected IGMP queriers to receive all IP multicast data
traffic.

Examples
-> ip multicast querier-forwarding enable
-> ip multicast querier-forwarding disable
-> ip multicast querier-forwarding
-> ip multicast vlan 2 querier-forwarding enable
-> ip multicast vlan 2 querier-forwarding disable
-> ip multicast vlan 2 querier-forwarding
-> no ip multicast vlan 2 querier-forwarding

Release History
Release 8.1.1; command introduced.

page 28-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast querier-forwarding

Related Commands

ipv6 multicast initial-packet- Displays the IP Multicast Switching and Routing status and the general
buffer min-delay configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmp
alaIgmpQuerierForwarding
alaIgmpVlan
alaIgmpVlanQuerierForwarding

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-7
ip multicast flood-unknown IP Multicast Switching Commands

ip multicast flood-unknown
Enables or disables the flooding of new multicast packets until the multicast group membership table is
updated.
ip multicast flood-unknown {enable | disable}

Syntax Definitions

enable Enable the flooding of multicast packets until membership table is updated.
disable Disable the flooding of multicast packets.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When flood-unknown and IP multicast switching are enabled, multicast packets are flooded on the
VLAN until the multicast group membership table is updated. They are then forwarded based on the
multicast group membership table.
• When flood-unknown is enabled and IP multicast switching is disabled, all multicast traffic will be
flooded on the VLAN.
• When flood-unknown is disabled and IP multicast switching is enabled, multicast packets are not
flooded on the VLAN, but, will be forwarded once the multicast group membership table is updated.
• If IP multicast switching and flood-unknown are disabled, all multicast packets are flooded on the
VLAN.

Examples
-> ip multicast flood-unknown enable
-> ip multicast flood-unknown disable

Release History
Release 8.1.1; command was introduced.

page 28-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast flood-unknown

Related Commands

ip multicast admin-state Enables or disables IP Multicast Switching and Routing on the specified
VLAN, or on the system if no VLAN is specified.
show ip multicast Displays the IP Multicast Switching and Routing status and the general
configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmp
alaIgmpStatus
alaIgmpVlan
alaIgmpVlanStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-9
ip multicast version IP Multicast Switching Commands

ip multicast version
Sets the default version of the IGMP protocol on the specified VLAN or on the system if no VLAN is
specified.
ip multicast [vlan vid] version [version]

Syntax Definitions

vid VLAN on which to apply the configuration.

version Default IGMP protocol version to run. Valid range is 1 to 3.

Defaults

parameter default
version 2

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• IP Multicast Switching and Routing must be enabled to set the default IGMP protocol version on the
system and/or the specified VLANs.
• If the default IGMP protocol version is already configured on the system, then the VLAN configura-
tion will override the system's configuration.
• Due to protocol inter-operation requirements, this command specifies only a default version of the
IGMP protocol to run.
• To restore the IGMP multicast version to the default (i.e., 2) version on the system if no VLAN is spec-
ified, use ip multicast version followed by the value 0 (e.g., ip multicast version 0) or use only ip
multicast version (e.g., ip multicast version).
• To restore the IGMP multicast version to the default (i.e., 2) version on the specified VLAN, use ip
multicast vlan vid version, followed by the value 0 (e.g., ip multicast vlan 2 version 0) or use only ip
multicast vlan vid version (e.g., ip multicast vlan 2 version).

Examples
-> ip multicast version 3
-> ip multicast version 0
-> ip multicast version
-> ip multicast vlan 2 version 3
-> ip multicast vlan 2 version 0
-> ip multicast vlan 2 version

Release History
Release 8.1.1; command introduced.

page 28-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast version

Related Commands

ipv6 multicast initial-packet- Displays the IP Multicast Switching and Routing status and the general
buffer min-delay configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmp
alaIgmpVersion
alaIgmpVlan
alaIgmpVlanVersion

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-11
ip multicast max-group IP Multicast Switching Commands

ip multicast max-group
Configures the global maximum group limit that can be learned per port/VLAN instance.The limit is
applied to each port/VLAN instance and an action is taken when it exceeds the limit.
ip multicast max-group [num] [action {none | drop | replace}]

Syntax Definitions

num Specifies the maximum IGMP group count. Valid range is 0 to

4294967295.
none Disables the maximum group limit configuration
drop Drops the incoming membership request.
replace Replaces an existing membership with the incoming membership
request.

Defaults
By default, the max-group limit is set to zero.

parameter defaults
action none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Configuring a max-group value will have no affect on existing group memberships until the member-
ships are refreshed on the port/VLAN instance.
• The configuration is allowed even when the ip multicast status is disabled.

• If the num and action parameters are not specified, then the limit is removed.

• The max-group configuration on a specific VLAN or port will override the global configuration.

• IGMP zapping must be enabled when the max-group limit is enabled and the action is dropped.

Examples
-> ip multicast max-group 10 action drop
-> ip multicast max-group 20 action replace
-> ip multicast max-group

Release History
Release 8.1.1; command introduced.

page 28-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast max-group

Related Commands

ipv6 multicast initial-packet- Displays the IP Multicast Switching and Routing status and the general
buffer min-delay configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmpMaxGroupLimit
alaIgmpMaxGroupExceedAction

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-13
ip multicast vlan max-group IP Multicast Switching Commands

ip multicast vlan max-group

Configures the maximum group limit learned per port on a VLAN. The limit is applied to each port that is
a member of the given VLAN.
ip multicast vlan vid max-group [num] [action {none | drop | replace}]

Syntax Definitions

vid VLAN on which to apply the configuration.

num The maximum IGMP group count. Valid range is 0 to 4294967295.
none Disables the maximum group limit configuration.
drop Drops the incoming membership request.
replace Replaces an existing membership with the incoming membership
request.

Defaults
By default, the max-group limit is set to zero.

parameter defaults
action none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Configuring a max-group value will have no affect on existing group memberships until the member-
ships are refreshed on the port/VLAN instance
• The configuration is allowed even when the ip multicast status is disabled.

• If the num and action parameters are not specified, then the limit is removed.

• The max group configuration on a VLAN will override the global configuration.

• IGMP zapping must be enabled when the max-group limit is enabled and the action is dropped.

Examples
-> ip multicast vlan 10 max-group 10 action drop
-> ip multicast vlan 10 max-group

Release History
Release 8.1.1; command introduced.

page 28-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast vlan max-group

Related Commands

ipv6 multicast initial-packet- Displays the IP Multicast Switching and Routing status and the general
buffer min-delay configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmpVlanTable
alaIgmpVlanMaxGroupLimit
alaIgmpVlanMaxGroupExceedAction

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-15
ip multicast port max-group IP Multicast Switching Commands

ip multicast port max-group

Configures the maximum group limit learned per port. The limit is applicable on the given port for all
VLAN instances of the port.
ip multicast port chassis/slot/port max-group [num] [action {none | drop | replace}]

Syntax Definitions

chassis/slot/port The port number.

num The maximum IGMP group count. Valid range is 0 to 4294967295.
none Disables the maximum group limit configuration.
drop Drops the incoming membership request.
replace Replaces an existing membership with the incoming membership
request.

Defaults
By default, the max-group limit is set to zero.

parameter defaults
action none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Configuring a max-group value will have no affect on existing group memberships until the member-
ships are refreshed on the port/VLAN instance
• The configuration is allowed even when the ip multicast status is disabled.

• If the num and action parameters are not specified, then the limit is removed.

• The max-group configuration on a port will override the VLAN or global configuration.

• IGMP zapping must be enabled when the max-group limit is enabled and the action is dropped.

Examples
-> ip multicast port 1/1/1 max-group 10 action drop
-> ip multicast port 6/1/14 max-group 20 action replace

Release History
Release 8.1.1; command introduced.

page 28-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast port max-group

Related Commands

ipv6 multicast initial-packet- Displays the IP Multicast Switching and Routing status and the general
buffer min-delay configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmpPortTable
alaIgmpPortMaxGroupLimit
alaIgmpPortMaxGroupExceedAction

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-17
ip multicast static-neighbor IP Multicast Switching Commands

ip multicast static-neighbor
Creates a static IGMP neighbor entry on a specified port on a specified VLAN.
ip multicast static-neighbor vlan vid {port chassis/slot/port | linkagg linkagg}
no ip multicast static-neighbor vlan vid {port chassis/slot/port | linkagg linkagg}

Syntax Definitions

chassis The chassis identifier.vid VLAN to include as a static IGMP neighbor.

slot/port The slot/port number you want to configure as a static IGMP neighbor.
linkagg The link aggregate identifier you want to configure as a static IGMP
neighbor.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an IGMP static neighbor entry on a specified port on a
specified VLAN.
• The ip multicast static-neighbor command allows you to create an IGMP static neighbor entry on a
specified port on a specified VLAN. This, in turn, enables that network segment to receive all the
IGMP traffic.
• You can also create an IGMP static neighbor entry on a link aggregate port by entering ip multicast
static-neighbor vlan vid linkagg, followed by the link aggregation group number (e.g., ip multicast
static-neighbor vlan 2 linkagg 7).

Examples
-> ip multicast static-neighbor vlan 4 port 1/1/1
-> no ip multicast static-neighbor vlan 4 port 1/1/1
-> ip multicast static-neighbor vlan 4 linkagg 7
-> no ip multicast static-neighbor vlan 4 linkagg 7

Release History
Release 8.1.1; command introduced.

page 28-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast static-neighbor

Related Commands

show ip multicast neighbor Displays the IGMP neighbor table entries of IP Multicast Switching and
Routing.

MIB Objects
alaIgmpStaticNeighborTable
alaIgmpStaticNeighborVlan
alaIgmpStaticNeighborIfIndex
alaIgmpStaticNeighborRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-19
ip multicast static-querier IP Multicast Switching Commands

ip multicast static-querier
Creates a static IGMP querier entry on a specified port on a specified VLAN.
ip multicast static-querier vlan vid {port chassis/slot/port | linkagg linkagg}
no ip multicast static-querier vlan vid {port chassis/slot/port | linkagg linkagg}

Syntax Definitions

vid VLAN to include as a static IGMP querier.

chassis The chassis identifier.
slot/port The slot/port number you want to configure as a static IGMP querier.
linkagg The link aggregate id number to configure as a static IGMP querier.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an IGMP static querier entry on a specified port on a spec-
ified VLAN.
• The ip multicast static-querier command allows you to create an IGMP static querier entry on a spec-
ified port on a specified VLAN. This, in-turn, enables that network segment to receive all the IGMP
traffic.
• You can also create an IGMP static querier entry on a link aggregate port by entering ip multicast
static-querier vlan vid linkagg, followed by the link aggregation group number (e.g., ip multicast
static-querier vlan 2 linkagg 7).

Examples
-> ip multicast static-querier vlan 4 port 1/1/1
-> no ip multicast static-querier vlan 4 port 1/1/1
-> ip multicast static-querier vlan 4 linkagg 7
-> no ip multicast static-querier vlan 4 linkagg 7

Release History
Release 8.1.1; command introduced.

page 28-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast static-querier

Related Commands

show ip multicast querier Displays the IGMP querier table entries of IP Multicast Switching and
Routing.

MIB Objects
alaIgmpStaticQuerierTable
alaIgmpStaticQuerierVlan
alaIgmpStaticQuerierIfIndex
alaIgmpStaticQuerierRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-21
ip multicast static-group IP Multicast Switching Commands

ip multicast static-group
Creates a static IGMP group entry on a specified port on a specified VLAN.
ip multicast static-group ip_address vlan vid {port chassis/slot/port | linkagg linkagg}
no ip multicast static-group ip_address vlan vid {port chassis/slot/port | linkagg linkagg}

Syntax Definitions

ip_address The IP address of the multicast group.

vid VLAN to include as a static IGMP group.
chassis The chassis identifier.
slot/port The slot/port number you want to configure as a static IGMP group.
linkagg The link aggregate identifier you want to configure as a static IGMP
group.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an IGMP static group entry on a specified port on a speci-
fied VLAN.
• The ip multicast static-group command allows you to create an IGMP static group entry on a speci-
fied port on a specified VLAN. This, in-turn, enables that network segment to receive IGMP traffic
addressed to the specified IP multicast group address.
• You can also create an IGMP static group entry on a link aggregate port by entering ip multicast
static-group ip_address vlan vid linkagg, followed by the link aggregation group number (e.g., ip
multicast static-group 225.0.0.1 vlan 2 linkagg 7).

Examples
-> ip multicast static-group 229.10.10.10 vlan 4 port 1/1/1
-> no ip multicast static-group 229.10.10.10 vlan 4 port 1/1/1
-> ip multicast static-group 225.11.11.11 vlan 4 linkagg 7
-> no ip multicast static-group 225.11.11.11 vlan 4 linkagg 7

Release History
Release 8.1.1; command introduced.

page 28-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast static-group

Related Commands

show ip multicast group Displays the IGMP group membership table entries of IP Multicast
Switching and Routing for the specified IP multicast group address or
all entries if no IP multicast group address is specified.

MIB Objects
alaIgmpStaticMemberTable
alaIgmpStaticMemberVlan
alaIgmpStaticMemberIfIndex
alaIgmpStaticMemberGroupAddress
alaIgmpStaticMemberRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-23
ip multicast query-interval IP Multicast Switching Commands

ip multicast query-interval
Sets the IGMP query interval on the specified VLAN or on the system if no VLAN is specified.
ip multicast [vlan vid] query-interval [seconds]

Syntax Definitions

vid VLAN on which to apply the configuration.

seconds IGMP query interval in seconds. Valid range is 1 to 65535.

Defaults

parameter default
seconds 125

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• IP Multicast Switching and Routing must be enabled to set the IGMP query interval on the system and/
or the specified VLANs.
• If the IGMP query interval is already configured on the system, then the VLAN configuration will
override the system's configuration.
• The IGMP query interval refers to the time period between IGMP query messages.

• To restore the IGMP query interval to its default (i.e., 125 seconds) value on the system if no VLAN is
specified, use ip multicast query-interval followed by the value 0 (e.g., ip multicast query-interval 0)
or use only ip multicast query-interval (e.g., ip multicast query-interval).
• To restore the IGMP query interval to its default (i.e., 125 seconds) value on the specified VLAN, use
ip multicast vlan vid query-interval, followed by the value 0 (e.g., ip multicast vlan 2 query-interval
0) or use only ip multicast vlan vid query-interval (e.g., ip multicast vlan 2 query-interval).

Examples
-> ip multicast query-interval 100
-> ip multicast query-interval 0
-> ip multicast query-interval
-> ip multicast vlan 2 query-interval 100
-> ip multicast vlan 2 query-interval 0
-> ip multicast vlan 2 query-interval

Release History
Release 8.1.1; command introduced.

page 28-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast query-interval

Related Commands

ipv6 multicast initial-packet- Displays the IP Multicast Switching and Routing status and the general
buffer min-delay configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmp
alaIgmpQueryInterval
alaIgmpVlan
alaIgmpVlanQueryInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-25
ip multicast last-member-query-interval IP Multicast Switching Commands

ip multicast last-member-query-interval
Sets the IGMP last member query interval value on the specified VLAN or on the system if no VLAN is
specified.
ip multicast [vlan vid] last-member-query-interval [tenths-of-seconds]

Syntax Definitions

vid VLAN on which to apply the configuration.

tenths-of-seconds IGMP last member query interval in tenths of seconds. Valid range is 1
to 65535.

Defaults

parameter default
tenths-of-seconds 10

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• IP Multicast Switching and Routing must be enabled to set the IGMP last member query interval on the
system and/or the specified VLANs.
• If the IGMP last member query interval is already configured on the system, then the VLAN configura-
tion will override the system's configuration.
• The IGMP last member query interval refers to the time period to reply to an IGMP query message sent
in response to a leave group message.
• To restore the IGMP last member query interval to its default (i.e., 10 tenths-of-seconds) value on the
system if no VLAN is specified, use ip multicast last-member-query-interval followed by the value
0 (e.g., ip multicast last-member-query-interval 0) or use only ip multicast last-member-query-inter-
val (e.g., ip multicast last-member-query-interval).
• To restore the IGMP last member query interval to its default value (10 tenths-of-seconds) on the spec-
ified VLAN, use ip multicast vlan vid last-member-query interval followed by the value 0 (e.g., ip
multicast vlan 2 last-member-query-interval 0) or use only ip multicast vlan vid last-member-query-
interval (e.g., ip multicast vlan 2 last-member-query-interval).

Examples
-> ip multicast last-member-query-interval 22
-> ip multicast last-member-query-interval 0
-> ip multicast last-member-query-interval
-> ip multicast vlan 2 last-member-query-interval 22
-> ip multicast vlan 2 last-member-query-interval 0
-> ip multicast vlan 2 last-member-query-interval

page 28-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast last-member-query-interval

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 multicast initial-packet- Displays the IP Multicast Switching and Routing status and the general
buffer min-delay configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmp
alaIgmpLastMemberQueryInterval
alaIgmpVlan
alaIgmpVlanLastMemberQueryInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-27
ip multicast query-response-interval IP Multicast Switching Commands

ip multicast query-response-interval
Sets the IGMP query response interval on the specified VLAN or on the system if no VLAN is specified.
ip multicast [vlan vid] query-response-interval [tenths-of-seconds]

Syntax Definitions

vid VLAN on which to apply the configuration.

tenths-of-seconds IGMP query response interval in tenths of seconds. Valid range is 1 to
65535.

Defaults

parameter default
tenths-of-seconds 100

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• IP Multicast Switching and Routing must be enabled to set the IGMP query response interval on the
system and/or the specified VLANs.
• If the IGMP query response interval is already configured on the system, then the VLAN configuration
will override the system's configuration.
• The query response interval refers to the time period to reply to an IGMP query message.

• To restore the IGMP query response interval to its default (i.e., 100 tenths-of-seconds) value on the
system if no VLAN is specified, use ip multicast query-response-interval followed by the value 0
(e.g., ip multicast query-response-interval 0) or use only ip multicast query-response-interval (e.g.,
ip multicast query-response-interval).
• To restore the IGMP last member query interval to its default (i.e., 100 tenths-of-seconds) value on the
specified VLAN, use ip multicast vlan vid query-response-interval followed by the value 0 (e.g., ip
multicast vlan 2 query-response-interval 0) or use only ip multicast vlan vid query-response-interval
(e.g., ip multicast vlan 2 query-response-interval).

Examples
-> ip multicast query-response-interval 200
-> ip multicast query-response-interval 0
-> ip multicast query-response-interval
-> ip multicast vlan 2 query-response-interval 300
-> ip multicast vlan 2 query-response-interval 0
-> ip multicast vlan 2 query-response-interval

page 28-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast query-response-interval

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 multicast initial-packet- Displays the IP Multicast Switching and Routing status and the general
buffer min-delay configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmp
alaIgmpQueryResponseInterval
alaIgmpVlan
alaIgmpVlanQueryResponseInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-29
ip multicast unsolicited-report-interval IP Multicast Switching Commands

ip multicast unsolicited-report-interval
Sets the value of the IGMP unsolicited report interval on the specified VLAN or on the system if no
VLAN is specified.
ip multicast [vlan vid] unsolicited-report-interval [seconds]

Syntax Definitions

vid VLAN on which to apply the configuration.

seconds IGMP query response interval in seconds. Valid range is 1 to 65535,
where 0 represents the default setting.

Defaults

parameter default
seconds 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• IP Multicast Switching and Routing must be enabled to set the IGMP unsolicited report interval on the
system and/or the specified VLANs.
• If the IGMP query response interval is already configured on the system, then the VLAN configuration
will override the system's configuration.
• The unsolicited report interval refers to the time period to proxy any changed IGMP membership state.

• To restore the IGMP unsolicited report interval to its default (i.e., 1 second) value on the system if no
VLAN is specified, use ip multicast unsolicited-report-interval followed by the value 0 (e.g., ip
multicast unsolicited-report-interval 0) or use only ip multicast unsolicited-report-interval (e.g., ip
multicast unsolicited-report-interval).
• To restore the IGMP unsolicited report interval to its default (i.e., 1 second) value on the specified
VLAN, use ip multicast vlan vid unsolicited-report-interval followed by the value 0 (e.g., ip multi-
cast vlan 2 unsolicited-report-interval 0) or use only ip multicast vlan vid unsolicited-report-interval
(e.g., ip multicast vlan 2 unsolicited-report-interval).

Examples
-> ip multicast unsolicited-report-interval 200
-> ip multicast unsolicited-report-interval 0
-> ip multicast unsolicited-report-interval
-> ip multicast vlan 2 unsolicited-report-interval 300
-> ip multicast vlan 2 unsolicited-report-interval 0
-> ip multicast vlan 2 unsolicited-report-interval

page 28-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast unsolicited-report-interval

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 multicast initial-packet- Displays the IP Multicast Switching and Routing status and the general
buffer min-delay configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmp
alaIgmpUnsolicitedReportInterval
alaIgmpVlan
alaIgmpVlanUnsolicitedReportInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-31
ip multicast router-timeout IP Multicast Switching Commands

ip multicast router-timeout
Configures the expiry time of IP multicast routers on the specified VLAN or on the system if no VLAN is
specified.
ip multicast [vlan vid] router-timeout [seconds]

Syntax Definitions

vid VLAN on which to apply the configuration.

seconds IGMP router timeout in seconds. Valid range is 1 to 65535.

Defaults

parameter default
seconds 90

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• IP Multicast Switching and Routing must be enabled to set the IGMP router timeout on the system and/
or the specified VLANs.
• If the IGMP router timeout is already configured on the system, then the VLAN configuration will
override the system's configuration.
• To restore the IGMP router timeout to its default (i.e., 90 seconds) value on the system if no VLAN is
specified, use ip multicast router-timeout followed by the value 0 (e.g., ip multicast router-timeout 0)
or use only ip multicast router-timeout (e.g., ip multicast router-timeout).
• To restore the IGMP router timeout to its default (i.e., 90 seconds) value on the specified VLAN, use ip
multicast vlan vid router-timeout followed by the value 0 (e.g., ip multicast vlan 2 router-timeout 0)
or use only ip multicast vlan vid router-timeout (e.g., ip multicast vlan 2 router-timeout).

Examples
-> ip multicast router-timeout 100
-> ip multicast router-timeout 0
-> ip multicast router-timeout
-> ip multicast vlan 2 router-timeout 100
-> ip multicast vlan 2 router-timeout 0
-> ip multicast vlan 2 router-timeout

Release History
Release 8.1.1; command introduced.

page 28-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast router-timeout

Related Commands

ipv6 multicast initial-packet- Displays the IP Multicast Switching and Routing status and the general
buffer min-delay configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmp
alaIgmpRouterTimeout
alaIgmpVlan
alaIgmpVlanRouterTimeout

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-33
ip multicast source-timeout IP Multicast Switching Commands

ip multicast source-timeout
Configures the expiry time of IP multicast sources on the specified VLAN or on the system if no VLAN is
specified.
ip multicast [vlan vid] source-timeout [seconds]

Syntax Definitions

vid VLAN on which to apply the configuration.

seconds IGMP source timeout in seconds. Valid range is 1 to 65535.

Defaults

parameter default
seconds 30

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• IP Multicast Switching and Routing must be enabled to set the IGMP source timeout on the system
and/or the specified VLANs.
• If the IGMP source timeout is already configured on the system, then the VLAN configuration will
override the system's configuration.
• To restore the IGMP source timeout to its default (i.e., 30 seconds) value on the system if no VLAN is
specified, use ip multicast source-timeout followed by the value 0 (e.g., ip multicast source-timeout
0) or use only ip multicast source-timeout (e.g., ip multicast source-timeout).
• To restore the IGMP source timeout to its default (i.e., 30 seconds) value on the specified VLAN, use
ip multicast vlan vid source-timeout followed by the value 0 (e.g., ip multicast vlan 2 source-timeout
0) or use only ip multicast vlan vid source-timeout (e.g., ip multicast vlan 2 source-timeout).

Examples
-> ip multicast source-timeout 100
-> ip multicast source-timeout 0
-> ip multicast source-timeout
-> ip multicast vlan 2 source-timeout 100
-> ip multicast vlan 2 source-timeout 0
-> ip multicast vlan 2 source-timeout

Release History
Release 8.1.1; command introduced.

page 28-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast source-timeout

Related Commands

ipv6 multicast initial-packet- Displays the IP Multicast Switching and Routing status and the general
buffer min-delay configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmp
alaIgmpSourceTimeout
alaIgmpVlan
alaIgmpVlanSourceTimeout

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-35
ip multicast querying IP Multicast Switching Commands

ip multicast querying
Enables or disables IGMP querying on the specified VLAN or on the system if no VLAN is specified.
ip multicast [vlan vid] querying [{enable | disable}]
no ip multicast [vlan vid] querying

Syntax Definitions

vid VLAN on which configuration is applied.

enable Enable IGMP querying.
disable Disable IGMP querying.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an IGMP querying entry on the specified VLAN or on the
system and return to its default behavior.
• IP Multicast Switching and Routing must be enabled to enable IGMP querying on the system and/or
specified VLANs.
• If the IGMP querying is already enabled/disabled on the system, then the VLAN configuration will
override the system's configuration.
• IGMP querying refers to requesting the network's IGMP group membership information by sending out
IGMP queries. IGMP querying also involves participating in IGMP querier election.
• You can also restore the IGMP querying to its default (i.e., disabled) setting on the system if no VLAN
is specified, by using only ip multicast querying (e.g., ip multicast querying).
• You can also restore the IGMP querying to its default (i.e., disabled) setting on the specified VLAN, by
using only ip multicast vlan vid querying (e.g., ip multicast vlan 2 querying).

Examples
-> ip multicast querying enable
-> ip multicast querying disable
-> ip multicast querying
-> ip multicast vlan 2 querying enable
-> ip multicast vlan 2 querying disable
-> ip multicast vlan 2 querying
-> no ip multicast vlan 2 querying

page 28-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast querying

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 multicast initial-packet- Displays the IP Multicast Switching and Routing status and the general
buffer min-delay configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmp
alaIgmpQuerying
alaIgmpVlan
alaIgmpVlanQuerying

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-37
ip multicast robustness IP Multicast Switching Commands

ip multicast robustness
Sets the IGMP robustness variable on the specified VLAN or on the system if no VLAN is specified.
ip multicast [vlan vid] robustness [robustness]

Syntax Definitions

vid VLAN on which to apply the configuration.

robustness IGMP robustness variable. Valid range is 1 to 7.

Defaults

parameter default
robustness 2

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• IP Multicast Switching and Routing must be enabled to set the IGMP robustness variable on the system
and/or the specified VLANs.
• If the IGMP robustness variable is already configured on the system, then the VLAN configuration will
override the system's configuration.
• Robustness variable allows fine-tuning on the network, where the expected packet loss would be
greater.
• To restore the IGMP robustness variable to its default (i.e., 2) value on the system if no VLAN is speci-
fied, use ip multicast robustness followed by the value 0 (e.g., ip multicast robustness 0) or use only
ip multicast robustness (e.g., ip multicast robustness).
• To restore the IGMP robustness variable to its default (i.e., 2) value on the specified VLAN, use ip
multicast vlan vid robustness followed by the value 0 (e.g., ip multicast vlan 2 robustness 0) or use
only ip multicast vlan vid robustness (e.g., ip multicast vlan 2 robustness).

Examples
-> ip multicast robustness 3
-> ip multicast robustness 0
-> ip multicast robustness
-> ip multicast vlan 2 robustness 3
-> ip multicast vlan 2 robustness 0
-> ip multicast vlan 2 robustness

Release History
Release 8.1.1; command introduced.

page 28-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast robustness

Related Commands

ipv6 multicast initial-packet- Displays the IP Multicast Switching and Routing status and the general
buffer min-delay configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmp
alaIgmpRobustness
alaIgmpVlan
alaIgmpVlanRobustness

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-39
ip multicast spoofing IP Multicast Switching Commands

ip multicast spoofing
Enables or disables IGMP spoofing on the specified VLAN or on the system if no VLAN is specified.
ip multicast [vlan vid] spoofing [{enable | disable}]
no ip multicast [vlan vid] spoofing

Syntax Definitions

vid VLAN on which to apply the configuration.

enable Enable IGMP spoofing.
disable Disable IGMP spoofing.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an IGMP spoofing entry on the specified VLAN or on the
system and return to its default behavior.
• If the IGMP spoofing is already enabled on the system, then the VLAN configuration will override the
system's configuration.
• IGMP spoofing refers to replacing a client's MAC and IP address with the system's MAC and IP
address when proxying aggregated IGMP group membership information.
• You can also restore the IGMP spoofing to its default (i.e., disabled) setting on the system if no VLAN
is specified, by using only ip multicast spoofing (e.g., ip multicast spoofing).
• You can also restore the IGMP spoofing to its default (i.e., disabled) setting on the specified VLAN, by
using only ip multicast vlan vid spoofing (e.g., ip multicast vlan 2 spoofing).

Examples
-> ip multicast spoofing enable
-> ip multicast spoofing disable
-> ip multicast spoofing
-> ip multicast vlan 2 spoofing enable
-> ip multicast vlan 2 spoofing disable
-> ip multicast vlan 2 spoofing
-> no ip multicast vlan 2 spoofing

page 28-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast spoofing

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 multicast initial-packet- Displays the IP Multicast Switching and Routing status and the general
buffer min-delay configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmp
alaIgmpSpoofing
alaIgmpVlan
alaIgmpVlanSpoofing

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-41
ip multicast zapping IP Multicast Switching Commands

ip multicast zapping
Enables or disables IGMP zapping on the specified VLAN or on the system if no VLAN is specified.
ip multicast [vlan vid] zapping [{enable | disable}]

Syntax Definitions

vid VLAN on which to apply the configuration.

enable Enable IGMP zapping.
disable Disable IGMP zapping.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the IGMP zapping is already enabled on the system, then the VLAN configuration will override the
system's configuration.
• IGMP zapping refers to processing membership, immediate source filter removals and will not wait for
the protocol's specified time period. This mode facilitates IP TV applications looking for quick changes
between IP multicast groups.
• You can also restore the IGMP querying to its default (i.e., disabled) setting on the system if no VLAN
is specified, by using only ip multicast zapping (e.g., ip multicast zapping).
• You can also restore the IGMP querying to its default (i.e., disabled) setting on the specified VLAN, by
using only ip multicast vlan vid zapping (e.g., ip multicast vlan 2 zapping).

Examples
-> ip multicast zapping enable
-> ip multicast zapping disable
-> ip multicast zapping
-> ip multicast vlan 2 zapping enable
-> ip multicast vlan 2 zapping disable
-> ip multicast vlan 2 zapping

Release History
Release 8.1.1; command introduced.

page 28-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast zapping

Related Commands

ipv6 multicast initial-packet- Displays the IP Multicast Switching and Routing status and the general
buffer min-delay configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmp
alaIgmpZapping
alaIgmpVlan
alaIgmpVlanZapping

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-43
ip multicast proxying IP Multicast Switching Commands

ip multicast proxying
Enables or disables IGMP proxying on the specified VLAN or on the system if no VLAN is specified.
ip multicast [vlan vid] proxying [enable | disable]

Syntax Definitions

vid VLAN on which to apply the configuration.

enable Enable IGMP proxying.
disable Disable IGMP proxying.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the IGMP proxying is already enabled on the system, then the VLAN configuration will override the
system's configuration.
• IGMP proxying refers to processing membership information on behalf of client systems and reporting
membership on their behalf.
• You can also restore the IGMP querying to its default (i.e., disabled) setting on the system if no VLAN
is specified, by using only ip multicast proxying (e.g., ip multicast proxying).
• You can also restore the IGMP querying to its default (i.e., disabled) setting on the specified VLAN, by
using only ip multicast vlan vid proxying (e.g., ip multicast vlan 2 proxying).

Examples
-> ip multicast proxying enable
-> ip multicast proxying disable
-> ip multicast proxying
-> ip multicast vlan 2 proxying enable
-> ip multicast vlan 2 proxying disable
-> ip multicast vlan 2 proxying

Release History
Release 8.1.1; command introduced.

page 28-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast proxying

Related Commands

ipv6 multicast initial-packet- Displays the IP Multicast Switching and Routing status and the general
buffer min-delay configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmp
alaIgmpProxying
alaIgmpVlan
alaIgmpVlanProxying

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-45
ip multicast helper-address IP Multicast Switching Commands

ip multicast helper-address
Specifies the destination IP address of a relay host where IGMP host reports and Leave messages are to be
sent.
ip multicast helper-address [ip-address]

Syntax Definitions

ip-address The IP address of the relay host

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• After the destination IP address is specified, the IPMS reporting feature is enabled.

• To disable the IPMS reporting feature, 0.0.0.0 is used as the IP address. It can also be disabled by omit-
ting the IP address from the command.

Examples
-> ip multicast helper-address 10.1.1.198
-> ip multicast helper-address 0.0.0.0

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 multicast initial-packet- Displays the IP Multicast Switching and Routing status and the general
buffer min-delay configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmp
alaIgmpHelperAddress
alaIgmpHelperAddressType

page 28-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast initial-packet-buffer admin-state

ip multicast initial-packet-buffer admin-state

Enables or disables the initial packet buffering feature globally for IPv4 multicast flows on the switch.
ip multicast initial-packet-buffer admin-state {enable | disable}

Syntax Definitions

enable Enable the initial packet buffering globally on the switch.

disable Disable the initial packet buffering globally on the switch.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• You must enable or disable the command to administratively enable or disable the buffering of initial
packets.

Examples
-> ip multicast initial-packet-buffer admin-state disable
-> ip multicast initial-packet-buffer admin-state enable

Release History
Release 8.2.1; command introduced.

Related Commands

show ip multicast initial- Displays the status and configuration parameters of initial multicast
packet-buffer packet buffer for IPv4 flows on the system.

MIB Objects
alaIgmp
alaIgmpInitialPacketBuffer

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-47
ip multicast initial-packet-buffer max-packet IP Multicast Switching Commands

ip multicast initial-packet-buffer max-packet

Configures the maximum number of initial packets buffered per IPv4 multicast flow.
ip multicast initial-packet-buffer max-packet [num]

Syntax Definitions

num The maximum number of packets allowed to buffer per IPv4 multicast
flow. Valid range is 1 to 10.

Defaults

parameter default
num 4

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip multicast initial-packet-buffer max-packet 4

Release History
Release 8.2.1; command introduced.

Related Commands

ip multicast initial-packet- Enables or disables the initial packet buffering feature globally on the
buffer admin-state switch, for IPv4 multicast flows.

MIB Objects
alaIgmp
alaIgmpInitialPacketBufferMaxPacket

page 28-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast initial-packet-buffer max-flow

ip multicast initial-packet-buffer max-flow

Configures the maximum number of IPv4 multicast flows buffered for initial packet.
ip multicast initial-packet-buffer max-flow [num]

Syntax Definitions

num The maximum number of IPv4 multicast flows allowed for initial packet
buffering. Valid range is 1 to 32.

Defaults

parameter default
num 32

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
NA

Examples
-> ip multicast initial-packet-buffer max-flow 32

Release History
Release 8.2.1; command introduced.

Related Commands

ip multicast initial-packet- Enables or disables the initial packet buffering feature globally on the
buffer admin-state switch, for IPv4 multicast flows.

MIB Objects
alaIgmp
alaIgmpInitialPacketBufferMaxFlow

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-49
ip multicast initial-packet-buffer timeout IP Multicast Switching Commands

ip multicast initial-packet-buffer timeout

Configures the timeout value for the initial buffered IPv4 multicast packets.
ip multicast initial-packet-buffer timeout [seconds]

Syntax Definitions

seconds The timeout value for the initial buffered IPv4 multicast packets in
seconds. Valid range is 1 to 10.

Defaults

parameter default
seconds 10

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the buffered multicast packet is not sent out before the timeout, then the buffered packets will be
removed from IPMS system.

Examples
-> ip multicast initial-packet-buffer timeout 2

Release History
Release 8.2.1; command introduced.

Related Commands

ip multicast initial-packet- Enables or disables the initial packet buffering feature globally on the
buffer admin-state switch, for IPv4 multicast flows.

MIB Objects
alaIgmp
alaIgmpInitialPacketBufferTimeout

page 28-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ip multicast initial-packet-buffer min-delay

ip multicast initial-packet-buffer min-delay

Configures the minimum delay to program the multicast replication index for IPv4 multicast flows buff-
ered for initial packet.
ip multicast initial-packet-buffer min-delay [milliseconds]

Syntax Definitions

milliseconds The minimum delay value to program the multicast replication index for
IPv4 multicast flows buffered for initial packet. Valid range is 0 to 1000.

Defaults

parameter default
milliseconds 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Note. This command configures a timer to delay the programming of multicast replication index in
hardware which might increase the number of multicast packets lost during the learning phase.

Examples
-> ip multicast initial-packet-buffer min-delay 200

Release History
Release 8.2.1; command introduced.

Related Commands

ip multicast initial-packet- Enables or disables the initial packet buffering feature globally on the
buffer admin-state switch, for IPv4 multicast flows.

MIB Objects
alaIgmp
alaIgmpInitialPacketBufferMinDelay

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-51
ipv6 multicast admin-state IP Multicast Switching Commands

ipv6 multicast admin-state

Enables or disables IPv6 Multicast Switching and Routing on the specified VLAN or on the system if no
VLAN is specified.
ipv6 multicast [vlan vid] admin-state [{enable | disable}]

Syntax Definitions

vid VLAN on which to apply the configuration.

enable Enable IPv6 Multicast Switching and Routing.
disable Disable IPv6 Multicast Switching and Routing.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If an IPv6 multicast routing protocol is already running on the system, this command will override this
configuration and always enable IPv6 Multicast Switching and Routing.
• If the IPv6 Multicast Switching and Routing is already enabled on the system, then the VLAN configu-
ration will override the system's configuration.
• You can also restore the MLD querying to its default (i.e., disabled) status on the system if no VLAN is
specified by using this command.
• You can also restore the MLD querying to its default (i.e., disabled) status on the specified VLAN, by
using this command.

Examples
-> ipv6 multicast admin-state enable
-> ipv6 multicast admin-state disable
-> ipv6 multicast admin-state
-> ipv6 multicast vlan 2 admin-state enable
-> ipv6 multicast vlan 2 admin-state disable
-> ipv6 multicast vlan 2 admin-state

Release History
Release 8.1.1; command introduced.

page 28-52 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast admin-state

Related Commands

show ipv6 multicast Displays the IPv6 Multicast Switching and Routing status and the
general configuration parameters on the specified VLAN or on the
system if no VLAN is specified.

MIB Objects
alaMld
alaMldStatus
alaMldVlan
alaMldVlanStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-53
ipv6 multicast querier-forwarding IP Multicast Switching Commands

ipv6 multicast querier-forwarding

Enables or disables MLD querier forwarding on the specified VLAN or on the system if no VLAN is
specified.
ipv6 multicast [vlan vid] querier-forwarding [{enable | disable}]
no ipv6 multicast [vlan vid] querier-forwarding

Syntax Definitions

vid The VLAN on which configuration is applied.

enable Enable MLD querier forwarding.
disable Disable MLD querier forwarding.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an MLD querier forwarding entry on the specified VLAN
or on the system and return to its default behavior.
• If the MLD querier forwarding is already enabled on the system, then the VLAN configuration will
override the system's configuration.
• MLD querier forwarding refers to promoting detected MLD queriers to receive all IP multicast data
traffic.

Examples
-> ipv6 multicast querier-forwarding enable
-> ipv6 multicast querier-forwarding disable
-> ipv6 multicast querier-forwarding
-> ipv6 multicast vlan 2 querier-forwarding enable
-> ipv6 multicast vlan 2 querier-forwarding disable
-> ipv6 multicast vlan 2 querier-forwarding
-> no ipv6 multicast vlan 2 querier-forwarding

Release History
Release 8.1.1; command introduced.

page 28-54 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast querier-forwarding

Related Commands

show ipv6 multicast Displays the IPv6 Multicast Switching and Routing status and the
general configuration parameters on the specified VLAN or on the
system if no VLAN is specified.

MIB Objects
alaMld
alaMldQuerierForwarding
alaMldVlan
alaMldVlanQuerierForwarding

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-55
ipv6 multicast flood-unknown IP Multicast Switching Commands

ipv6 multicast flood-unknown

Enables or disables the flooding of new IPv6 multicast packets until the multicast group membership table
is updated.
ipv6 multicast flood-unknown {enable | disable}

Syntax Definitions

enable Enable the flooding of multicast packets until membership table is updated.
disable Disable the flooding of multicast packets.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When flood-unknown and IP multicast switching are enabled, multicast packets are flooded on the
VLAN until the multicast group membership table is updated. They are then forwarded based on the
multicast group membership table.
• When flood-unknown is enabled and IP multicast switching is disabled, all multicast traffic will be
flooded on the VLAN.
• When flood-unknown is disabled and IP multicast switching is enabled, multicast packets are not
flooded on the VLAN but will be forwarded once the multicast group membership table is updated.
• If IP multicast switching and flood-unknown are disabled, all multicast packets are flooded on the
VLAN.

Examples
-> ipv6 multicast flood-unknown enable
-> ipv6 multicast flood-unknown disable

Release History
Release 8.1.1; command was introduced.

page 28-56 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast flood-unknown

Related Commands

ipv6 multicast admin-state Enables or disables IPv6 Multicast Switching and Routing on the
specified VLAN or on the system if no VLAN is specified.
show ipv6 multicast Displays the IPv6 Multicast Switching and Routing status and the
general configuration parameters on the specified VLAN or on the
system if no VLAN is specified.

MIB Objects
alaMld
alaMldFloodUnknown

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-57
ipv6 multicast version IP Multicast Switching Commands

ipv6 multicast version

Sets the default version of the MLD protocol on the specified VLAN or on the system if no VLAN is spec-
ified.
ipv6 multicast [vlan vid] version [version]

Syntax Definitions

vid VLAN on which to apply the configuration.

version Default MLD protocol version to run. Valid range is 1 to 2.

Defaults

parameter default
version 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• IPv6 Multicast Switching and Routing must be enabled to set the default MLD protocol version on the
system and/or the specified VLANs.
• If the default MLD protocol version is already configured on the system, then the VLAN configuration
will override the system's configuration.
• Due to protocol inter-operation requirements, this command specifies only a default version of the
MLD protocol to run.
• To restore the MLD multicast version to the default (i.e., 1) version on the system if no VLAN is speci-
fied, use ipv6 multicast version followed by the value 0 (e.g., ipv6 multicast version 0) or use only
ipv6 multicast version (e.g., ipv6 multicast version).
• To restore the MLD multicast version to the default (i.e., 1) version on the specified VLAN, use ipv6
multicast vlan vid version followed by the value 0 (e.g., ipv6 multicast vlan 2 version 0) or use only
ipv6 multicast vlan vid version (e.g., ipv6 multicast vlan 2 version).

Examples
-> ipv6 multicast version 2
-> ipv6 multicast version 0
-> ipv6 multicast version
-> ipv6 multicast vlan 2 version 2
-> ipv6 multicast vlan 2 version 0
-> ipv6 multicast vlan 2 version

Release History
Release 8.1.1; command introduced.

page 28-58 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast version

Related Commands

show ipv6 multicast Displays the IPv6 Multicast Switching and Routing status and the
general configuration parameters on the specified VLAN or on the
system if no VLAN is specified.

MIB Objects
alaMld
alaMldVersion
alaMldVlan
alaMldVlanVersion

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-59
ipv6 multicast max-group IP Multicast Switching Commands

ipv6 multicast max-group

Configures the global maximum group limit that can be learned per port/VLAN instance.The limit is
applied to each port/VLAN instance and an action is taken when it exceeds the limit.
ipv6 multicast max-group [num] [action {none | drop | replace}]

Syntax Definitions

num Specifies the maximum MLD group count. Valid range is 0 to

4294967295.
none Disables the maximum group limit configuration
drop Drops the incoming membership request.
replace Replaces an existing membership with the incoming membership
request.

Defaults
By default, the max-group limit is set to zero.

parameter defaults
action none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Configuring a max-group value will have no affect on existing group memberships until the member-
ships are refreshed on the port/VLAN instance.
• The configuration is allowed even when the ip multicast status is disabled.

• If the num and action parameters are not specified, then the limit is removed.

• The maximum group configuration on a specific VLAN or port will override the global configuration.

• MLD zapping must be enabled when the max-group limit is enabled and the action is dropped.

Examples
-> ipv6 multicast max-group 10 action drop
-> ipv6 multicast max-group 20 action replace
-> ipv6 multicast max-group

Release History
Release 8.1.1; command introduced.

page 28-60 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast max-group

Related Commands

show ipv6 multicast Displays the IPv6 Multicast Switching and Routing status and the
general configuration parameters on the specified VLAN or on the
system if no VLAN is specified.

MIB Objects
alaIgmpMaxGroupLimit
alaIgmpMaxGroupExceedAction

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-61
ipv6 multicast vlan max-group IP Multicast Switching Commands

ipv6 multicast vlan max-group

Configures the maximum group limit learned per port on a VLAN. The limit is applied to each port that is
a member of the given VLAN.
ipv6 multicast vlan vid max-group [num] [action {none | drop | replace}]

Syntax Definitions

vid VLAN on which to apply the configuration.

num The maximum MLD group count. Valid range is 0 to 4294967295.
none Disables the maximum group limit configuration.
drop Drops the incoming membership request.
replace Replaces an existing membership with the incoming membership
request.

Defaults
By default, the max-group limit is set to zero.

parameter defaults
Action none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Configuring a max-group value will have no affect on existing group memberships until the member-
ships are refreshed on the port/VLAN instance.
• The configuration is allowed even when the ip multicast status is disabled.

• If the num and action parameters are not specified, then the limit is removed.

• The max-group configuration on a VLAN will override the global configuration.

• MLD zapping must be enabled when the max-group limit is enabled and the action is dropped.

Examples
-> ipv6 multicast vlan 10 max-group 10 action drop
-> ipv6 multicast vlan 10 max-group 20 action replace

Release History
Release 8.1.1; command introduced.

page 28-62 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast vlan max-group

Related Commands

show ipv6 multicast Displays the IP Multicast Switching and Routing status and the general
configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmpVlanTable
alaIgmpVlanMaxGroupLimit
alaIgmpVlanMaxGroupExceedAction

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-63
ipv6 multicast port max-group IP Multicast Switching Commands

ipv6 multicast port max-group

Configures the maximum group limit learned per port. The limit is applicable on the given port for all
VLAN instances of the port.
ipv6 multicast port chassis/slot/port max-group [num] [action {none | drop | replace}]

Syntax Definitions

chassis/slot/port The port identifier.

num The maximum MLD group count. Valid range is 0 to 4294967295.
none Disables the maximum group limit configuration.
drop Drops the incoming membership request.
replace Replaces an existing membership with the incoming membership
request.

Defaults
By default, the max-group limit is set to zero.

parameter defaults
action none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Configuring a max-group value will have no affect on existing group memberships until the member-
ships are refreshed on the port/VLAN instance.
• The configuration is allowed even when the ip multicast status is disabled.

• If the num and action parameters are not specified, then the limit is removed.

• The maximum group configuration on a port will override the VLAN or global configuration.

• MLD zapping must be enabled when the maximum group limit is enabled and the action is dropped.

Examples
-> ipv6 multicast port 1/1/1 max-group 10 action drop
-> ipv6 multicast port 1/1/1 max-group action replace

Release History
Release 8.1.1; command introduced.

page 28-64 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast port max-group

Related Commands

show ipv6 multicast Displays the IP Multicast Switching and Routing status and the general
configuration parameters on the specified VLAN or on the system if no
VLAN is specified.

MIB Objects
alaIgmpPortTable
alaIgmpPortMaxGroupLimit
alaIgmpPortMaxGroupExceedAction

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-65
ipv6 multicast static-neighbor IP Multicast Switching Commands

ipv6 multicast static-neighbor

Creates a static MLD neighbor entry on a specified port on a specified VLAN.
ipv6 multicast static-neighbor vlan vid {port chassis/slot/port | linkagg linkagg}
no ipv6 multicast static-neighbor vlan vid {port chassis/slot/port | linkagg linkagg}

Syntax Definitions

vid VLAN to include as a static MLD neighbor.

chassis The chassis identifier.
slot/port The slot/port number you want to configure as a static MLD neighbor.
linkagg The link aggregate you want to configure as a static MLD neighbor.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an MLD static neighbor entry on a specified port on a
specified VLAN.
• The ipv6 multicast static-neighbor command allows you to create an MLD static neighbor entry on a
specified port on a specified VLAN. This, in turn, enables that network segment to receive all MLD
traffic.
• You can also create an MLD static neighbor entry on a link aggregate port by entering ipv6 multicast
static-neighbor vlan vid linkagg, followed by the link aggregation group number (e.g., ipv6 multicast
static-neighbor vlan 2 linkagg 7).

Examples
-> ipv6 multicast static-neighbor vlan 4 port 1/1/1
-> no ipv6 multicast static-neighbor vlan 4 port 1/1/1
-> ipv6 multicast static-neighbor vlan 4 linkagg 7
-> no ipv6 multicast static-neighbor vlan 4 linkagg 7

Release History
Release 8.1.1; command introduced.

page 28-66 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast static-neighbor

Related Commands

show ipv6 multicast neighbor Displays the MLD neighbor table entries of IPv6 Multicast Switching
and Routing.

MIB Objects
alaMldStaticNeighborTable
alaMldStaticNeighborVlan
alaMldStaticNeighborIfIndex
alaMldStaticNeighborRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-67
ipv6 multicast static-querier IP Multicast Switching Commands

ipv6 multicast static-querier

Creates a static MLD querier entry on a specified port on a specified VLAN.
ipv6 multicast static-querier vlan vid {port chassis/slot/port | linkagg linkagg}
no ipv6 multicast static-querier vlan vid {port chassis/slot/port | linkagg linkagg}

Syntax Definitions

vid VLAN to include as a static MLD querier.

chassis The chassis identifier.
slot/port The slot/port number you want to configure as a static MLD querier.
linkagg The link aggregate you want to configure as a static MLD querier.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an MLD static querier entry on a specified port on a speci-
fied VLAN.
• The ipv6 multicast static-querier command allows you to create an MLD static querier entry on a
specified port on a specified VLAN. This, in turn, enables that network segment to receive all MLD
traffic.
• You can also create an MLD static querier entry on a link aggregate port by entering ipv6 multicast
static-querier vlan vid linkagg, followed by the link aggregation group number (e.g., ipv6 multicast
static-querier vlan 2 linkagg 7).

Examples
-> ipv6 multicast static-querier vlan 4 port 1/1/1
-> no ipv6 multicast static-querier vlan 4 port 1/1/1
-> ipv6 multicast static-querier vlan 4 linkagg 7
-> no ipv6 multicast static-querier vlan 4 linkagg 7

Release History
Release 8.1.1; command introduced.

page 28-68 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast static-querier

Related Commands

show ipv6 multicast querier Displays the MLD querier table entries of IPv6 Multicast Switching and
Routing.

MIB Objects
alaMldStaticQuerierTable
alaMldStaticQuerierVlan
alaMldStaticQuerierIfIndex
alaMldStaticQuerierRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-69
ipv6 multicast static-group IP Multicast Switching Commands

ipv6 multicast static-group

Creates a static MLD group entry on a specified port on a specified VLAN.
ipv6 multicast static-group ip_address vlan vid {port chassis/slot/port | linkagg linkagg}
no ipv6 multicast static-group ip_address vlan vid {port chassis/slot/port | linkagg linkagg}

Syntax Definitions

ip_address IPv6 multicast group address.

vid VLAN to include as a static MLD group.
chassis The chassis identifier.
slot/port The slot/port number you want to configure as a static MLD group.
linkagg The link aggregate you want to configure as a static MLD group.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an MLD static group entry on a specified port on the spec-
ified VLAN.
• The ipv6 multicast static-group command allows you to create an MLD static group entry on a speci-
fied port on a specified VLAN. This, in turn, enables that network segment to receive MLD traffic
addressed to the specified IPv6 multicast group address.
• You can also create an MLD static group entry on a link aggregate port by entering ipv6 multicast
static-group ip_address vlan vid linkagg, followed by the link aggregation group number (e.g., ipv6
multicast static-group ff05::5 vlan 2 linkagg 7).

Examples
-> ipv6 multicast static-group ff05::4681 vlan 4 port 1/1/1
-> no ipv6 multicast static-group ff05::4681 vlan 4 port 1/1/1
-> ipv6 multicast static-group ff05::4681 vlan 4 linkagg 7
-> no ipv6 multicast static-group ff05::4681 vlan 4 linkagg 7

Release History
Release 8.1.1; command introduced.

page 28-70 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast static-group

Related Commands

show ipv6 multicast group Displays the MLD group membership table entries of IPv6 Multicast
Switching and Routing for the specified IPv6 multicast group address or
all entries if no IPv6 multicast group address is specified.

MIB Objects
alaMldStaticMemberTable
alaMldStaticMemberVlan
alaMldStaticMemberIfIndex
alaMldStaticMemberGroupAddress
alaMldStaticMemberRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-71
ipv6 multicast query-interval IP Multicast Switching Commands

ipv6 multicast query-interval

Sets the MLD query interval on the specified VLAN or on the system if no VLAN is specified.
ipv6 multicast [vlan vid] query-interval [seconds]

Syntax Definitions

vid VLAN on which to apply the configuration.

seconds MLD query interval in seconds. Valid range is 1 to 65535.

Defaults

parameter default
seconds 125

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• IPv6 Multicast Switching and Routing must be enabled to set the MLD query interval on the system
and/or the specified VLANs.
• If the MLD query interval is already configured on the system, then the VLAN configuration will over-
ride the system's configuration.
• The MLD query interval refers to the time period between MLD query messages.

• To restore the MLD query interval to its default (i.e., 125 seconds) value on the system if no VLAN is
specified, use ipv6 multicast query-interval followed by the value 0 (e.g., ipv6 multicast query-inter-
val 0) or use only ipv6 multicast query-interval (e.g., ipv6 multicast query-interval).
• To restore the MLD query interval to its default (i.e., 125 seconds) value on the specified VLAN, use
ipv6 multicast vlan vid query-interval followed by the value 0 (e.g., ipv6 multicast vlan 2 query-
interval 0) or use only ipv6 multicast vlan vid query-interval (e.g., ipv6 multicast vlan 2 query-inter-
val).

Examples
-> ipv6 multicast query-interval 100
-> ipv6 multicast query-interval 0
-> ipv6 multicast query-interval
-> ipv6 multicast vlan 2 query-interval 100
-> ipv6 multicast vlan 2 query-interval 0
-> ipv6 multicast vlan 2 query-interval

Release History
Release 8.1.1; command introduced.

page 28-72 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast query-interval

Related Commands

show ipv6 multicast Displays the IPv6 Multicast Switching and Routing status and the
general configuration parameters on the specified VLAN or on the
system if no VLAN is specified.

MIB Objects
alaMld
alaMldQueryInterval
alaMldVlan
alaMldVlanQueryInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-73
ipv6 multicast last-member-query-interval IP Multicast Switching Commands

ipv6 multicast last-member-query-interval

Sets the MLD last member query interval on the specified VLAN or on the system if no VLAN is speci-
fied.
ipv6 multicast [vlan vid] last-member-query-interval [milliseconds]

Syntax Definitions

vid VLAN on which to apply the configuration.

milliseconds MLD last member query interval in milliseconds. Valid range is 1 to
65535.

Defaults

parameter default
milliseconds 1000

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• IPv6 Multicast Switching and Routing must be enabled to set the MLD last member query interval to
use on the system and/or the specified VLANs. apply this configuration.
• If the MLD last member query interval is already configured on the system, then the VLAN configura-
tion will override the system's configuration.
• The MLD last member query interval refers to the time period to reply to an MLD query message sent
in response to a leave group message.
• To restore the MLD last member query interval to its default (i.e., 1000 milliseconds) value on the
system if no VLAN is specified, use ipv6 multicast last-member-query-interval followed by the
value 0 (e.g., ipv6 multicast last-member-query-interval 0) or use only ipv6 multicast last-member-
query-interval (e.g., ipv6 multicast last-member-query-interval).
• To restore the MLD last member query interval to its default (i.e., 1000 milliseconds) value on the
specified VLAN, use ipv6 multicast vlan vid last-member-query interval followed by the value 0
(e.g., ipv6 multicast vlan 2 last-member-query-interval 0) or use only ipv6 multicast vlan vid last-
member-query-interval (e.g., ipv6 multicast vlan 2 last-member-query-interval).

Examples
-> ipv6 multicast last-member-query-interval 2200
-> ipv6 multicast last-member-query-interval 0
-> ipv6 multicast last-member-query-interval
-> ipv6 multicast vlan 4 last-member-query-interval 2200
-> ipv6 multicast vlan 4 last-member-query-interval 0
-> ipv6 multicast vlan 4 last-member-query-interval

page 28-74 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast last-member-query-interval

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 multicast Displays the IPv6 Multicast Switching and Routing status and the
general configuration parameters on the specified VLAN or on the
system if no VLAN is specified.

MIB Objects
alaMld
alaMldLastMemberQueryInterval
alaMldVlan
alaMldVlanLastMemberQueryInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-75
ipv6 multicast query-response-interval IP Multicast Switching Commands

ipv6 multicast query-response-interval

Sets the MLD query response interval on the specified VLAN or on the system if no VLAN is specified.
ipv6 multicast [vlan vid] query-response-interval [milliseconds]

Syntax Definitions

vid VLAN on which to apply the configuration.

milliseconds MLD query response interval in milliseconds. Valid range is 1 to 65535.

Defaults

parameter default
milliseconds 10000

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• IPv6 Multicast Switching and Routing must be enabled to set the MLD query response interval to use
on the system and/or the specified VLANs.
• If the MLD query response interval is already configured on the system, then the VLAN configuration
will override the system's configuration.
• The MLD query response interval refers to the time period to reply to an MLD query message.

• To restore the MLD query response interval to its default (i.e., 10000 milliseconds) value on the system
if no VLAN is specified, use ipv6 multicast query-response-interval followed by the value 0 (e.g.,
ipv6 multicast query-response-interval 0) or use only ipv6 multicast query-response-interval (e.g.,
ipv6 multicast query-response-interval).
• To restore the MLD last member query interval to its default (i.e., 10000 milliseconds) value on the
specified VLAN, use ipv6 multicast vlan vid query-response-interval followed by the value 0 (e.g.,
ipv6 multicast vlan 2 query-response-interval 0) or use only ipv6 multicast vlan vid query-response-
interval (e.g., ipv6 multicast vlan 2 query-response-interval).

Examples
-> ipv6 multicast query-response-interval 20000
-> ipv6 multicast query-response-interval 0
-> ipv6 multicast query-response-interval
-> ipv6 multicast vlan 2 query-response-interval 20000
-> ipv6 multicast vlan 2 query-response-interval 0
-> ipv6 multicast vlan 2 query-response-interval

Release History
Release 8.1.1; command introduced.

page 28-76 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast query-response-interval

Related Commands

show ipv6 multicast Displays the IPv6 Multicast Switching and Routing status and the
general configuration parameters on the specified VLAN or on the
system if no VLAN is specified.

MIB Objects
alaMld
alaMldQueryResponseInterval
alaMldVlan
alaMldVlanQueryReponseInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-77
ipv6 multicast unsolicited-report-interval IP Multicast Switching Commands

ipv6 multicast unsolicited-report-interval

Sets the MLD unsolicited report interval on the specified VLAN or on the system if no VLAN is specified.
ipv6 multicast [vlan vid] unsolicited-report-interval [seconds]

Syntax Definitions

vid VLAN on which to apply the configuration.

seconds MLD unsolicited report interval in seconds. Valid range is 1 to 65535,
where 0 represents the default setting.

Defaults

parameter default
seconds 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• IPv6 Multicast Switching and Routing must be enabled to set the MLD unsolicited report interval to
use on the system and/or the specified VLANs.
• If the MLD unsolicited report interval is already configured on the system, then the VLAN configura-
tion will override the system's configuration.
• The unsolicited report interval refers to the time period to proxy any changed MLD membership state.

• To restore the MLD unsolicited interval to its default (i.e., 1 second) value on the system if no VLAN
is specified, use ipv6 multicast unsolicited-report-interval followed by the value 0 (e.g., ipv6 multi-
cast unsolicited-report-interval 0) or use only ipv6 multicast unsolicited-report-interval (e.g., ipv6
multicast unsolicited-report-interval).
• To restore the MLD unsolicited report interval to its default (i.e., 1 second) value on the specified
VLAN, use ipv6 multicast vlan vid unsolicited-report-interval followed by the value 0 (e.g., ipv6
multicast vlan 2 unsolicited-report-interval 0) or use only ipv6 multicast vlan vid unsolicited-report-
interval (e.g., ipv6 multicast vlan 2 unsolicited-report-interval).

Examples
-> ipv6 multicast unsolicited-report-interval 20000
-> ipv6 multicast unsolicited-report-interval 0
-> ipv6 multicast unsolicited-report-interval
-> ipv6 multicast vlan 2 unsolicited-report-interval 20000
-> ipv6 multicast vlan 2 unsolicited-report-interval 0
-> ipv6 multicast vlan 2 unsolicited-report-interval

page 28-78 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast unsolicited-report-interval

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 multicast Displays the IPv6 Multicast Switching and Routing status and the
general configuration parameters on the specified VLAN or on the
system if no VLAN is specified.

MIB Objects
alaMld
alaMldUnsolicitedReportInterval
alaMldVlan
alaMldVlanUnsolicitedReportInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-79
ipv6 multicast router-timeout IP Multicast Switching Commands

ipv6 multicast router-timeout

Configures the expiry time of IPv6 multicast routers on the specified VLAN or on the system if no VLAN
is specified.
ipv6 multicast [vlan vid] router-timeout [seconds]

Syntax Definitions

vid VLAN on which to apply the configuration.

seconds MLD router timeout in seconds. Valid range is 1 to 65535.

Defaults

parameter default
seconds 90

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• IPv6 Multicast Switching and Routing must be enabled to set the MLD router timeout on the system
and/or the specified VLANs. apply this configuration.
• If the MLD router timeout is already configured on the system, then the VLAN configuration will over-
ride the system's configuration.
• To restore the MLD router timeout to its default (i.e., 90 seconds) value on the system if no VLAN is
specified, use ipv6 multicast router-timeout followed by the value 0 (e.g., ipv6 multicast router-time-
out 0) or use only ipv6 multicast router-timeout (e.g., ipv6 multicast router-timeout).
• To restore the MLD router timeout to its default (i.e., 90 seconds) value on the specified VLAN, use
ipv6 multicast vlan vid router-timeout followed by the value 0 (e.g., ipv6 multicast vlan 2 router-
timeout 0) or use only ipv6 multicast vlan vid router-timeout (e.g., ipv6 multicast vlan 2 router-time-
out).

Examples
-> ipv6 multicast router-timeout 100
-> ipv6 multicast router-timeout 0
-> ipv6 multicast router-timeout
-> ipv6 multicast vlan 2 router-timeout 100
-> ipv6 multicast vlan 2 router-timeout 0
-> ipv6 multicast vlan 2 router-timeout

Release History
Release 8.1.1; command introduced.

page 28-80 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast router-timeout

Related Commands

show ipv6 multicast Displays the IPv6 Multicast Switching and Routing status and the
general configuration parameters on the specified VLAN or on the
system if no VLAN is specified.

MIB Objects
alaMld
alaMldRouterTimeout
alaMldVlan
alaMldVlanRouterTimeout

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-81
ipv6 multicast source-timeout IP Multicast Switching Commands

ipv6 multicast source-timeout

Configures the expiry time of IPv6 multicast sources on the specified VLAN or on the system if no VLAN
is specified.
ipv6 multicast [vlan vid] source-timeout [seconds]

Syntax Definitions

vid VLAN on which to apply the configuration.

seconds MLD source timeout in seconds. Valid range is 1 to 65535.

Defaults

parameter default
seconds 30

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• IPv6 Multicast Switching and Routing must be enabled to set the MLD source timeout on the system
and/or the specified VLANs.
• If the MLD source timeout is already configured on the system, then the VLAN configuration will
override the system's configuration.
• To restore the MLD router timeout to its default (i.e., 30 seconds) value on the system if no VLAN is
specified, use ipv6 multicast source-timeout followed by the value 0 (e.g., ipv6 multicast source-
timeout 0) or use only ipv6 multicast source-timeout (e.g., ipv6 multicast source-timeout).
• To restore the MLD router timeout to its default (i.e., 30 seconds) value on the specified VLAN, use
ipv6 multicast vlan vid source-timeout followed by the value 0 (e.g., ipv6 multicast vlan 2 source-
timeout 0) or use only ipv6 multicast vlan vid source-timeout (e.g., ipv6 multicast vlan 2 source-
timeout).

Examples
-> ipv6 multicast source-timeout 100
-> ipv6 multicast source-timeout 0
-> ipv6 multicast source-timeout
-> ipv6 multicast vlan 2 source-timeout 100
-> ipv6 multicast vlan 2 source-timeout 0
-> ipv6 multicast vlan 2 source-timeout

Release History
Release 8.1.1; command introduced.

page 28-82 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast source-timeout

Related Commands

show ipv6 multicast Displays the IPv6 Multicast Switching and Routing status and the
general configuration parameters on the specified VLAN or on the
system if no VLAN is specified.

MIB Objects
alaMld
alaMldSourceTimeout
alaMldVlan
alaMldVlanSourceTimeout

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-83
ipv6 multicast querying IP Multicast Switching Commands

ipv6 multicast querying

Enables or disables MLD querying on the specified VLAN or on the system if no VLAN is specified.
ipv6 multicast [vlan vid] querying [{enable | disable}]
no ipv6 multicast [vlan vid] querying

Syntax Definitions

vid VLAN on which to apply the configuration.

enable Enable MLD querying.
disable Disable MLD querying.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an MLD querying entry on the specified VLAN or on the
system and return to its default behavior.
• IPv6 Multicast Switching and Routing must be enabled to enable MLD querying on the system and/or
specified VLANs.
• If the MLD querying is already enabled/disabled on the system, then the VLAN configuration will
override the system's configuration.
• MLD querying refers to requesting the network's MLD group membership information by sending out
MLD queries. MLD querying also involves participating in MLD querier election.
• You can also restore the MLD querying to its default (i.e., disabled) setting on the system if no VLAN
is specified, by using only ipv6 multicast querying (e.g., ipv6 multicast querying).
• You can also restore the MLD querying to its default (i.e., disabled) setting on the specified VLAN, by
using only ipv6 multicast vlan vid querying (e.g., ipv6 multicast vlan 2 querying).

Examples
-> ipv6 multicast querying enable
-> ipv6 multicast querying disable
-> ipv6 multicast querying
-> ipv6 multicast vlan 2 querying enable
-> ipv6 multicast vlan 2 querying disable
-> ipv6 multicast vlan 2 querying
-> no ipv6 multicast vlan 2 querying

page 28-84 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast querying

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 multicast Displays the IPv6 Multicast Switching and Routing status and the
general configuration parameters on the specified VLAN or on the
system if no VLAN is specified.

MIB Objects
alaMld
alaMldQuerying
alaMldVlan
alaMldVlanQuerying

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-85
ipv6 multicast robustness IP Multicast Switching Commands

ipv6 multicast robustness

Sets the MLD robustness variable on the specified VLAN or on the system if no VLAN is specified.
ipv6 multicast [vlan vid] robustness [robustness]

Syntax Definitions

vid VLAN on which to apply the configuration.

robustness MLD robustness variable. Valid range is 1 to 7.

Defaults

parameter default
robustness 2

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• IPv6 Multicast Switching and Routing must be enabled to set the MLD robustness variable on the
system and/or the specified VLANs.
• If the MLD robustness variable is already configured on the system, then the VLAN configuration will
override the system's configuration.
• Robustness variable allows fine-tuning on the network, where the expected packet loss would be
greater.
• To restore the MLD robustness variable to its default (i.e., 2) value on the system if no VLAN is speci-
fied, use ipv6 multicast robustness followed by the value 0 (e.g., ipv6 multicast robustness 0) or use
only ipv6 multicast robustness (e.g., ipv6 multicast robustness).
• To restore the MLD robustness variable to its default (i.e., 2) value on the specified VLAN, use ipv6
multicast vlan vid robustness followed by the value 0 (e.g., ipv6 multicast vlan 2 robustness 0) or use
only ipv6 multicast vlan vid robustness (e.g., ipv6 multicast vlan 2 robustness).

Examples
-> ipv6 multicast robustness 3
-> ipv6 multicast robustness 0
-> ipv6 multicast robustness
-> ipv6 multicast vlan 2 robustness 3
-> ipv6 multicast vlan 2 robustness 0
-> ipv6 multicast vlan 2 robustness

Release History
Release 8.1.1; command introduced.

page 28-86 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast robustness

Related Commands

show ipv6 multicast Displays the IPv6 Multicast Switching and Routing status and the
general configuration parameters on the specified VLAN or on the
system if no VLAN is specified.

MIB Objects
alaMld
alaMldRobustness
alaMldVlan
alaMldVlanRobustness

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-87
ipv6 multicast spoofing IP Multicast Switching Commands

ipv6 multicast spoofing

Enables or disables MLD spoofing on the specified VLAN or on the system if no VLAN is specified.
ipv6 multicast [vlan vid] spoofing [{enable | disable}]
no ipv6 multicast [vlan vid] spoofing

Syntax Definitions

vid VLAN on which to apply the configuration.

enable Enable MLD spoofing.
disable Disable MLD spoofing.

Defaults

parameter defaults
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an MLD spoofing entry on the specified VLAN or on the
system and return to its default behavior.
• If the MLD spoofing is already enabled on the system, then the VLAN configuration will override the
system's configuration.
• MLD spoofing refers to replacing a client's MAC and IP address with the system's MAC and IP
address when proxying aggregated MLD group membership information.
• You can also restore the MLD spoofing to its default (i.e., disabled) setting on the system if no VLAN
is specified, by using only ipv6 multicast spoofing (i.e., ipv6 multicast spoofing).
• You can also restore the MLD spoofing to its default (i.e., disabled) setting on the specified VLAN, by
using only ipv6 multicast vlan vid spoofing (i.e., ipv6 multicast vlan 2 spoofing).

Examples
-> ipv6 multicast spoofing enable
-> ipv6 multicast spoofing disable
-> ipv6 multicast spoofing
-> ipv6 multicast vlan 2 spoofing enable
-> ipv6 multicast vlan 2 spoofing disable
-> ipv6 multicast vlan 2 spoofing
-> no ipv6 multicast vlan 2 spoofing

page 28-88 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast spoofing

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 multicast Displays the IPv6 Multicast Switching and Routing status and the
general configuration parameters on the specified VLAN or on the
system if no VLAN is specified.

MIB Objects
alaMld
alaMldSpoofing
alaMldVlan
alaMldVlanSpoofing

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-89
ipv6 multicast zapping IP Multicast Switching Commands

ipv6 multicast zapping

Enables or disables MLD zapping on the specified VLAN or on the system if no VLAN is specified.
ipv6 multicast [vlan vid] zapping [{enable | disable}]

Syntax Definitions

vid VLAN on which to apply the configuration.

enable Enable MLD zapping.
disable Disable MLD zapping.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the MLD zapping is already enabled on the system, then the VLAN configuration will override the
system's configuration.
• MLD zapping refers to processing membership and source filter removals immediately and not wait-
ing for the protocol's specified time period. This mode facilitates IP TV applications looking for quick
changes between IP multicast groups.
• You can also restore the MLD zapping to its default (i.e., disabled) setting on the system if no VLAN is
specified, by using only ipv6 multicast zapping (e.g., ipv6 multicast zapping).
• You can also restore the MLD zapping to its default (i.e., disabled) setting on the specified VLAN, by
using only ipv6 multicast vlan vid zapping (e.g., ipv6 multicast vlan 2 zapping).

Examples
-> ipv6 multicast zapping enable
-> ipv6 multicast zapping disable
-> ipv6 multicast zapping
-> ipv6 multicast vlan 2 zapping enable
-> ipv6 multicast vlan 2 zapping disable
-> ipv6 multicast vlan 2 zapping

Release History
Release 8.1.1; command introduced.

page 28-90 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast zapping

Related Commands

show ipv6 multicast Displays the IPv6 Multicast Switching and Routing status and the
general configuration parameters on the specified VLAN or on the
system if no VLAN is specified.

MIB Objects
alaMld
alaMldZapping
alaMldVlan
alaMldVlanZapping

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-91
ipv6 multicast proxying IP Multicast Switching Commands

ipv6 multicast proxying

Enables or disables MLD proxying on the specified VLAN or on the system if no VLAN is specified.
ipv6 multicast [vlan vid] proxying [enable | disable]

Syntax Definitions
vid VLAN on which to apply the configuration.
enable Enable MLD proxying.
disable Disable MLD proxying.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the MLD proxying is already enabled on the system, then the VLAN configuration will override the
system's configuration.
• MLD proxying refers to processing membership information on behalf of client systems and reporting
membership on their behalf.
• You can also restore the MLD proxying to its default (i.e., disabled) setting on the system if no VLAN
is specified, by using only ipv6 multicast proxying (e.g., ipv6 multicast proxying).
• You can also restore the MLD proxying to its default (i.e., disabled) setting on the specified VLAN, by
using only ipv6 multicast vlan vid proxying (e.g., ipv6 multicast vlan 2 proxying).

Examples
-> ipv6 multicast proxying enable
-> ipv6 multicast proxying disable
-> ipv6 multicast proxying
-> ipv6 multicast vlan 2 proxying enable
-> ipv6 multicast vlan 2 proxying disable
-> ipv6 multicast vlan 2 proxying

Release History
Release 8.1.1; command introduced.

page 28-92 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast proxying

Related Commands

show ipv6 multicast Displays the IPv6 Multicast Switching and Routing status and the
general configuration parameters on the specified VLAN or on the
system if no VLAN is specified.

MIB Objects
alaMld
alaMldProxying
alaMldVlan
alaMldVlanProxying

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-93
ipv6 multicast initial-packet-buffer admin-state IP Multicast Switching Commands

ipv6 multicast initial-packet-buffer admin-state

Enables or disables the initial packet buffering feature globally for IPv6 multicast flows on the switch.
ipv6 multicast initial-packet-buffer admin-state {enable | disable}

Syntax Definitions

enable Enable the initial packet buffering globally on the switch for IPv6 multicast
flow.
disable Disable the initial packet buffering globally on the switch for IPv6 multicast
flow.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
You must enable or disable the command to administratively enable or disable the buffering of initial
multicast packets.

Examples
-> ipv6 multicast initial-packet-buffer admin-state disable
-> ipv6 multicast initial-packet-buffer admin-state enable

Release History
Release 8.2.1; command introduced.

Related Commands

show ipv6 multicast initial- Displays the status and configuration parameters of initial multicast
packet-buffer packet buffer for IPv6 flows on the switch.

MIB Objects
alaMld
alaMldInitialPacketBuffer

page 28-94 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast initial-packet-buffer max-packet

ipv6 multicast initial-packet-buffer max-packet

Configures the maximum number of initial packets buffered per IPv6 multicast flow.
ipv6 multicast initial-packet-buffer max-packet [num]

Syntax Definitions

num The maximum number of packets allowed to buffer per IPv6 multicast
flow. Valid range is 1 to 10.

Defaults

parameter default
num 4

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ipv6 multicast initial-packet-buffer max-packet 4

Release History
Release 8.2.1; command introduced.

Related Commands

ipv6 multicast initial-packet- Enables or disables the initial packet buffering feature globally for IPv6
buffer admin-state multicast flows on the switch.

MIB Objects
alaMld
alaMldInitialPacketBufferMaxPacket

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-95
ipv6 multicast initial-packet-buffer max-flow IP Multicast Switching Commands

ipv6 multicast initial-packet-buffer max-flow

Configures the maximum number of IPv6 multicast flows buffered for initial packet.
ipv6 multicast initial-packet-buffer max-flow [num]

Syntax Definitions

num The maximum number of IPv6 multicast flows allowed for initial packet
buffering. Valid range is 1 to 32.

Defaults

parameter default
num 32

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
NA

Examples
-> ipv6 multicast initial-packet-buffer max-flow 32

Release History
Release 8.2.1; command introduced.

Related Commands

ipv6 multicast initial-packet- Enables or disables the initial packet buffering feature globally for IPv6
buffer admin-state multicast flows on the switch.

MIB Objects
alaMld
alaMldInitialPacketBufferMaxFlow

page 28-96 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands ipv6 multicast initial-packet-buffer timeout

ipv6 multicast initial-packet-buffer timeout

Configures the timeout value for the buffered IPv6 initial multicast packets.
ipv6 multicast initial-packet-buffer timeout [seconds]

Syntax Definitions

seconds The timeout value for the initial buffered IPv6 multicast packets in
seconds. Valid range is 1 to 10.

Defaults

parameter default
seconds 10

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If the buffered multicast packet is not sent out before the timeout, then the buffered packets will be
removed from IPMS system.

Examples
-> ipv6 multicast initial-packet-buffer timeout 2

Release History
Release 8.2.1; command introduced.

Related Commands

ipv6 multicast initial-packet- Enables or disables the initial packet buffering feature globally for IPv6
buffer admin-state multicast flows on the switch.

MIB Objects
alaMld
alaMldInitialPacketBufferTimeout

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-97
ipv6 multicast initial-packet-buffer min-delay IP Multicast Switching Commands

ipv6 multicast initial-packet-buffer min-delay

Configures the minimum delay to program the multicast replication index for IPv6 multicast flows buff-
ered for initial packet.
ipv6 multicast initial-packet-buffer min-delay [milliseconds]

Syntax Definitions

milliseconds The minimum delay value to program the multicast replication index for
IPv6 multicast flows buffered for initial packet. Valid range is 0 to 1000.

Defaults

parameter default
milliseconds 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Note. This command configures a timer to delay the programming of multicast replication index in hard-
ware which might increase the number of multicast packets lost during the learning phase.

Examples
-> ipv6 multicast initial-packet-buffer min-delay 200

Release History
Release 8.2.1; command introduced.

Related Commands

ipv6 multicast initial-packet- Enables or disables the initial packet buffering feature globally on the
buffer admin-state switch, for IPv6 multicast flows.

MIB Objects
alaMld
alaMldInitialPacketBufferMinDelay

page 28-98 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ip multicast

show ip multicast
Displays the IP Multicast Switching and Routing status and the general configuration parameters on the
specified VLAN or on the system if no VLAN is specified.
show ip multicast [vlan vid]

Syntax Definitions

vid VLAN ID number (1–4094).

Defaults
By default the status and general configuration parameters for the system.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Specify a VLAN ID to display the configuration information for an individual VLAN.

Examples
-> show ip multicast

Status: Enabled
Querying: Disabled
Proxying Disabled
Spoofing: Disabled
Zapping: Disabled
Querier Forwarding: Disabled
Version: 2
Robustness: 2
Query Interval (seconds): 125
Query Response Interval (tenths of seconds): 100
Last Member Query Interval(tenths of seconds):10
Unsolicited Report Interval(seconds): 1
Router Timeout (seconds): 90
Source Timeout (seconds): 30

-> show ip multicast vlan 1

Status: Enabled
Querying: Disabled
Proxying Disabled
Spoofing: Disabled
Zapping: Disabled
Querier Forwarding: Disabled
Version: 2
Robustness: 2
Query Interval (seconds): 125
Query Response Interval (tenths of seconds): 100

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-99
show ip multicast IP Multicast Switching Commands

Last Member Query Interval(tenths of seconds):10

Unsolicited Report Interval(seconds): 1
Router Timeout (seconds): 90
Source Timeout (seconds): 30

Output fields are described here:

output definitions
Status Whether the IP Multicast Switching and Routing is Enabled or
Disabled (the default status).You can enable or disable IP Multicast
Switching and Routing with the ip multicast admin-state command,
which is described on page 28-4.
Querying The current state of IGMP querying, which can be Enabled or
Disabled (the default status). You can enable or disable IGMP querying
with the ip multicast querying command, which is described on page
28-36.
Proxying The current state of IGMP proxying on the system, which can be
Enabled or Disabled (the default status). You can enable or disable
IGMP spoofing with the ip multicast proxying command, which is
described on page 28-44.
Spoofing The current state of IGMP spoofing on the system, which can be
Enabled or Disabled (the default status). You can enable or disable
IGMP spoofing with the ip multicast spoofing command, which is
described on page 28-40.
Zapping The current state of IGMP zapping on the system, which can be
Enabled or Disabled (the default status). You can enable or disable
IGMP zapping with the ip multicast zapping command, which is
described on page 28-42.
Querier Forwarding The current state of IGMP querier forwarding on the system, which can
be Enabled or Disabled (the default status). You can enable or disable
IGMP Querier forwarding with the ip multicast querier-forwarding
command, which is described on page 28-6.
Version Displays the default IGMP version, which can be 1, 2 or 3. Use the ip
multicast version command to modify this parameter.
Robustness Displays the IGMP robustness value, ranging from 1 to 7. (The default
value is 2). Use the ip multicast robustness command to modify this
parameter.
Query Interval (seconds) Displays the time (in seconds) between IGMP queries. (The default
value is 125 seconds). You can modify this parameter with the ip
multicast query-interval command, which is described on page 28-24.
Query Response Interval Displays the time (in tenths of seconds) taken to reply to an IGMP
(tenths of seconds) query message. (The default value is 100 tenths-of-seconds). You can
modify this parameter with the ip multicast query-response-interval
command, which is described on page 28-28.
Last Member Query Interval Displays the time (in tenths of seconds) taken to reply to an IGMP
(tenths of seconds) query message sent in response to a leave group message. (The default
value is 10 tenths-of-seconds.) You can modify this parameter with the
ip multicast last-member-query-interval command, which is
described on page 28-26.

page 28-100 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ip multicast

output definitions
Unsolicited Report Interval Displays the time period (in seconds) to proxy any changed IGMP
(seconds) membership state. (The default value is 1 second). You can modify this
parameter with the ip multicast unsolicited-report-interval
command, which is described on page 28-30.
Router Timeout (seconds) Displays the IGMP router timeout in seconds. (The default value is 90
seconds.) You can modify this parameter with the ip multicast router-
timeout command, which is described on page 28-32.
Source Timeout (seconds) Displays the IGMP source timeout in seconds. (The default value is 30
seconds.) You can modify this parameter with the ip multicast source-
timeout command, which is described on page 28-34.

Release History
Release 8.1.1; command introduced.

Related Commands

ip multicast admin-state Enables or disables IP Multicast Switching and Routing on the specified
VLAN, or on the system if no VLAN is specified.
ip multicast version Sets the default version of the IGMP protocol on the specified VLAN or
on the system if no VLAN is specified.
ip multicast querying Enables or disables IGMP querying on the specified VLAN or on the
system if no VLAN is specified.
ip multicast robustness Sets the IGMP robustness variable on the specified VLAN or on the
system if no VLAN is specified.
ip multicast spoofing Enables or disables IGMP spoofing on the specified VLAN or on the
system if no VLAN is specified.
ip multicast zapping Enables or disables IGMP zapping on the specified VLAN or on the
system if no VLAN is specified.
ip multicast proxying Enables or disables IGMP proxying on the specified VLAN or on the
system if no VLAN is specified.
ip multicast query-interval Sets the IGMP query interval on the specified VLAN or on the system if
no VLAN is specified.
ip multicast last-member- Sets the IGMP last member query interval value on the specified VLAN
query-interval or on the system if no VLAN is specified.
ip multicast query-response- Sets the IGMP query response interval on the specified VLAN or on the
interval system if no VLAN is specified.
ip multicast unsolicited- Sets the value of the IGMP unsolicited report interval on the specified
report-interval VLAN or on the system if no VLAN is specified.
ip multicast router-timeout Configures the expiry time of IP multicast routers on the specified
VLAN or on the system if no VLAN is specified.
ip multicast source-timeout Configures the expiry time of IP multicast sources on the specified
VLAN or on the system if no VLAN is specified.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-101
show ip multicast IP Multicast Switching Commands

MIB Objects
alaIgmp
alaIgmpStatus
alaIgmpQuerying
alaIgmpProxying
alaIgmpSpoofing
alaIgmpZapping
alaIgmpQuerierForwarding
alaIgmpVersion
alaIgmpRobustness
alaIgmpQueryInterval
alaIgmpQueryResponseInterval
alaIgmpLastMemberQueryInterval
alaIgmpUnsolicitedReportInterval
alaIgmpRouterTimeout
alaIgmpSourceTimeout
alaIgmpVlan
alaIgmpVlanStatus
alaIgmpVlanQuerying
alaIgmpVlanProxying
alaIgmpVlanSpoofing
alaIgmpVlanZapping
alaIgmpVlanQuerierForwarding
alaIgmpVlanVersion
alaIgmpVlanRobustness
alaIgmpVlanQueryInterval
alaIgmpVlanQueryResponseInterval
alaIgmpVlanLastMemberQueryInterval
alaIgmpVlanUnsolicitedReportInterval
alaIgmpVlanRouterTimeout
alaIgmpVlanSourceTimeout

page 28-102 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ip multicast port

show ip multicast port

Displays the max-group configuration applicable for all port or vlan instances of a given port or all ports.
The current number of groups learnt on a given port or vlan instance will also be displayed.
show ip multicast port [chassis/slot/port]

Syntax Definitions

chassis The chassis identifier.

slot | port The slot number for the module and the physical port number on that
module.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Specify a slot and port number to display the configuration information for a specific switch port.

Examples
-> show ip multicast port

Total 5 Port-Vlan Pairs

Port VLAN Current Igmp Max-group Action

Groups
-------+---------+-------------+--------------+---------
1/1/1 10 1 1 drop
1/1/1 20 1 1 drop
1/1/3 15 2 5 replace
1/1/4 20 3 10 drop
1/1/6 15 5 0 none

-> show ip multicast port 1/1/1

Max-group 0 Action none
Total 2 Port-Vlan Pairs

Port vlancurrent IGMP max-group action

group
-------+-----+-------------+----------+---------
1/1/1 10 1 1 drop
1/1/1 20 2 5 replace

output definitions
Port The slot and port number of the IP multicast port.
VLAN The VLAN associated with the IP multicast port.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-103
show ip multicast port IP Multicast Switching Commands

output definitions
Current Groups The current group associated with the IP Current groups.
IGMP The IGMP associated with the IP multicast port.
Max-group The maximum group count allowed on the port.
Action The action to be taken when the group membership limit is exceeded.

Release History
Release 8.1.1; command introduced.

Related Commands

ip multicast admin-state Enables or disables IP Multicast Switching and Routing on the specified
VLAN, or on the system if no VLAN is specified.
ip multicast version Sets the default version of the IGMP protocol on the specified VLAN or
on the system if no VLAN is specified.
ip multicast querying Enables or disables IGMP querying on the specified VLAN or on the
system if no VLAN is specified.
ip multicast robustness Sets the IGMP robustness variable on the specified VLAN or on the
system if no VLAN is specified.
ip multicast spoofing Enables or disables IGMP spoofing on the specified VLAN or on the
system if no VLAN is specified.
ip multicast zapping Enables or disables IGMP zapping on the specified VLAN or on the
system if no VLAN is specified.
ip multicast proxying Enables or disables IGMP proxying on the specified VLAN or on the
system if no VLAN is specified.
ip multicast query-interval Sets the IGMP query interval on the specified VLAN or on the system if
no VLAN is specified.
ip multicast last-member- Sets the IGMP last member query interval value on the specified VLAN
query-interval or on the system if no VLAN is specified.
ip multicast query-response- Sets the IGMP query response interval on the specified VLAN or on the
interval system if no VLAN is specified.
ip multicast unsolicited- Sets the value of the IGMP unsolicited report interval on the specified
report-interval VLAN or on the system if no VLAN is specified.
ip multicast router-timeout Configures the expiry time of IP multicast routers on the specified
VLAN or on the system if no VLAN is specified.
ip multicast source-timeout Configures the expiry time of IP multicast sources on the specified
VLAN or on the system if no VLAN is specified.

page 28-104 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ip multicast port

MIB Objects
alaIgmpPortTable
alaIgmpPortMaxGroupLimit
alaIgmpPortMaxGroupExceedAction
alaIgmpPortVlanTable
alaIgmpPortVlanCurrentGroupCount
alaIgmpPortVlanMaxGroupLimit
alaIgmpPortVlanMaxGroupExceedAction

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-105
show ip multicast forward IP Multicast Switching Commands

show ip multicast forward

Displays the IP Multicast Switching and Routing forwarding table entries for the specified IP multicast
group address or all the entries if no IP multicast group address is specified.
show ip multicast forward [ip_address]

Syntax Definitions

ip_address IP multicast group address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip multicast forward

Total 1 Forwards
Ingress Egress
Group Address Host Address Tunnel Address VLAN Port VLAN Port
---------------+---------------+---------------+-----+-----+-----+------
228.0.0.1 1.0.0.2 0.0.0.0 1 2/1/1 1 2/1/23

-> show ip multicast forward 228.0.0.1

Ingress Egress
Group Address Host Address Tunnel Address VLAN Port VLAN Port
---------------+---------------+---------------+-----+-----+-----+------
228.0.0.1 1.0.0.2 0.0.0.0 1 2/1/1 1 2/1/23

Output fields are described here:

output definitions
Group Address IP group address of the IP multicast forward.
Host Address IP host address of the IP multicast forward.
Tunnel Address IP source tunnel address of the IP multicast forward.
VLAN VLAN associated with the IP multicast forward.
Port The slot and port number of the IP multicast forward.

Release History
Release 8.1.1; command introduced.

page 28-106 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ip multicast forward

Related Commands

ip multicast static-group Creates a static IGMP group entry on a specified port on a specified
VLAN.

MIB Objects
alaIgmpForwardTable
alaIgmpForwardVlan
alaIgmpForwardIfIndex
alaIgmpForwardGroupAddress
alaIgmpForwardHostAddress
alaIgmpForwardDestAddress
alaIgmpForwardOrigAddress
alaIgmpForwardType
alaIgmpForwardNextVlan
alaIgmpForwardNextIfIndex
alaIgmpForwardNextTunnelAddress
alaIgmpForwardNextType
alaIgmpForwardTtl

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-107
show ip multicast neighbor IP Multicast Switching Commands

show ip multicast neighbor

Displays the IGMP neighbor table entries of IP Multicast Switching and Routing.
show ip multicast neighbor

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip multicast neighbor

Total 2 Neighbors
Host Address VLAN Port Static Count Life
---------------+-----+-----+-------+------+-----
1.0.0.2 1 2/1/1 no 1 86
0.0.0.0 1 2/1/13 yes 0 0

Output fields are described here:

output definitions
Host Address The IP address of the IP multicast neighbor.
VLAN The VLAN associated with the IP multicast neighbor.
Port The slot and port number of the IP multicast neighbor.
Static Whether it is a static IP multicast neighbor or not.
Count Displays the count of IP multicast neighbor.
Life The life time of the IP multicast neighbor.

Release History
Release 8.1.1; command introduced.

Related Commands

ip multicast max-group Creates a static IGMP neighbor entry on a specified port on a specified
VLAN.

page 28-108 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ip multicast neighbor

MIB Objects
alaIgmpNeighborTable
alaIgmpNeighborVlan
alaIgmpNeighborIfIndex
alaIgmpNeighborHostAddress
alaIgmpNeighborCount
alaIgmpNeighborTimeout
alaIgmpNeighborUpTime
alaIgmpStaticNeighborTable
alaIgmpStaticNeighborVlan
alaIgmpStaticNeighborIfIndex
alaIgmpStaticNeighborRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-109
show ip multicast querier IP Multicast Switching Commands

show ip multicast querier

Displays the IGMP querier table entries of IP Multicast Switching and Routing.
show ip multicast querier

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip multicast querier

Total 2 Queriers
Host Address VLAN Port Static Count Life
---------------+-----+-----+-------+------+-----
1.0.0.2 1 2/1/1 no 1 250
0.0.0.0 1 2/1/13 yes 0 0

Output fields are described here:

output definitions
Host Address The IP address of the IP multicast querier.
VLAN The VLAN associated with the IP multicast querier.
Port The slot and port number of the IP multicast querier.
Static Whether it is a static multicast neighbor or not.
Count Displays the count of the IP multicast querier.
Life The life time of the IP multicast querier.

Release History
Release 8.1.1; command introduced.
Related Commands

ip multicast static-querier Creates a static IGMP querier entry on a specified port on a specified
VLAN.

page 28-110 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ip multicast querier

MIB Objects
alaIgmpQuerierTable
alaIgmpQuerierVlan
alaIgmpQuerierIfIndex
alaIgmpQuerierHostAddress
alaIgmpQuerierCount
alaIgmpQuerierTimeout
alaIgmpQuerierUpTime
alaIgmpStaticQuerierTable
alaIgmpStaticQuerierVlan
alaIgmpStaticQuerierIfIndex
alaIgmpStaticQuerierRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-111
show ip multicast group IP Multicast Switching Commands

show ip multicast group

Displays the IGMP group membership table entries of IP Multicast Switching and Routing for the
specified IP multicast group address or all entries if no IP multicast group address is specified.
show ip multicast group [ip_address]

Syntax Definitions

ip_address IP multicast group address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip multicast group

Total 3 Groups
Group Address Source Address VLAN Port Mode Static Count Life
---------------+---------------+-----+-----+--------+-------+------+-----
231.0.0.3 1.0.0.5 1 2/1/1 exclude no 1 257
234.0.0.4 0.0.0.0 1 2/1/1 exclude no 1 218
229.0.0.1 0.0.0.0 1 2/1/13 exclude yes 0 0

-> show ip multicast group 234.0.0.4

Group Address Source Address VLAN Port Mode Static Count Life
---------------+---------------+-----+-----+--------+-------+------+-----
234.0.0.4 0.0.0.0 1 2/1/1 exclude no 1 218

Output fields are described here:

output definitions
Group Address IP address of the IP multicast group.
Source Address IP address of the IP multicast source.
VLAN The VLAN associated with the IP multicast group.
Port The slot and port number of the IP multicast group.
Mode IGMP source filter mode.
Static Whether it is a static multicast group or not.

page 28-112 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ip multicast group

output definitions
Count Number of IGMP membership requests made.
Life Life time of the IGMP group membership.

Release History
Release 8.1.1; command introduced

Related Commands.

ip multicast static-group Creates a static IGMP group entry on a specified port on a specified
VLAN.

MIB Objects
alaIgmpMemberTable
alaIgmpMemberVlan
alaIgmpMemberIfIndex
alaIgmpMemberGroupAddress
alaIgmpMemberSourceAddress
alaIgmpMemberMode
alaIgmpMemberCount
alaIgmpMemberTimeout
alaIgmpStaticMemberTable
alaIgmpStaticMemberVlan
alaIgmpStaticMemberIfIndex
alaIgmpStaticMemberGroupAddress
alaIgmpStaticMemberRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-113
show ip multicast source IP Multicast Switching Commands

show ip multicast source

Displays the IP Multicast Switching and Routing source table entries matching the specified IP multicast
group address or all entries if no IP multicast group address is specified.
show ip multicast source [ip_address]

Syntax Definitions

ip_address IP multicast group address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip multicast source

Total 1 Sources
Group Address Host Address Tunnel Address VLAN Port
---------------+---------------+---------------+-----+-----
228.0.0.1 1.0.0.2 0.0.0.0 1 2/1/1

-> show ip multicast source 228.0.0.1

Total 1 Sources
Group Address Host Address Tunnel Address VLAN Port
---------------+---------------+---------------+-----+-----
228.0.0.1 1.0.0.2 0.0.0.0 1 2/1/1

output definitions
Group Address IP group address of the IP multicast source.
Host Address IP host address of the IP multicast source.
Tunnel Address IP destination tunnel address of the IP multicast source.
VLAN VLAN associated with the IP multicast source.
Port The slot and port number of the IP multicast source.

Release History
Release 8.1.1; command introduced.

page 28-114 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ip multicast source

Related Commands

show ip multicast tunnel Display the IP Multicast Switching and Routing tunneling table entries
matching the specified IP multicast group address or all entries if no IP
multicast address is specified.

MIB Objects
alaIgmpSourceTable
alaIgmpSourceVlan
alaIgmpSourceIfIndex
alaIgmpSourceGroupAddress
alaIgmpSourceHostAddress
alaIgmpSourceDestAddress
alaIgmpSourceOrigAddress
alaIgmpSourceType
alaIgmpSourceUpTime

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-115
show ip multicast tunnel IP Multicast Switching Commands

show ip multicast tunnel

Display the IP Multicast Switching and Routing tunneling table entries matching the specified IP multicast
group address or all entries if no IP multicast address is specified.
show ip multicast tunnel [address]

Syntax Definitions

address IP multicast group address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip multicast tunnel
Total 1 Tunnels
Ingress
Group Address Host Address Tunnel Address VLAN Port
---------------+---------------+---------------+-----+-----
228.0.0.1 1.0.0.2 2.1.2.3 1 2/1/1

output definitions
Group Address IP group address of the IP multicast tunnel.
Host Address IP host address of the IP multicast tunnel.
Tunnel Address IP source tunnel address of the IP multicast tunnel.
VLAN VLAN associated with the IP multicast tunnel.
Port The slot and port number of the IP multicast tunnel.

Release History
Release 8.1.1; command introduced.

Related Commands

show ip multicast source Displays the IP Multicast Switching and Routing source table entries
matching the specified IP multicast group address or all entries if no IP
multicast group address is specified

page 28-116 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ip multicast tunnel

MIB Objects
alaIgmpTunnelTable
alaIgmpTunnelVlan
alaIgmpTunnelIfIndex
alaIgmpTunnelGroupAddress
alaIgmpTunnelHostAddress
alaIgmpTunnelDestAddress
alaIgmpTunnelOrigAddress
alaIgmpTunnelType
alaIgmpTunnelNextDestAddress
alaIgmpTunnelNextType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-117
show ip multicast initial-packet-buffer IP Multicast Switching Commands

show ip multicast initial-packet-buffer

Displays the status and configuration parameters of initial multicast packet buffer for IPv4 flows on the
Switch.
show ip multicast initial-packet-buffer

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip multicast initial-packet-buffer
Admin-status = disabled,
Max Packet = 4,
Max Flow = 32,
Timeout(seconds) = 10

output definitions
Admin-status The status of IPv4 initial multicast packet buffer.
Max Packet The maximum number of initial packets buffered per IPv4 multicast
flow.
Max Flow The maximum number of IPv4 multicast flows buffered for initial
packet buffering.
Timeout (seconds) The timeout value for the buffered IPv4 initial multicast packets.

Release History
Release 8.2.1; command introduced.

page 28-118 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ip multicast initial-packet-buffer

Related Commands

ip multicast initial-packet- Enables or disables the initial packet buffering feature globally for IPv4
buffer admin-state multicast flows on the switch.
ip multicast initial-packet- Configures the maximum number of initial packets buffered per IPv4
buffer max-packet multicast flow.
ip multicast initial-packet- Configures the maximum number of IPv4 multicast flows buffered for
buffer max-flow initial packet.
ip multicast initial-packet- Configures the timeout value for the buffered IPv4 initial multicast
buffer timeout packets.

MIB Objects
NA

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-119
show ipv6 multicast IP Multicast Switching Commands

show ipv6 multicast

Displays the IPv6 Multicast Switching and Routing status and the general configuration parameters on the
specified VLAN or on the system if no VLAN is specified.
show ipv6 multicast [vlan vid]

Syntax Definitions

vid VLAN for which to display the configuration.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 multicast

Status: = Enabled
Querying: = Disabled
Proxying: = Disabled
Spoofing: = Disabled
Zapping: = Disabled
Querier Forwarding: = Disabled
Version: = 1
Robustness: = 2
Query Interval (seconds): = 125
Query Response Interval (milliseconds): = 10000
Last Member Query Interval (milliseconds): = 1000
Unsolicited Report Interval (seconds) = 1,
Router Timeout (seconds): = 90
Source Timeout (seconds): = 30

page 28-120 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ipv6 multicast

-> show ipv6 multicast vlan 1

Status: = Enabled
Querying: = Disabled
Proxying: = Disabled
Spoofing: = Disabled
Zapping: = Disabled
Querier Forwarding: = Disabled
Version: = 1
Robustness: = 2
Query Interval (seconds): = 125
Query Response Interval (milliseconds): = 10000
Last Member Query Interval (milliseconds): = 1000
Unsolicited Report Interval (seconds) = 1,
Router Timeout (seconds): = 90
Source Timeout (seconds): = 30:

output definitions
Status Whether the IPv6 Multicast Switching and Routing is Enabled or
Disabled (the default status).You can enable or disable IPv6 Multicast
Switching and Routing with the ip multicast helper-address
command, which is described on page 28-46
Querying The current state of MLD querying, which can be Enabled or Disabled
(the default status). You can enable or disable MLD querying with the
ipv6 multicast querying command, which is described on page 28-84
Proxying The current state of MLD proxying on the system, which can be
Enabled or Disabled (the default status). You can enable or disable
MLD spoofing with the ipv6 multicast proxying command, which is
described on page 28-92
Spoofing The current state of MLD spoofing on the system, which can be
Enabled or Disabled (the default status). You can enable or disable
MLD spoofing with the ipv6 multicast spoofing command, which is
described on page 28-40
Zapping The current state of MLD zapping on the system, which can be
Enabled or Disabled (the default status). You can enable or disable
MLD zapping with the ipv6 multicast zapping command, which is
described on page 28-90
Querier Forwarding The current state of MLD querier forwarding on the system, which can
be Enabled or Disabled (the default status). You can enable or disable
MLD Querier forwarding with the ipv6 multicast querier-forwarding
command, which is described on page 28-54.
Version Displays the default MLD version, which can be 1, 2 or 3. Use the ipv6
multicast flood-unknown command to modify this parameter.
Robustness Displays the MLD robustness value, ranging from 1 to 7. Use the ipv6
multicast robustness command to modify this parameter.
Query Interval (seconds) Displays the time (in seconds) between MLD queries. (The default
value is 125 seconds). You can modify this parameter with the ipv6
multicast query-interval command, which is described on page 28-72.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-121
show ipv6 multicast IP Multicast Switching Commands

output definitions
Query Response Interval Displays the time (in milliseconds) to reply to an MLD query message.
(milliseconds) (The default value is 10000 milliseconds.) You can modify this
parameter with the ipv6 multicast query-response-interval command,
which is described on page 28-76.
Last Member Query Interval Displays the time (in milliseconds) to reply to an MLD query message
(milliseconds) sent in response to a leave group message. (The default value is 1000
milliseconds.) You can modify this parameter with the ipv6 multicast
last-member-query-interval command, which is described on page
28-74.
Unsolicited Report Interval Displays the time period (in seconds) to proxy any changed MLD
(seconds) membership state. (The default value is 1 second). You can modify this
parameter with the ipv6 multicast unsolicited-report-interval
command, which is described on page 28-78.
Router Timeout (seconds) Displays the MLD router timeout in seconds (The default value is 90
seconds.) You can modify this parameter with the ipv6 multicast
router-timeout command, which is described on page 28-80
Source Timeout (seconds) Displays the IGMP source timeout in seconds (The default is 30
seconds.) You can modify this parameter with the ipv6 multicast
source-timeout command, which is described on page 28-82

Release History
Release 8.1.1; command introduced.

Related Commands

ip multicast helper-address Enables or disables IPv6 Multicast Switching and Routing on the
specified VLAN or on the system if no VLAN is specified.
ipv6 multicast flood-unknown Sets the default version of the MLD protocol on the specified VLAN or
on the system if no VLAN is specified.
ipv6 multicast query-interval Sets the MLD query interval on the specified VLAN or on the system if
no VLAN is specified.
ipv6 multicast last-member- Sets the MLD last member query interval on the specified VLAN or on
query-interval the system if no VLAN is specified.
ipv6 multicast query-response- Sets the MLD query response interval on the specified VLAN or on the
interval system if no VLAN is specified.
ipv6 multicast unsolicited- Sets the MLD unsolicited report interval on the specified VLAN or on
report-interval the system if no VLAN is specified.
ipv6 multicast router-timeout Configures the expiry time of IPv6 multicast routers on the specified
VLAN or on the system if no VLAN is specified.
ipv6 multicast source-timeout Configures the expiry time of IPv6 multicast sources on the specified
VLAN or on the system if no VLAN is specified.
ipv6 multicast querying Enables or disables MLD querying on the specified VLAN or on the
system if no VLAN is specified.
ipv6 multicast robustness Sets the MLD robustness variable on the specified VLAN or on the
system if no VLAN is specified.

page 28-122 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ipv6 multicast

ipv6 multicast spoofing Enables or disables MLD spoofing on the specified VLAN or on the
system if no VLAN is specified.
ipv6 multicast zapping Enables or disables MLD zapping on the specified VLAN or on the
system if no VLAN is specified.
ipv6 multicast proxying Enables or disables MLD proxying on the specified VLAN or on the
system if no VLAN is specified.

MIB Objects
alaMld
alaMldStatus
alaMldQuerying
alaMldProxying
alaMldSpoofing
alaMldZapping
alaMldQuerierForwarding
alaMldVersion
alaMldRobustness
alaMldQueryInterval
alaMldQueryResponseInterval
alaMldLastMemberQueryInterval
alaMldUnsolicitedReportInterval
alaMldRouterTimeout
alaMldSourceTimeout
alaMldVlan
alaMldVlanStatus
alaMldVlanQuerying
alaMldVlanProxying
alaMldVlanSpoofing
alaMldVlanZapping
alaMldVlanQuerierForwarding
alaMldVlanVersion
alaMldVlanRobustness
alaMldVlanQueryInterval
alaMldVlanQueryResponseInterval
alaMldVlanLastMemberQueryInterval
alaMldVlanUnsolicitedReportInterval
alaMldVlanRouterTimeout
alaMldVlanSourceTimeout

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-123
show ipv6 multicast port IP Multicast Switching Commands

show ipv6 multicast port

Display the max-group configuration applicable for all port or vlan instances of a given port or all ports.
The current number of groups learnt on a given port or vlan instance will also be displayed in this show
output.
show ipv6 multicast port [chassis/slot/port]

Syntax Definitions

chassis The chassis identifier.

slot | port The slot number for the module and the physical port number on that
module (e.g. 3/1 specifies port 1 on slot 3)).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Specify a VLAN ID to display the configuration information for an individual VLAN.

Examples
-> show ipv6 multicast port 1/1/6
Max-group 9 Action replace

Total 1 Port-Vlan Pairs

Port VLAN Current Mld Max-group Action
Groups
---------+-----+-------------+----------+---------
1/1/6 15 5 0 none

Output fields are described here:

output definitions
Port The slot and port number of the IP multicast port.
VLAN The VLAN associated with the IP multicast port.
Current Groups The current group associated with the IP Current groups.
IGMP The IGMP associated with the IP multicast port.
Max-group The maximum group count allowed on the port.
Action The action to be taken when the group membership limit is exceeded.

Release History
Release 8.1.1; command introduced.

page 28-124 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ipv6 multicast port

Related Commands

ipv6 multicast admin-state Enables or disables IPv6 Multicast Switching and Routing on the
specified VLAN or on the system if no VLAN is specified.
ipv6 multicast flood-unknown Sets the default version of the MLD protocol on the specified VLAN or
on the system if no VLAN is specified.
ipv6 multicast querying Enables or disables MLD querying on the specified VLAN or on the
system if no VLAN is specified.
ipv6 multicast robustness Sets the MLD robustness variable on the specified VLAN or on the
system if no VLAN is specified.
ipv6 multicast spoofing Enables or disables MLD spoofing on the specified VLAN or on the
system if no VLAN is specified.
ipv6 multicast zapping Enables or disables MLD zapping on the specified VLAN or on the
system if no VLAN is specified.
ipv6 multicast proxying Enables or disables MLD proxying on the specified VLAN or on the
system if no VLAN is specified.
ipv6 multicast query-interval Sets the MLD query interval on the specified VLAN or on the system if
no VLAN is specified.
ipv6 multicast last-member- Sets the MLD last member query interval on the specified VLAN or on
query-interval the system if no VLAN is specified.
ipv6 multicast query-response- Sets the MLD query response interval on the specified VLAN or on the
interval system if no VLAN is specified.
ipv6 multicast unsolicited- Sets the MLD unsolicited report interval on the specified VLAN or on
report-interval the system if no VLAN is specified.
ipv6 multicast router-timeout Configures the expiry time of IPv6 multicast routers on the specified
VLAN or on the system if no VLAN is specified.
ipv6 multicast source-timeout Configures the expiry time of IPv6 multicast sources on the specified
VLAN or on the system if no VLAN is specified.

MIB Objects
alaIgmpPortTable
alaIgmpPortMaxGroupLimit
alaIgmpPortMaxGroupExceedAction
alaIgmpPortVlanTable
alaIgmpPortVlanCurrentGroupCount
alaIgmpPortVlanMaxGroupLimit
alaIgmpPortVlanMaxGroupExceedAction

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-125
show ipv6 multicast forward IP Multicast Switching Commands

show ipv6 multicast forward

Display the IPv6 Multicast Switching and Routing forwarding table entries for the specified IPv6 multicast
group address or all entries if no IPv6 multicast address is specified.
show ipv6 multicast forward [ipv6_ddress]

Syntax Definitions

ipv6_ddress IPv6 multicast group address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 multicast forward

Total 1 Forwards
Ingress Egress
Group Address Host Address Tunnel Address VLAN Port VLAN Port
-------------- +---------------+---------------+-----+-----+-----+------
ff05::6 4444::2 :: 1 2/1/1 1 2/23

-> show ipv6 multicast forward ff05::6

Ingress Egress
Group Address Host Address Tunnel Address VLAN Port VLAN Port
-------------- +---------------+---------------+-----+-----+-----+------
ff05::6 4444::2 :: 1 2/1/1 1 2/1/23

output definitions
Group Address IPv6 group address of the IPv6 multicast forward.
Host Address IPv6 host address of the IPv6 multicast forward.
Tunnel Address IPv6 source tunnel address of the IPv6 multicast forward.
VLAN VLAN associated with the IPv6 multicast forward.
Port The slot and port number of the IPv6 multicast forward.

Release History
Release 8.1.1; command introduced.

page 28-126 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ipv6 multicast forward

Related Commands

ipv6 multicast static-group Creates a static MLD group entry on a specified port on a specified
VLAN.

MIB Objects
alaMldForwardTable
alaMldForwardVlan
alaMldForwardIfIndex
alaMldForwardGroupAddress
alaMldForwardHostAddress
alaMldForwardDestAddress
alaMldForwardOrigAddress
alaMldForwardType
alaMldForwardNextVlan
alaMldForwardNextIfIndex
alaMldForwardNextDestAddress
alaMldForwardNextType
alaMldForwardTtl

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-127
show ipv6 multicast neighbor IP Multicast Switching Commands

show ipv6 multicast neighbor

Displays the MLD neighbor table entries of IPv6 Multicast Switching and Routing.
show ipv6 multicast neighbor

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 multicast neighbor

Total 2 Neighbors
Host Address VLAN Port Static Count Life
-------------------------+-----+-----+-------+------+-----
fe80::2a0:ccff:fed3:2853 1 2/1/1 no 1 6
:: 1 2/1/13 yes 0 0

output definitions
Host Address The IPv6 address of the IPv6 multicast neighbor.
VLAN The VLAN associated with the IPv6 multicast neighbor.
Port The slot and port number of the IPv6 multicast neighbor.
Static Whether it is a static MLD neighbor or not.
Count Displays the count of the IPv6 multicast neighbor.
Life The life time of the IPv6 multicast neighbor.

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 multicast max-group Creates a static MLD neighbor entry on a specified port on a specified
VLAN.

page 28-128 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ipv6 multicast neighbor

MIB Objects
alaMldNeighborTable
alaMldNeighborVlan
alaMldNeighborIfIndex
alaMldNeighborHostAddress
alaMldNeighborCount
alaMldNeighborTimeout
alaMldNeighborUpTime
alaMldStaticNeighborTable
alaMldStaticNeighborVlan
alaMldStaticNeighborIfIndex
alaMldStaticNeighborRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-129
show ipv6 multicast querier IP Multicast Switching Commands

show ipv6 multicast querier

Displays the MLD querier table entries of IPv6 Multicast Switching and Routing.
show ipv6 multicast querier

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 multicast querier

Total 2 Queriers
Host Address VLAN Port Static Count Life
-------------------------+-----+-----+-------+------+-----
fe80::2a0:ccff:fed3:2853 1 2/1/1 no 1 6
:: 1 2/1/13 yes 0 0

output definitions
Host Address The IPv6 address of the IPv6 multicast querier.
VLAN The VLAN associated with the IPv6 multicast querier.
Port The slot and port number of the IPv6 multicast querier.
Static Whether it is a static MLD neighbor or not.
Count Displays the count of the IPv6 multicast querier.
Life The life time of the IPv6 multicast querier.

Release History
Release 8.1.1; command introduced

Related Commands

ipv6 multicast static-querier Creates a static MLD querier entry on a specified port on a specified
VLAN.

page 28-130 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ipv6 multicast querier

MIB Objects
alaMldQuerierTable
alaMldQuerierVlan
alaMldQuerierIfIndex
alaMldQuerierHostAddress
alaMldQuerierCount
alaMldQuerierTimeout
alaMldQuerierUpTime
alaMldStaticQuerierTable
alaMldStaticQuerierVlan
alaMldStaticQuerierIfIndex
alaMldStaticQuerierRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-131
show ipv6 multicast group IP Multicast Switching Commands

show ipv6 multicast group

Displays the MLD group membership table entries of IPv6 Multicast Switching and Routing for the
specified IPv6 multicast group address or all entries if no IPv6 multicast group address is specified.
show ipv6 multicast group [ip_address]

Syntax Definitions

ip_address IPv6 multicast group address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 multicast group

Total 3 Groups
Group Address Source Address VLAN Port Mode Static Count Life
----------------+---------------+-----+-----+--------+-------+------+-----
ff05::5 :: 1 2/1/1 exclude no 1 145
ff05::6 3333::1 1 2/1/1 exclude no 1 242
ff05::9 :: 1 2/1/13 exclude yes 0 0

-> show ipv6 multicast group ff05::5

Group Address Source Address VLAN Port Mode Static Count Life
----------------+---------------+-----+-----+--------+-------+------+-----
ff05::5 :: 1 2/1/1 exclude no 1 145

output definitions
Group Address IPv6 address of the IPv6 multicast group.
Source Address IPv6 address of the IPv6 multicast source.
VLAN The VLAN associated with the IPv6 multicast group.
Port The slot and port number of the IPv6 multicast group.
Mode MLD source filter mode.
Static Whether it is a static MLD group or not.
Count Number of MLD membership requests made.
Life Life time of the MLD group membership.

page 28-132 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ipv6 multicast group

Release History
Release 8.1.1; command introduced

Related Commands

ipv6 multicast static-group Creates a static MLD group entry on a specified port on a specified
VLAN.

MIB Objects
alaMldMemberTable
alaMldMemberVlan
alaMldMemberIfIndex
alaMldMemberGroupAddress
alaMldMemberSourceAddress
alaMldMemberMode
alaMldMemberCount
alaMldMemberTimeout
alaMldMemberUpTime
alaMldStaticMemberTable
alaMldStaticMemberVlan
alaMldStaticMemberIfIndex
alaMldStaticMemberGroupAddress
alaMldStaticMemberRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-133
show ipv6 multicast source IP Multicast Switching Commands

show ipv6 multicast source

Displays the IPv6 Multicast Switching and Routing source table entries matching the specified IPv6
multicast group address or all entries if no IPv6 multicast group address is specified.
show ipv6 multicast source [ip_address]

Syntax Definitions

ip_address IPv6 multicast group address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 multicast source

Total 1 Sources
Group Address Host Address Tunnel Address VLAN Port
---------------+---------------+---------------+-----+-----
ff05::6 4444::2 :: 1 2/1/1

-> show ipv6 multicast source ff05::6

Total 1 Sources
Group Address Host Address Tunnel Address VLAN Port
---------------+---------------+---------------+-----+-----
ff05::6 4444::2 :: 1 2/1/1

output definitions
Group Address IPv6 group address of the IPv6 multicast source.
Host Address IPv6 host address of the IPv6 multicast source.
Tunnel Address IPv6 source tunnel address of the IPv6 multicast source.
VLAN VLAN associated with the IPv6 multicast source.
Port The slot and port number of the IPv6 multicast source.

Release History
Release 8.1.1; command introduced.

page 28-134 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ipv6 multicast source

Related Commands

ipv6 multicast static-group Creates a static MLD group entry on a specified port on a specified
VLAN.

MIB Objects
alaMldSourceTable
alaMldSourceVlan
alaMldSourceIfIndex
alaMldSourceGroupAddress
alaMldSourceHostAddress
alaMldSourceDestAddress
alaMldSourceOrigAddress
alaMldSourceType
alaMldSourceUpTime

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-135
show ipv6 multicast tunnel IP Multicast Switching Commands

show ipv6 multicast tunnel

Displays the IPv6 Multicast Switching and Routing tunneling table entries matching the specified IPv6
multicast group address, or all entries if no IPv6 multicast address is specified.
show ipv6 multicast tunnel [address]

Syntax Definitions

address IPv6 multicast group address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 multicast tunnel
Total 1 Tunnels
Ingress
Group Address Host Address Tunnel Address VLAN Port
----------------+--------------+---------------+-----+-----
ff05::6 4444::2 3333::2 1 2/1/1

output definitions
Group Address IPv6 group address of the IPv6 multicast tunnel.
Host Address IPv6 host address of the IPv6 multicast tunnel.
Tunnel Address IPv6 source tunnel address of the IPv6 multicast tunnel.
VLAN VLAN associated with the IPv6 multicast tunnel.
Port The slot and port number of the IPv6 multicast tunnel.

Release History
Release 8.1.1; command introduced.

page 28-136 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ipv6 multicast tunnel

Related Commands

show ipv6 multicast source Displays the IPv6 Multicast Switching and Routing source table entries
matching the specified IPv6 multicast group address or all entries if no
IPv6 multicast group address is specified

MIB Objects
alaMldTunnelTable
alaMldTunnelVlan
alaMldTunnelIfIndex
alaMldTunnelGroupAddress
alaMldTunnelHostAddress
alaMldTunnelDestAddress
alaMldTunnelOrigAddress
alaMldTunnelType
alaMldTunnelNextDestAddress
alaMldTunnelNextType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-137
show ipv6 multicast initial-packet-buffer IP Multicast Switching Commands

show ipv6 multicast initial-packet-buffer

Displays the status and configuration parameters of initial multicast packet buffer for IPv6 flows on the
switch.
show ipv6 multicast initial-packet-buffer

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 multicast initial-packet-buffer
Admin-status = disabled,
Max Packet = 4,
Max Flow = 32,
Timeout(seconds) = 10

output definitions
Admin-status The status of IPv6 initial multicast packet buffer.
Max Packet The maximum number of initial packets buffered per IPv6 multicast
flow.
Max Flow The maximum number of IPv6 multicast flows buffered for initial
packet buffering.
Timeout (seconds) The timeout value for the buffered IPv6 initial multicast packets in
seconds.

Release History
Release 8.2.1; command introduced.

page 28-138 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
IP Multicast Switching Commands show ipv6 multicast initial-packet-buffer

Related Commands

ipv6 multicast initial-packet- Enables or disables the initial packet buffering feature globally for IPv6
buffer admin-state multicast flows on the switch.
ipv6 multicast initial-packet- Configures the maximum number of initial packets buffered per IPv6
buffer max-packet multicast flow.
ipv6 multicast initial-packet- Configures the maximum number of IPv6 multicast flows buffered for
buffer max-flow initial packet.
ipv6 multicast initial-packet- Configures the timeout value for the buffered IPv6 initial multicast
buffer timeout packets.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 28-139
show ipv6 multicast initial-packet-buffer IP Multicast Switching Commands

page 28-140 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 29 DVMRP Commands

This chapter includes CLI command descriptions for Distance Vector Multicast Routing Protocol
(DVMRP), version 3.
DVMRPv3 is a dense-mode multicast routing protocol that enables routers to efficiently propagate IP
multicast traffic through a network. Multicast traffic consists of a data stream that originates from a single
source and is sent to hosts that have subscribed to that stream. Live video broadcasts, video conferencing,
corporate communications, distance learning, and distribution of software, stock quotes, and news services
are examples of multicast traffic.
For more information about configuring DVMRP, see the applicable OmniSwitch AOS Release 8
Advanced Routing Configuration Guide.
MIB information for the DVMRP commands is as follows:
Filename: AlcatelIND1Dvmrp.MIB
Module: ALCATEL-IND1-DVMRP-MIB
Filename: IETF_DVMRP_STD_DRAFT.MIB
Module: DVMRP-STD-MIB
A summary of the available commands is listed here:

ip load dvmrp
ip dvmrp admin-state
ip dvmrp flash-interval
ip dvmrp graft-timeout
ip dvmrp interface
ip dvmrp interface metric
ip dvmrp interface mbr-default-information
ip dvmrp neighbor-interval
ip dvmrp neighbor-timeout
ip dvmrp prune-lifetime
ip dvmrp prune-timeout
ip dvmrp report-interval
ip dvmrp route-holddown
ip dvmrp route-timeout
ip dvmrp subord-default
ip interface tunnel
show ip dvmrp
show ip dvmrp interface
show ip dvmrp neighbor
show ip dvmrp nexthop
show ip dvmrp prune
show ip dvmrp route
show ip dvmrp tunnel

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 29-1
ip load dvmrp DVMRP Commands

ip load dvmrp
Dynamically loads DVMRP to memory.
ip load dvmrp

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command must be executed before DVMRP can be configured on the switch. In addition, DVMRP
must be administratively enabled before you can run the protocol on the switch. For more information,
refer to the ip dvmrp admin-state command on page 29-3.

Examples
-> ip load dvmrp

Release History
Release 8.1.1; command was introduced.

Related Commands

ip dvmrp admin-state Globally enables or disables DVMRP protocol on the switch.

MIB Objects
alaDrcTmConfig
alaDrcTmIPDvmrpStatus

page 29-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DVMRP Commands ip dvmrp admin-state

ip dvmrp admin-state
Globally enables or disables DVMRP protocol on the switch.
ip dvmrp admin-state {enable | disable}

Syntax Definitions

enable Administratively enables DVMRP on the switch.

disable Administratively disables DVMRP on the switch.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command must be set to enable before DVMRP can run on the switch. In addition, the ip load
dvmrp command must be issued. For more information, refer to the ip load dvmrp command on
page 29-2.
• To enable or disable DVMRP for a particular interface, refer to the ip dvmrp interface command on
page 29-6.

Examples
-> ip dvmrp admin-state enable
-> ip dvmrp admin-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

ip dvmrp interface Enables or disables the DVMRP protocol on a specified interface.

ip load dvmrp Dynamically loads DVMRP to memory.
show ip dvmrp Displays global DVMRP parameters, including current status.

MIB Objects
alaDvmrpGlobalConfig
alaDvmrpAdminStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 29-3
ip dvmrp flash-interval DVMRP Commands

ip dvmrp flash-interval
Configures the minimum flash update interval value. The flash update interval defines how often routing
table change messages are sent to neighboring DVMRP routers.
ip dvmrp flash-interval seconds

Syntax Definitions

seconds Specifies the interval value, in seconds (5–86400).

Defaults

parameter default
seconds 5

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Because routing table change messages are sent between the transmission of complete routing tables, the
flash update interval value must be lower than the route report interval.

Examples
-> ip dvmrp flash-interval 5

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip dvmrp Displays global DVMRP parameters.

MIB Objects
alaDvmrpGlobalConfig
alaDvmrpFlashUpdateInterval

page 29-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DVMRP Commands ip dvmrp graft-timeout

ip dvmrp graft-timeout
Configures the graft message retransmission value. The graft message retransmission value is the duration
of time that the routing switch will wait before retransmitting a graft message if it has not received an
acknowledgement from its neighbor.
ip dvmrp graft-timeout seconds

Syntax Definitions

seconds Specifies the graft message retransmission value, in seconds (5–86400).

Defaults

parameter default
seconds 5

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip dvmrp graft-timeout 5

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip dvmrp Displays global DVMRP parameters.

MIB Objects
alaDvmrpGlobalConfig
alaDvmrpGraftRetransmission

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 29-5
ip dvmrp interface DVMRP Commands

ip dvmrp interface
Enables or disables the DVMRP protocol on a specified interface.
ip dvmrp interface {interface_name}
no ip dvmrp interface {interface_name}

Syntax Definitions

interface_name The name of the interface.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to delete an interface.

Examples
-> ip dvmrp interface vlan-10
-> no ip dvmrp interface vlan-10

Release History
Release 8.1.1; command was introduced.

Related Commands

ip dvmrp admin-state Globally enables or disables the DVMRP protocol on the switch.
ip dvmrp interface metric Configures the distance metric for an interface, which is used to cal-
culate distance vectors.
show ip dvmrp interface Displays information for all multicast-capable interfaces.

MIB Objects
dvmrpInterfaceTable
dvmrpInterfaceLocalAddress
dvmrpInterfaceStatus

page 29-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DVMRP Commands ip dvmrp interface metric

ip dvmrp interface metric

Configures the distance metric for an interface, which is used to calculate distance vectors. DVMRP uses
the distance metric value to determine the most cost-effective way to pass data through the network.
ip dvmrp interface interface_name metric value

Syntax Definitions

interface_name The name of the interface.

value Specifies the metric value (1–31).

Defaults

parameter default
value 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
DVMRP uses the distance metric value to determine the most cost-effective way to pass data through the
network. The higher the distance metric value, the higher the cost.

Examples
-> ip dvmrp interface vlan-2 metric 1

Release History
Release 8.1.1; command was introduced.

Related Commands

ip dvmrp interface Enables or disables the DVMRP protocol on a specified interface.

show ip dvmrp interface Displays the DVMRP interface table.

MIB Objects
dvmrpInterfaceTable
dvmrpInterfaceLocalAddress
dvmrpInterfaceMetric

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 29-7
ip dvmrp interface mbr-default-information DVMRP Commands

ip dvmrp interface mbr-default-information

Configures a DVMRP interface to advertise the default route for the interface. This command only applies
when the local switch is operating in the Multicast Border Router (MBR) mode.
ip dvmrp interface interface_name mbr-default-information {enable | disable}

Syntax Definitions

interface_name The name of the interface.

enable Enables advertisement of the default route on the specified interface.
disable Disables advertisement of the default route on the specified interface.

Defaults
By default, advertising the default route is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Advertising a default route on the DVMRP interface provides a method for ensuring that sources inside
the PIM domain can reach all routers inside the DVMRP domain.
• Make sure that the default route is not advertised on the MBONE.

Examples
-> ip dvmrp interface mbr-default-information enable
-> ip dvmrp interface mbr-default-information disable

Release History
Release 8.1.1; command was introduced.

Related Commands

ip dvmrp interface Enables or disables the DVMRP protocol on a specified interface.

show ip dvmrp interface Displays the DVMRP interface table.

MIB Objects
alaDvmrpIfAugTable
alaDvmrpIfMbrDefaultInfoStatus

page 29-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DVMRP Commands ip dvmrp neighbor-interval

ip dvmrp neighbor-interval
Configures the neighbor probe interval time. The neighbor probe interval time specifies how often probes
are transmitted on DVMRP-enabled interfaces.
ip dvmrp neighbor-interval seconds

Syntax Definitions

seconds Specifies the probe interval time, in seconds (5–30).

Defaults

parameter default
seconds 10

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip dvmrp neighbor-interval 10

Release History
Release 8.1.1; command was introduced.

Related Commands

ip dvmrp neighbor-timeout Configures the neighbor timeout.

show ip dvmrp neighbor Displays the DVMRP neighbor table.
show ip dvmrp Displays the global DVMRP parameters.

MIB Objects
alaDvmrpGlobalConfig
alaDvmrpNeighborProbeInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 29-9
ip dvmrp neighbor-timeout DVMRP Commands

ip dvmrp neighbor-timeout
Configures the neighbor timeout. This value specifies how long the switch will wait for activity from a
neighboring DVMRP router before assuming that the inactive router is down.
ip dvmrp neighbor-timeout seconds

Syntax Definitions

seconds Specifies the neighbor timeout, in seconds (5–86400).

Defaults

parameter default
seconds 35

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip dvmrp neighbor-timeout 35

Release History
Release 8.1.1; command was introduced.

Related Commands

ip dvmrp neighbor-interval Configures the neighbor probe interval time.

show ip dvmrp neighbor Displays the DVMRP neighbor table.
show ip dvmrp Displays the global DVMRP parameters.

MIB Objects
alaDvmrpGlobalConfig
alaDvmrpNeighborTimeout

page 29-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DVMRP Commands ip dvmrp prune-lifetime

ip dvmrp prune-lifetime
Indicates the length of time a prune will be in effect—i.e., its lifetime. When the prune lifetime expires, the
interface is joined back onto the multicast delivery tree. If unwanted multicast datagrams continue to
arrive, the prune mechanism will be re-initiated and the cycle will continue.
ip dvmrp prune-lifetime seconds

Syntax Definitions

seconds Specifies the prune lifetime, in seconds (180–86400).

Defaults

parameter default
seconds 7200

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip dvmrp prune-lifetime 7200

Release History
Release 8.1.1; command was introduced.

Related Commands

ip dvmrp prune-timeout Configures the prune packet retransmission value.

show ip dvmrp prune Displays DVMRP prune entries, including the router’s upstream
prune state.
show ip dvmrp Displays the global DVMRP parameters.

MIB Objects
alaDvmrpGlobalConfig
alaDvmrpPruneLifetime

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 29-11
ip dvmrp prune-timeout DVMRP Commands

ip dvmrp prune-timeout
Configures the prune packet retransmission value. This value is the duration of time that the routing switch
will wait if it continues to receive unwanted multicast traffic before retransmitting a prune message.
ip dvmrp prune-timeout seconds

Syntax Definitions

seconds Specifies retransmission time, in seconds (30–86400).

Defaults

parameter default
seconds 30

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip dvmrp prune-timeout 30

Release History
Release 8.1.1; command was introduced.

Related Commands

ip dvmrp prune-lifetime Indicates the length of time a prune will be in effect.

show ip dvmrp prune Displays DVMRP prune entries, including the router’s upstream
prune state.
show ip dvmrp Displays the global DVMRP parameters.

MIB Objects
alaDvmrpGlobalConfig
alaDvmrpPruneRetransmission

page 29-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DVMRP Commands ip dvmrp report-interval

ip dvmrp report-interval
Configures the route report interval. This value defines how often the switch will send its complete routing
table to neighboring routers running DVMRP.
ip dvmrp report-interval seconds

Syntax Definitions

seconds Specifies the report interval, in seconds (10–2000).

Defaults

parameter default
seconds 60

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip dvmrp report-interval 60

Release History
Release 8.1.1; command was introduced.

Related Commands

show ip dvmrp route Displays the DVMRP routes that are being advertised to other rout-
ers.
show ip dvmrp Displays the global DVMRP parameters.

MIB Objects
alaDvmrpGlobalConfig
alaDvmrpRouteReportInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 29-13
ip dvmrp route-holddown DVMRP Commands

ip dvmrp route-holddown
Configures the time during which DVMRP routes are kept in a hold down state. A holddown state refers to
the time that a route to an inactive network continues to be advertised.
ip dvmrp route-holddown seconds

Syntax Definitions

seconds Specifies the holddown time, in seconds (1–86400).

Defaults

parameter default
seconds 120

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip dvmrp route-holddown 120

Release History
Release 8.1.1; command was introduced.

Related Commands

ip dvmrp route-timeout Configures the route expiration timeout value.

show ip dvmrp Displays the global DVMRP parameters.
show ip dvmrp route Displays the DVMRP routes that are being advertised to other rout-
ers.

MIB Objects
alaDvmrpGlobalConfig
alaDvmrpRouteHoldDown

page 29-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DVMRP Commands ip dvmrp route-timeout

ip dvmrp route-timeout
Configures the route expiration timeout value. The route expiration timeout value specifies how long the
switch will wait before aging out a route. When the route expiration timeout expires, the route is
advertised as being in holddown until either its activity resumes or it is deleted from the route table.
ip dvmrp route-timeout seconds

Syntax Definitions

seconds Specifies the timeout value, in seconds (20–4000).

Defaults

parameter default
seconds 140

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip dvmrp route-timeout 140

Release History
Release 8.1.1; command was introduced.

Related Commands

ip dvmrp route-holddown Configures the time during which DVMRP routes are kept in a hold
down state.
show ip dvmrp Displays the global DVMRP parameters.

MIB Objects
alaDvmrpGlobalConfig
alaDvmrpRouteExpirationTimeout

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 29-15
ip dvmrp subord-default DVMRP Commands

ip dvmrp subord-default
Changes the initial default assumption on a neighbor's subordinate or non-subordinate status. When the
status value is true, DVMRP neighbors are assumed to be subordinate and traffic is automatically
forwarded to the neighbor upon initial discovery. When the value is false, traffic is not forwarded to the
neighbor until route reports have been exchanged and the neighbor has explicitly expressed dependency.
ip dvmrp subord-default {true | false}

Syntax Definitions

true DVMRP neighbors are assumed subordinate; traffic is automatically

forwarded to the neighbor on initial discovery.
false DVMRP neighbors are not assumed to be subordinate; traffic is not for-
warded until route reports have been exchanged and the neighbor has
explicitly expressed dependency.

Defaults

parameter default
true | false true

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• However, if neighbors in the DVMRP domain have difficulty handling large initial bursts of traffic, it
is recommended that the neighbor's default status as a suboridinate be changed to false.
• To view the current subordinate neighbor status, use the show ip dvmrp command. For more informa-
tion, refer to page 29-20.

Examples
-> ip dvmrp subord-default false

Release History
Release 8.1.1; command was introduced.

page 29-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DVMRP Commands ip dvmrp subord-default

Related Commands

show ip dvmrp Displays the global DVMRP parameters.

MIB Objects
alaDvmrpGlobalConfig
alaDvmrpInitNbrAsSubord

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 29-17
ip interface tunnel DVMRP Commands

ip interface tunnel
Configures the end points for the GRE and IPIP tunnels.
ip interface name tunnel [source ip_address] [destination ip_address] [protocol {ipip | gre}]
no ip dvmrp interface name

Syntax Definitions

name Text string up to 20 characters. Use quotes around string if description

contains multiple words with spaces between them (e.g. “Alcatel-Lucent
Marketing”). Note that this value is case sensitive.
source ip_address Source IP address of the tunnel.
destination ip_address Destination IP address of the tunnel.
ipip Specifies the tunneling protocol as IPIP.
gre Specifies the tunneling protocol as GRE.

Defaults

parameter default
ipip | gre ipip

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• You can configure an interface as either a vlan or tunnel interface.

• The maximum number of GRE tunnel interfaces that can be configured on a switch is 8.

• The maximum number of IPIP tunnel interfaces that can be configured on a switch is 127.

• Use the no form of this command to remove an IP interface.

Examples
-> ip interface “tnl-1” tunnel source 23.23.23.1 destination 155.2.2.2 protocol gre
-> ip interface “tnl-1” tunnel source 23.23.23.1 destination 155.2.2.2 protocol
ipip

Release History
Release 8.1.1; command introduced

page 29-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DVMRP Commands ip interface tunnel

Related Commands

show ip dvmrp interface Displays information for all multicast-capable interfaces or for a
specified interface. This command also provides options to display
only DVMRP-enabled or DVMRP-disabled interfaces.

MIB Objects
alaIpInterfaceTable
alaIpInterfaceName
alaIpInterfaceTunnelSrc
alaIpInterfaceTunnelDst
alaIpInterfaceDeviceType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 29-19
show ip dvmrp DVMRP Commands

show ip dvmrp
Displays the global DVMRP parameters configuration.
show ip dvmrp

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip dvmrp
DVMRP Admin Status = enabled,
Flash Interval = 5,
Graft Timeout = 5,
Neighbor Interval = 10,
Neighbor Timeout = 35,
Prune Lifetime = 7200,
Prune Timeout = 30,
Report Interval = 60,
Route Holddown = 120,
Route Timeout = 140,
Subord Default = true,
BFD status = disabled,
MBR Operational Status = enabled,

Number of Routes = 3,
Number of Reachable Routes = 3

output definitions
DVMRP Admin Status The current global (i.e., switch-wide) status of DVMRP, which can be
enabled or disabled. To change the current DVMRP global status, use
the ip dvmrp admin-state command.
Flash Interval The current minimum flash update interval value, in seconds. The flash
interval defines how often routing table change messages are sent to
neighboring DVMRP routers. Because routing table change messages
are sent between the transmission of complete routing tables, the flash
update interval must be shorter than the route report interval. The
default value is 5.

page 29-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DVMRP Commands show ip dvmrp

output definitions (continued)

Graft Timeout The graft message retransmission value, in seconds. The graft message
retransmission value defines the duration of time that the routing switch
will wait before retransmitting a graft message if it has not received an
acknowledgement from its neighbor. Values may range from 5–86400.
The default value is 5.
Neighbor Interval The current neighbor probe interval time, in seconds. The neighbor
probe interval time specifies how often probes are transmitted to inter-
faces with attached DVMRP neighbors. Values may range from 5–30.
The default value is 10.
Neighbor Timeout The current neighbor timeout value, in seconds. This value specifies
how long the routing switch will wait for activity from a neighboring
DVMRP router before assuming the inactive router is down. Values
may range from 5–86400. The default value is 35.
Prune Lifetime The length of time, in seconds, a prune will be in effect. When the
prune lifetime expires, the interface is joined back onto the multicast
delivery tree. If unwanted multicast datagrams continue to arrive, the
prune mechanism will be re-initiated and the cycle will continue. Val-
ues may range from 180–86400. The default value is 7200.
Prune Timeout The current prune packet retransmission value, in seconds. This value
indicates the duration of time that the routing switch will wait if it con-
tinues to receive unwanted multicast traffic before retransmitting a
prune message. Values range from 30–86400. The default value is 30.
Report Interval The current route report interval, in seconds. The route report interval
defines how often routers will send their complete routing tables to
neighboring routers running DVMRP. Values may range from 10–2000.
The default value is 60.
Route Holddown The current holddown time, in seconds. This value indicates the time
during which DVMRP routes are kept in a holddown state. A holddown
state refers to the time that a route to an inactive network continues to
be advertised. Values may range from 1–120. The default value is 120.
Route Timeout The current route expiration timeout value, in seconds. The route expi-
ration timeout value specifies how long the routing switch will wait
before aging out a route. Values may range from 20–4000. The default
value is 140.
Subord Default Displays the initial default assumption on a neighbor's subordinate or
non-subordinate status. When the status value is true, DVMRP neigh-
bors are assumed to be subordinate and traffic is automatically for-
warded to the neighbor upon initial discovery. When the value is false,
traffic is not forwarded to the neighbor until route reports have been
exchanged and the neighbor has explicitly expressed dependency. To
change the current subordinate neighbor status, use the ip dvmrp sub-
ord-default command. Options include true and false. The default
value is true.
BFD Status Not supported in the current release.
MBR Operational Status Indicates whether or not DVMRP interaction with PIM is enabled or
disabled on a MBR switch. MBR functionality is not operationally
active until both PIM and DVMRP have at least one enabled and active
interface.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 29-21
show ip dvmrp DVMRP Commands

output definitions (continued)

Number of Routes The number of entries in the routing table. This number can be used to
monitor the routing table size and detect illegal advertisements of uni-
cast routes.
Number of Reachable Routes The total number of reachable routes. The number of entries in the rout-
ing table with non-infinite metrics. This number can be used to detect
network partitions by observing the ratio of reachable routes to total
routes. Routes with unreachable metrics, routes in a holddown state,
and routes that have aged out are not considered reachable.

Release History
Release 8.1.1; command was introduced.

Related Commands

ip dvmrp admin-state Globally enables or disables DVMRP protocol on the switch.

ip dvmrp flash-interval Configures the minimum flash update interval value.
ip dvmrp graft-timeout Configures the graft message retransmission value.
ip dvmrp neighbor-timeout Configures the neighbor timeout.
ip dvmrp prune-lifetime Indicates the length of time a prune will be in effect.
ip dvmrp prune-timeout Configures the prune packet retransmission value.
ip dvmrp report-interval Configures the route report interval.
ip dvmrp route-holddown Configures the time during which DVMRP routes are kept in a hold
down state.
ip dvmrp route-timeout Configures the route expiration timeout value.
ip dvmrp subord-default Configures the neighbor probe interval time.

MIB Objects
alaDvmrpConfigMIBGroup
alaDvmrpAdminStatus
alaDvmrpRouteReportInterval
alaDvmrpFlashUpdateInterval
alaDvmrpNeighborTimeout
alaDvmrpRouteExpirationTimeout
alaDvmrpRouteHoldDown
alaDvmrpNeighborProbeInterval
alaDvmrpPruneLifetime
alaDvmrpPruneRetransmission
alaDvmrpGraftRetransmission
alaDvmrpInitNbrAsSubord
dvmrpGeneralGroup
dvmrpNumRoutes
dvmrpReachableRoutes

page 29-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DVMRP Commands show ip dvmrp interface

show ip dvmrp interface

Displays information for all multicast-capable interfaces or for a specified interface. This command also
provides options to display only DVMRP-enabled or DVMRP-disabled interfaces.
show ip dvmrp interface [ip_address | interface_name | enabled | disabled]

Syntax Definitions

ip_address Specifies a particular interface IP address.

interface_name The name of the interface.
enabled Displays a list of all interfaces (i.e., VLAN router ports) on which
DVMRP is currently enabled.
disabled Displays a list of all interfaces (i.e., VLAN router ports) on which
DVMRP is currently disabled.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If no optional syntax is specified in the command line, the entire interface table is displayed.

• For an interface to show as enabled in the show ip dvmrp interface or show ip dvmrp interface
enabled output, the interface must be both administratively and operationally enabled. Although the
interface does not have to be passing traffic, at least one VLAN router port must be operational on the
corresponding DVMRP-enabled VLAN.
• To view the Generation ID being used on a particular interface, you must include the interface IP
address in the command line.

Examples
-> show ip dvmrp interface

Total 4 Interfaces

Interface Name Vlan Metric Admin-Status Oper-Status BFD-Status MBR-Default

-------------------+-----+------+-------------+-------------+----------+-----------
vlan-4 4 1 Disabled Disabled Disabled Disabled
vlan-6 6 1 Enabled Enabled Disabled Enabled

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 29-23
show ip dvmrp interface DVMRP Commands

-> show ip dvmrp interface enabled

Total 1 Interfaces

Interface Name Vlan Metric Admin-Status Oper-Status BFD-Status MBR-Default

-------------------+-----+------+-------------+-------------+----------+-----------
vlan-6 6 1 Enabled Enabled Disabled Enabled

output definitions
Interface Name The name of the interface.
Vlan The associated VLAN ID.
Tunnel Indicates whether there is a DVMRP tunnel currently configured on the
interface.
Metric The current metric value. A metric is essentially used to determine the
most cost-effective way to pass data through the network. The higher
the metric value, the higher the cost.
Admin-Status The current administrative status of the corresponding interface.
Options include Enabled or Disabled. An interface can be configured
for DVMRP without being operational. To change the DVMRP Admin-
status for an individual interface, refer to the ip dvmrp interface com-
mand.
Oper-Status The current operational status of the corresponding multicast-capable
interface. Options include Enabled or Disabled. For an interface to be
DVMRP-operational, the global DVMRP status must be enabled and
the individual interface must be DVMRP-enabled. To change the global
DVMRP status, refer to the ip dvmrp admin-state command.
BFD-Status Nost supported in the current release.
MBR-Default Whether or not the DVMRP interface will advertise a default route
when the interface is configured on a Multicast Border Router. Options
include Enabled or Disabled. Configured through the ip dvmrp inter-
face mbr-default-information command.

Release History
Release 8.1.1; command was introduced.

Related Commands

ip dvmrp interface Enables or disables the DVMRP protocol on a specified interface.

MIB Objects
dvmrpInterfaceGroup
dvmrpInterfaceLocalAddress
dvmrpInterfaceMetric
dvmrpInterfaceStatus
alaDvmrpIfAugTable
alaDvmrpIfMbrDefaultInfoStatus

page 29-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DVMRP Commands show ip dvmrp neighbor

show ip dvmrp neighbor

Displays the DVMRP neighbor table. The DVMRP neighbor table displays either all neighboring
DVMRP routers, or a specified neighboring DVMRP router.
show ip dvmrp neighbor [ip_address]

Syntax Definitions

ip_address Specifies a particular IP address for a neighboring DVMRP router.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If a neighbor IP address is not specified, the entire DVMRP Neighbor Table is displayed.

Examples
-> show ip dvmrp neighbor

Neighbor Address Intf Name Uptime Expires GenID Vers State

----------------+-------------+-----------+-----------+----------+------+-------
143.209.92.214 vlan-2 00h:09m:12s 00h:00m:06s 546947509 3.255 active

output definitions
Neighbor Address The 32-bit IP address of the DVMRP neighbor’s router interface.
Itnf Name The interface name of the neighbor’s router.
Uptime The amount of time the neighbor has been running, displayed in hours,
minutes, and seconds.
Expires The amount of time remaining before the neighbor expires, displayed in
hours, minutes, and seconds.
GenID The generation ID for the DVMRP neighbor. This value is used by
neighboring routers to detect whether the DVMRP routing table should
be resent.
Version The DVMRP version number for the neighbor.
State The current state of the DVMRP neighbor. Options include active and
down.

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 29-25
show ip dvmrp neighbor DVMRP Commands

Related Commands

ip dvmrp neighbor-interval Configures the neighbor probe interval time.

ip dvmrp neighbor-timeout Configures the neighbor timeout.

MIB Objects
dvmrpNeighborTable
dvmrpNeighborAddress
dvmrpNeighborIfIndex
dvmrpNeighborUpTime
dvmrpNeighborExpiryTime
dvmrpNeighborGenerationId
dvmrpNeighborMajorVersion
dvmrpNeighborMinorVersion
dvmrpNeighborState

page 29-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DVMRP Commands show ip dvmrp nexthop

show ip dvmrp nexthop

Displays DVMRP next hop entries. This command is used to show the list of next hops on outgoing
interfaces to which IP multicast datagrams from particular sources are routed.
show ip dvmrp nexthop [ip_address ip_mask]

Syntax Definitions

ip_address Specifies a source IP address for which DVMRP next hop entries will be
displayed.
ip_mask Specifies a source IP mask for which DVMRP next hop entries will be
displayed.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If an IP address and IP mask are not specified, the entire DVMRP Next Hop table is displayed.

Examples
-> show ip dvmrp nexthop 172.22.2.115 255.255.255.0

Src Address/Mask Interface Name Vlan Hop Type

--------------------+--------------------+-------+----------

172.22.2.115/24 vlan-2 2 branch

output definitions
Src Address/Mask The 32-bit source IP address, along with the mask length, shown in bits.
The source IP address and mask are separated by a slash ( / ).
Interface Name The name of the interface.
Vlan The associated VLAN ID.
Hop Type The hop type of the associated entry (leaf or branch). If the next hop
VLAN has a DVMRP neighbor attached to it, the hop type will be dis-
played as branch.

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 29-27
show ip dvmrp nexthop DVMRP Commands

Related Commands
N/A

MIB Objects
dvmrpRouteNextHopTable
dvmrpRouteNextHopSource
dvmrpRouteNextHopSourceMask
dvmrpRouteNextHopIfIndex
dvmrpRouteNextHopType

page 29-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DVMRP Commands show ip dvmrp prune

show ip dvmrp prune

Displays DVMRP prune entries that have been sent upstream.
show ip dvmrp prune [group_address source_address source_mask]

Syntax Definitions

group_address Specifies a pruned group address.

source_address Specifies a source IP address.
source_mask Specifies a source IP mask.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If a group address, source address, and source mask are not specified, the entire Prune table is displayed.

Examples
-> show ip dvmrp prune

Group Address Source Address/Mask Expires

-----------------+---------------------+-------------
224.0.0.4 143.209.92.14/24 00h:00m:30s

output definitions
Group Address The 32-bit multicast group address.
Source Address/Mask The 32-bit source IP address, along with the mask length, shown in bits.
The source IP address and mask are separated by a slash ( / ).
Expires The amount of time remaining before the current prune state expires,
displayed in hours, minutes, and seconds.

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 29-29
show ip dvmrp prune DVMRP Commands

Related Commands

ip dvmrp prune-lifetime Indicates the length of time a prune will be in effect.

ip dvmrp prune-timeout Configures the prune packet retransmission value.

MIB Objects
dvmrpPruneTable
dvmrpPruneGroup
dvmrpPruneSource
dvmrpPruneSourceMask
dvmrpPruneExpiryTime

page 29-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DVMRP Commands show ip dvmrp route

show ip dvmrp route

Displays the DVMRP routes that are being advertised to other routers.
show ip dvmrp route [ip_address ip_mask]

Syntax Definitions

ip_address The 32-bit source IP address representing route(s).

ip_mask A 32-bit number that determines the subnet mask for the IP address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If a source IP address and IP mask are not specified, the entire DVMRP route table is displayed.

Examples
-> show ip dvmrp route
Legends: Flags: L = Local, R = Remote, F = Flash, H = Holddown, I = Invalid
Address/Mask Gateway Metric Age Expires Flags
-------------------+------------------+------+-----------+---------+-----
11.0.0.0/8 55.0.0.5 2 00h:13m:14s 02m:07s R
22.0.0.0/8 44.0.0.4 2 00h:33m:14s 02m:15s R
44.0.0.0/8 - 1 05h:24m:59s - L
55.0.0.0/8 - 1 05h:24m:59s - L
66.0.0.0/8 44.0.0.4 2 00h:03m:11s 02m:15s R

output definitions
Address/Mask The 32-bit IP address for the router interface, along with the corre-
sponding subnet mask. The interface’s subnet mask is shown using the
CIDR prefix length: 255.0.0.0 equals /8; 255.255.0.0 equals /16;
255.255.255.0 equals /24, etc.
Gateway The corresponding 32-bit gateway address. Because it is not applicable,
no gateway address is displayed for local routes.
Metric The current metric value. A metric is essentially used to determine the
most cost-effective way to pass data through the network. The higher
the metric value, the higher the cost.
Age The current age of the DVMRP route, displayed in hours, minutes, and
seconds.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 29-31
show ip dvmrp route DVMRP Commands

output definitions (continued)

Expires The expiration time for the corresponding route. Because it is not appli-
cable, no expiration time is displayed for local routes.
Flags The flag type of a particular DVMRP route. Options include L (Local),
R (Remote), F (Flash), H (Holddown), and I (Invalid).

Release History
Release 8.1.1; command was introduced.

Related Commands

ip dvmrp report-interval Configures the route report interval.

ip dvmrp route-holddown Configures the time during which DVMRP routes are kept in a hold
down state.
ip dvmrp route-timeout Configures the route expiration timeout value.

MIB Objects
dvmrpRouteTable
dvmrpRouteSource
dvmrpRouteSourceMask
dvmrpRouteMetric
dvmrpRouteExpiryTime
dvmrpRouteUpTime

page 29-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
DVMRP Commands show ip dvmrp tunnel

show ip dvmrp tunnel

Displays DVMRP tunnel entries.
show ip dvmrp tunnel [local_address remote_address]

Syntax Definitions

local_address The IP address of a particular local router interface. The local router
interface IP address is an identifier for the local end of the DVMRP tun-
nel.
remote_mask The IP address of a particular remote router interface. The remote router
interface IP address is an identifier for the remote end of the DVMRP
tunnel.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If optional local and remote IP address information is not specified, entire DVMRP Tunnels table is
displayed.
• The local IP address of the tunnel must match the IP address of an existing DVMRP-enabled IP inter-
face.

Examples
-> show ip dvmrp tunnel

Interface Name Local Address Remote Address TTL Status

-------------------+-----------------+-----------------+-----+----------
vlan-2 143.209.92.203 12.0.0.1 255 Enabled

output definitions
Interface Name The interface name.
Local Address The 32-bit local IP address for the DVMRP tunnel.
Remote Address The 32-bit remote IP address for the DVMRP tunnel.
TTL The current Time to Live (TTL) value. A value of 0 indicates that the
value is copied from the payload’s header. Values may range from 0–
255.
Status The corresponding interface status. Options include Enabled or Dis-
abled. If the interface specified by the local address has been config-
ured and is operationally enabled, the status is Enabled. If the interface
is down, the value displayed is Disabled.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 29-33
show ip dvmrp tunnel DVMRP Commands

Release History
Release 8.1.1; command was introduced.

Related Commands

ip interface tunnel Adds or deletes a DVMRP tunnel.

show ip dvmrp Configures the TTL value for the tunnel defined for the specified
local address and remote address.

MIB Objects
tunnelIfTable
tunnelIfLocalAddress
tunnelIfRemoteAddress
tunnelIfHopLimit
dvmrpInterfaceGroup
dvmrpInterfaceStatus

page 29-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 30 PIM Commands

Protocol-Independent Multicast (PIM) is an IP multicast routing protocol that uses routing information
provided by unicast routing protocols, such as RIP and OSPF. Note that PIM is not dependent on any
particular unicast routing protocol. Sparse mode PIM (PIM-SM) contrasts with flood-and-prune dense
mode multicast protocols, such as DVMRP and PIM Dense Mode (PIM-DM), in that multicast forwarding
in PIM-SM is initiated only through specific requests.
Downstream routers must explicitly join PIM-SM distribution trees to receive multicast streams on behalf
of directly connected receivers or other downstream PIM-SM routers. This paradigm of receiver-initiated
forwarding makes PIM ideal for network environments where receiver groups are thinly populated and
bandwidth conservation is a concern, such as in wide area networks (WANs). PIM-DM uses RPF (Reverse
Path Forwarding) to prevent looping of multicast datagrams while flooding. If some areas of the network
do not have group members, PIM-DM will prune the forwarding branch by instantiating the prune state.
PIM-DM differs from PIM-SM in two essential ways:
• There are no periodic joins transmitted, only explicitly triggered prunes and grafts.

• There is no Rendezvous Point (RP). This is particularly important in networks that cannot tolerate a
single point of failure.
Alcatel-Lucent implementation of PIM can also be configured in an IPv6 environment.
MIB information for the PIM commands is as follows:
Filename: ALCATEL-IND1-PIM-MIB.mib
Module: alcatelIND1PIMMIB
Filename: PIM-BSR-MIB.mib
Module: pimBsrMIB
Filename: PIM-STD-MIB.mib
Module: pimStdMIB

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-1
 PIM Commands

A summary of the available commands is listed here:

ip load pim show ip pim static-rp

ip pim sparse admin-state show ip pim cbsr
ip pim dense admin-state show ip pim bsr
ip pim ssm group show ip pim notifications
ip pim dense group show ip pim groute
ip pim cbsr show ip pim sgroute
ip pim static-rp ipv6 pim sparse admin-state
ip pim candidate-rp ipv6 pim sparse admin-state
ip pim rp-threshold ipv6 pim sparse admin-state
ip pim keepalive-period ipv6 pim dense admin-state
ip pim max-rps ipv6 pim ssm group
ip pim probe-time ipv6 pim dense group
ip pim register checksum ipv6 pim cbsr
ip pim register-suppress-timeout ipv6 pim static-rp
ip pim spt admin-state ipv6 pim candidate-rp
ip pim state-refresh-interval ipv6 pim rp-switchover
ip pim state-refresh-limit ipv6 pim spt admin-state
ip pim state-refresh-ttl ipv6 pim interface
ip pim interface show ipv6 pim sparse
ip pim neighbor-loss-notification- show ipv6 pim dense
period show ipv6 pim ssm group
ip pim invalid-register-notification- show ipv6 pim dense group
period show ipv6 pim interface
ip pim invalid-joinprune-notification- show ipv6 pim neighbor
period show ipv6 pim static-rp
ip pim rp-mapping-notification-period show ipv6 pim group-map
ip pim interface-election-notification- show ipv6 pim candidate-rp
period show ipv6 pim cbsr
ip pim mbr all-sources show ipv6 pim bsr
ip pim bfd-state show ipv6 pim groute
ip pim bfd-state all-interfaces show ipv6 pim sgroute
ip pim interface bfd-state
ip pim mofrr-state
ip pim mofrr-state all-routes
show ip pim sparse
show ip pim dense
show ip pim ssm group
show ip pim dense group
show ip pim neighbor
show ip pim candidate-rp
show ip pim group-map
show ip pim interface

page 30-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip load pim

ip load pim
Dynamically loads PIM to memory.
ip load pim

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command must be executed before PIM can run on the switch.

• This command is supported in both IPv4 and IPv6 PIM.

• The advanced routing image file must be loaded to flash before the feature will start to work on the
switch.

Examples
-> ip load pim

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-3
ip load pim PIM Commands

Related Commands

ip pim sparse admin-state Globally enables or disables the PIM-SM protocol on the switch.
show ip pim sparse Displays the status of the various global parameters for the PIM
sparse mode.
ip pim dense admin-state Globally enables or disables PIM-DM protocol on the switch.
show ip pim dense Displays the status of the various global parameters for the PIM
Dense mode.
ipv6 pim sparse admin-state Enables or disables the IPv6 PIM-SM (sparse mode) globally for
IPv6.
show ipv6 pim sparse Displays the status of the various global parameters for the IPv6
PIM sparse mode.
ipv6 pim dense admin-state Enables or disables the IPv6 PIM-DM (dense mode) globally for
IPv6.
show ipv6 pim dense Displays the status of the various global parameters for the IPv6
PIM dense mode.

MIB Objects
alaDrcTmConfig
alaDrcTmIPPimStatus

page 30-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim sparse admin-state

ip pim sparse admin-state

Globally enables or disables PIM-SM protocol on the switch.
ip pim sparse admin-state {enable | disable}

Syntax Definitions

enable Globally enables PIM-SM on the switch.

disable Globally disables PIM-SM on the switch.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command must be set to enable before PIM-SM can run on the switch. In addition, the ip load
pim command must be executed. Refer to page 30-3 for more information.
• The advanced routing image file must be loaded to flash before the feature will start to work on the
switch.

Examples
-> ip pim sparse admin-state enable
-> ip pim sparse admin-state disable

Release History
Release 8.1.1; command introduced.

Related Commands

ip pim interface Enables or disables the PIM protocol on a specific interface.

ip load pim Dynamically loads PIM to memory.
show ip pim sparse Displays the status of the various global parameters for the PIM
sparse mode.

MIB Objects
alaPimsmGlobalConfig
alaPimsmAdminStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-5
ip pim dense admin-state PIM Commands

ip pim dense admin-state

Globally enables or disables PIM-DM protocol on the switch.
ip pim dense admin-state {enable | disable}

Syntax Definitions

enable Globally enables PIM-DM on the switch.

disable Globally disables PIM-DM on the switch.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command must be set to enable before PIM-DM can run on the switch. In addition, the ip load
pim command must be executed. Refer to page 30-3 for more information.
• The advanced routing image file must be loaded to flash before the feature will start to work on the
switch.

Examples
-> ip pim dense admin-state enable
-> ip pim dense admin-state disable

Release History
Release 8.1.1; command introduced.

Related Commands

ip pim interface Enables or disables the PIM protocol on a specific interface.

ip load pim Dynamically loads PIM to memory.
show ip pim dense Displays the status of the various global parameters for the PIM
dense mode.

MIB Objects
alaPimdmGlobalConfig
alaPimdmAdminStatus

page 30-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim ssm group

ip pim ssm group

Statically maps the specified IP multicast group to the PIM Source Specific Multicast mode (SSM).
ip pim ssm group group_address/prefix_length [[no] override] [priority priority]
no ip pim ssm group group_address/prefix_length

Syntax Definitions

group_address Specifies a 32-bit group address.

/prefix_length Specifies the prefix length of the multicast group.
override Specifies the static SSM mode mapping configuration to override the
dynamically learned group mapping information for the specified group.
priority Specifies the preference value to be used for this static SSM mode
configuration and provides fine control over which configuration is
overridden by this static configuration. Values may range from 0 to 128.

Defaults
By default, the priority option is not set and the override option is set to false.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a static configuration of a SSM mode group mapping.

• The PIM Source-Specific Multicast (SSM) mode for the default SSM address range (232.0.0.0 through
232.255.255.255) reserved by the Internet Assigned Numbers Authority is not enabled automatically
and needs to be configured manually to support SSM.
• You can also map additional multicast address ranges for the SSM group using this command.
However, the multicast groups in the reserved address range can be mapped only to the SSM mode.
• If the group prefixes configured for two or more rows in this table overlap, the row with the greatest
prefix length value is used for the overlapping range.
• Specifying the priority value obsoletes the override option.

• Note that once the priority option has been defined, a value of 65535 can be used to un-set the priority

Examples
-> ip pim ssm group 224.0.0.0/4 priority 50

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-7
ip pim ssm group PIM Commands

Related Commands

show ip pim sparse Displays the status of the various global parameters for the PIM
sparse mode.
show ip pim ssm group Displays the static configuration of multicast group mappings for
the PIM-Source Specific Multicast (SSM) mode.
show ip pim group-map Displays the PIM group mapping table.

MIB Objects
alaPimStaticRPTable
alaPimStaticRPGrpAddress
alaPimStaticRPGrpPrefixLength
alaPimStaticRPOverrideDynamic
alaPimStaticRPPrecedence
alaPimStaticRPRowStatus

page 30-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim dense group

ip pim dense group

Statically maps the specified IP multicast group to the PIM Dense mode (DM).
ip pim dense group group_address/prefix_length [[no] override] [priority priority]
no ip pim dense group group_address/prefix_length

Syntax Definitions

group_address Specifies a 32-bit group address.

/prefix_length Specifies the prefix length of the multicast group.
override Specifies this static Dense mode mapping configuration to override the
dynamically learned group mapping information for the specified group.
priority Specifies the preference value to be used for this static configuration and
provides fine control over which configuration is overridden by this
static configuration. Values may range from 0 to 128.

Defaults
By default, the priority option is not set and the override option is set to false.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a static configuration of a dense mode group mapping.

• This command specifies the mode as Dense (PIM-DM) for the specified multicast group address.

• If the group prefixes configured for two or more rows in this table overlap, the row with the greatest
prefix length value is used for the overlapping range
• Specifying the priority value obsoletes the override option and once the priority option has been
defined, a value of 65535 can be used to un-set the priority.

Examples
-> ip pim dense group 224.0.0.0/4 priority 50

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-9
ip pim dense group PIM Commands

Related Commands

show ip pim dense Displays the status of the various global parameters for the PIM
dense mode.
show ip pim dense group Displays the static configuration of multicast group mappings for
PIM-Dense Mode (DM).
show ip pim group-map Displays the PIM group mapping table.

MIB Objects
alaPimStaticRPTable
alaPimStaticRPGrpAddress
alaPimStaticRPGrpPrefixLength
alaPimStaticRPOverrideDynamic
alaPimStaticRPPrecedence
alaPimStaticRPRowStatus

page 30-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim cbsr

ip pim cbsr
Configures the local router as the Candidate-BSR for the PIM domain.
ip pim cbsr ip_address [priority priority] [mask-length bits]
no ip pim cbsr ip_address

Syntax Definitions

ip_address Specifies the 32-bit address that the local router uses to advertise itself
as a Candidate-BSR.
priority Specifies the priority value of the local router as a Candidate-BSR. The
higher the value, the higher the priority. Values may range from 0 to
255.
bits Specifies a 32-bit mask length that is advertised in the bootstrap
messages (the length of the mask is used in the hash function when
computing the Rendezvous Point (RP) for a multicast group).Values
may range from 1 to 32.

Defaults

parameter default
priority 64
bits 30

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the local routers candidature as the BSR.

• This command is supported only in the sparse mode.

• The information configured using this command is used in the Bootstrap messages.

• Candidate-BSRs also avoid a single point of failure in a PIM domain.

Examples
-> ip pim cbsr 50.1.1.1 priority 100 mask-length 4

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-11
ip pim cbsr PIM Commands

Related Commands

show ip pim cbsr Displays the Candidate-BSR information that is used in the
Bootstrap messages.

MIB Objects
alaPimBSrCandidateBSRTable
alaPimBsrCandidateBSRAddress
alaPimBsrCandidateBSRPriority
alaPimBsrCandidateBSRHashMaskLength
alaPimBsrCandidateBSRRowStatus

page 30-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim static-rp

ip pim static-rp
Adds, modifies, or deletes a static RP for a group (“modifies” applies only to the RP address, since the
table is indexed from group address and mask parameters).
ip pim static-rp group_address/prefix_length rp_address [[no] override] [priority priority]
no ip pim static-rp group_address/prefix_length rp_address

Syntax Definitions

group_address Specifies a 32-bit group address.

/prefix_length Specifies the prefix length of the multicast group.
rp_address Specifies a 32-bit Rendezvous Point (RP) address.
override Specifies this static RP configuration to override the dynamically
learned RP information for the specified group.
priority Specifies the preference value to be used for the static RP configuration
and provides fine control over which configuration is overridden by this
static configuration. Values may range from 0 to 128.

Defaults
By default, the priority option is not set and the override option is set to false.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete a static RP configuration.

• Specifying the priority value obsoletes the override option.

• The PIM Source-Specific Multicast (SSM) mode for the default SSM address range (232.0.0.0 through
232.255.255.255) reserved by the Internet Assigned Numbers Authority is not enabled automatically
and must be configured manually to support SSM. You can also map additional multicast address
ranges for the SSM group. However, the multicast groups in the reserved address range can be mapped
only to the SSM mode.
• This command is supported only in the sparse mode.

• If the group prefixes configured for two or more rows in this table overlap, the row with the greatest
prefix length value is used for the overlapping range
• Note that once the priority option has been defined, a value of 65535 can be used to un-set the priority

• To view current static RP configuration settings, use the show ip pim static-rp command.

Examples
-> ip pim static-rp 224.0.0.0/4 10.1.1.1 priority 10

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-13
ip pim static-rp PIM Commands

Release History
Release 8.1.1; command introduced.

Related Commands

show ip pim sparse Displays the status of the various global parameters for the PIM
sparse mode.
show ip pim static-rp Displays the PIM static RP table for ASM mode, which includes
group address/prefix length, the static Rendezvous Point (RP)
address, and the current status of static RP configuration (i.e.,
enabled or disabled).
show ip pim group-map Displays the PIM group mapping table.

MIB Objects
alaPimStaticRPTable
alaPimStaticRPGrpAddress
alaPimStaticRPGrpPrefixLength
alaPimStaticRPRPAddress
alaPimStaticRPOverrideDynamic
alaPimStaticRPPrecedence
alaPimStaticRPRowStatus

page 30-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim candidate-rp

ip pim candidate-rp
Configures the local router as the Candidate-Rendezvous Point (C-RP) for a specified IP multicast group.
ip pim candidate-rp rp_address group-address/prefix_length [priority priority] [interval seconds]
no ip pim candidate-rp rp_address group-address/prefix_length

Syntax Definitions

rp_address Specifies a 32-bit address that will be advertised as a Candidate-RP.

group_address Specifies a 32-bit group address for which the local router will advertise
itself as a Candidate-RP.
/prefix_length Specifies the prefix length of the multicast group.
priority Specifies the priority value of the Candidate-RP. Values may range
from 0 to 192. The lower the value, the higher the priority.
seconds Specifies the interval at which the C-RP advertisements are sent to the
bootstrap router, in seconds. Values may range from 1 to 300.

Defaults

parameter default
priority 192
seconds 60

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the association of the device as a C-RP for a particular
multicast group.
• The specified rp_address must belong to a PIM enabled interface.

• Only one RP address is supported per switch. If multiple candidate-RP entries are defined, they must
specify the same rp-address.
• The priority and the interval values are used by the switch. If they are modified for one entry, the
switch will modify these for all the candidate-rp entries.
• This command is supported only in the sparse mode.

Examples
-> ip pim candidate-rp 50.1.1.1 224.0.0.0/4 priority 100 interval 100

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-15
ip pim candidate-rp PIM Commands

Release History
Release 8.1.1; command introduced.

Related Commands

show ip pim candidate-rp Displays the IP multicast groups for which the local router will
advertise itself as a Candidate-RP.

MIB Objects
alaPimBsrCandidateRPTable
alaPimBsrCandidateRPAddress
alaPimBsrCandidateRPGroupAddress
alaPimBsrCandidateRPGroupPrefixLength
alaPimBsrCandidateRPPriority
alaPimBsrCandidateRPAdvInterval
alaPimBsrCandidateRPRowStatus

page 30-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim rp-threshold

ip pim rp-threshold
Specifies the data rate, in bits per second (bps), at which the Rendezvous Point (RP) will attempt to switch
to native forwarding by issuing a source-specific (S, G) Join message toward the source.
ip pim rp-threshold bps

Syntax Definitions

bps The data rate value, in bits per second, at which the RP will attempt to
switch to native forwarding (0–2147483647).

Defaults

parameter default
bps 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is supported only in the sparse mode.

• To disable the RP threshold feature, specify a bits per second value of 0. When the RP threshold is
disabled, the RP will never initiate an (S, G) Join message toward the source; the packets will be
register-encapsulated to the RP. It will issue a (S, G) Join message upon receiving the first data packet,
if its bits per second value is 1.
• To view the current RP threshold, use the show ip pim sparse command.

Examples
-> ip pim rp-threshold 131072

Release History
Release 8.1.1; command introduced.

Related Commands

show ip pim sparse Displays the global parameters for PIM sparse mode.

MIB Objects
alaPimsmGlobalConfig
alaPimsmRPThreshold

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-17
ip pim keepalive-period PIM Commands

ip pim keepalive-period
Configures the period during which the (S,G) Join state will be maintained in the absence of (S,G) Join
messages or explicit (S,G) local membership.
ip pim keepalive-period seconds

Syntax Definitions

seconds Specifies the timeout value, in seconds (0-65535).

Defaults

parameter default
seconds 210

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This timer is called the Keepalive Period in the PIM-SM specification and the Source Lifetime in the
PIM-DM specification.
• This command includes support for both IPv4 PIM and IPv6 PIM.

Examples
-> ip pim keepalive-period 500

Release History
Release 8.1.1; command introduced.

page 30-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim keepalive-period

Related Commands

show ip pim sparse Displays the status of the various global parameters for the PIM
sparse mode.
show ip pim dense Displays the status of the various global parameters for the PIM
dense mode.
show ipv6 pim sparse Displays the status of the various global parameters for the IPv6
PIM sparse mode.
show ipv6 pim dense Displays the status of the various global parameters for the IPv6
PIM dense mode.

MIB Objects
alaPim
alaPimKeepalivePeriod

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-19
ip pim max-rps PIM Commands

ip pim max-rps
Configures the maximum number of C-RP routers allowed in the PIM-SM domain.
ip pim max-rps number

Syntax Definitions

number The maximum number of C-RP routers allowed in the PIM-SM domain
(1–100).

Defaults

parameter default
number 32

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is supported only in the sparse mode.

• This command is used with both IPv4 and IPv6 PIM-SM. The PIM-SM must be disabled before
changing max-rps value.
• PIM-SM must be globally disabled before changing the maximum number of C-RP routers. To
globally disable PIM-SM, refer to the ip pim sparse admin-state command on page 30-5.

Examples
-> ip pim max-rps 32

Release History
Release 8.1.1; command introduced.

page 30-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim max-rps

Related Commands

ip pim sparse admin-state Globally enables or disables the PIM-SM protocol on the switch.
ipv6 pim sparse admin-state Enables or disables the IPv6 PIM-SM (sparse mode) globally for
IPv6.
show ip pim sparse Displays the status of the various global parameters for the PIM
sparse mode.
show ipv6 pim sparse Displays the status of the various global parameters for the IPv6
PIM sparse mode.

MIB Objects
alaPimsmGlobalConfig
alaPimsmMaxRPs

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-21
ip pim probe-time PIM Commands

ip pim probe-time
Configures the amount of time before the Register Suppression timer expires, at which point the
Designated Router (DR) sends a Null Register message to the Rendezvous Point (RP). This allows the RP
to refresh the Register-Stop. If the Register Suppression timer expires, the DR will resume encapsulating
packets from the source to the RP.
ip pim probe-time seconds

Syntax Definitions

seconds The probe time, in seconds (1–300).

Defaults

parameter default
seconds 5

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is used with both IPv4 and IPv6 PIM-SM.

• This command is supported only in the sparse mode.

Examples
-> ip pim probe-time 5

Release History
Release 8.1.1; command introduced.

Related Commands

show ip pim sparse Displays the status of the various global parameters for the PIM
sparse mode.
show ipv6 pim sparse Displays the status of the various global parameters for the IPv6
PIM sparse mode.

MIB Objects
alaPimsmGlobalConfig
alaPimsmProbeTime

page 30-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim register checksum

ip pim register checksum

Configures the application of the checksum function on sent and received register messages in the domain.
ip pim register checksum {header | full}

Syntax Definitions

header Specifies that the checksum for registers is done only on the PIM
header.
full Specifies that the checksum is done over the entire PIM register
message.

Defaults

parameter default
header | full header

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The full option may be required for compatibility with older implementations of PIM-SM v2.

• This parameter setting must be consistent across the PIM domain.

• This command is supported only in the sparse mode.

Examples
-> ip pim register checksum header
-> ip pim register checksum full

Release History
Release 8.1.1; command introduced.

Related Commands

show ip pim sparse Displays the status of the various global parameters for the PIM
sparse mode.

MIB Objects
alaPimsmGlobalConfig
alaPimsmOldRegisterMessageSupport

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-23
ip pim register-suppress-timeout PIM Commands

ip pim register-suppress-timeout
Specifies the period during which a Designated Router (DR) stops sending Register-encapsulated packets
to the Rendezvous Point (RP) after receiving a Register-Stop message.
ip pim register-suppress-timeout seconds

Syntax Definitions

seconds The timeout value, in seconds (0–65535).

Defaults

parameter default
seconds 60

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is supported in both IPv4 and IPv6 PIM.

• This command is supported only in the sparse mode.

Examples
-> ip pim register-suppress-timeout 10

Release History
Release 8.1.1; command introduced.

Related Commands

show ip pim sparse Displays the status of the various global parameters for the PIM
sparse mode.
show ipv6 pim sparse Displays the status of the various global parameters for the IPv6
PIM sparse mode.

MIB Objects
alaPim
alaPimRegisterSuppressionTime

page 30-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim spt admin-state

ip pim spt admin-state

Enables or disables last hop Designated Router (DR) switching to the Shortest Path Tree (SPT). If
enabled, last hop DR switching to the SPT begins once the first data packet is received.
ip pim spt admin-state {enable | disable}

Syntax Definitions

enable Enables last hop DR switching to the SPT.

disable Disables last hop DR switching to the SPT.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is supported only in the sparse mode.

• As mentioned above, if SPT status is enabled, last hop DR switching to the SPT begins once the first
data packet is received.
• To view whether SPT status is currently enabled (default) or disabled, use the show ip pim sparse
command.

Examples
-> ip pim spt admin-state enable
-> ip pim spt admin-state disable

Release History
Release 8.1.1; command introduced.

Related Commands

show ip pim sparse Displays the status of the various global parameters for the PIM
sparse mode.

MIB Objects
alaPimsmGlobalConfig
alaPimsmAdminSPTConfig

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-25
ip pim state-refresh-interval PIM Commands

ip pim state-refresh-interval
Sets the interval between successive State Refresh messages originated by a router.
ip pim state-refresh-interval seconds

Syntax Definitions

seconds The interval between successive State Refresh messages, in seconds.

Values may range from 0 to 65535.

Defaults

parameter default
seconds 60

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is supported only in the dense mode.

• This value is used with both IPv4 PIM-DM and IPv6 PIM-DM.

Examples
-> ip pim state-refresh-interval 80

Release History
Release 8.1.1; command introduced.

Related Commands

ip pim interface Enables or disables the PIM protocol on a specific interface.

ipv6 pim interface Enables IPv6 PIM and configures the statistics.
show ip pim dense Displays the status of the various global parameters for the PIM
dense mode.
show ipv6 pim dense Displays the status of the various global parameters for the IPv6
PIM dense mode.

MIB Objects
alaPim
alaPimRefreshInterval

page 30-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim state-refresh-limit

ip pim state-refresh-limit
Sets the limit at which a router will not forward successive State Refresh messages if they are received at
less than the interval.
ip pim state-refresh- limit ticks

Syntax Definitions

ticks The limit at which the received State Refresh messages will not be
forwarded, if the messages are received at less than the interval. Values
may range from 0 to 65535.

Defaults

parameter default
ticks 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is supported only in the dense mode.

• This value is used with both IPv4 and IPv6.

Examples
-> ip pim state-refresh-limit 2

Release History
Release 8.1.1; command introduced.

Related Commands

ip pim interface Enables or disables the PIM protocol on a specific interface.

ipv6 pim interface Enables IPv6 PIM and configures the statistics.
show ip pim dense Displays the status of the various global parameters for the PIM
dense mode.
show ipv6 pim dense Displays the status of the various global parameters for the IPv6
PIM dense mode.

MIB Objects
alaPimdmGlobalConfig
alaPimdmStateRefreshLimitInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-27
ip pim state-refresh-ttl PIM Commands

ip pim state-refresh-ttl
Sets the Time to Live to be used in a router’s originated State Refresh messages if the data packet’s Time
to Live is not recorded.
ip pim state-refresh- ttl num

Syntax Definitions

num The Time to Live to be used. Values may range from 0 to 255.

Defaults

parameter default
num 16

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is supported only in the dense mode.

• This value is used with both IPv4 and IPv6 PIM-DM.

Examples
-> ip pim state-refresh-ttl 122

Release History
Release 8.1.1; command introduced.

Related Commands

ip pim interface Enables or disables the PIM protocol on a specific interface.

ipv6 pim interface Enables IPv6 PIM and configures the statistics.
show ip pim dense Displays the status of the various global parameters for the PIM
dense mode.
show ipv6 pim dense Displays the status of the various global parameters for the IPv6
PIM dense mode.

MIB Objects
alaPimdmGlobalConfig
alaPimdmStateRefreshTimeToLive

page 30-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim interface

ip pim interface
Enables PIM and configures PIM-related statistics such as hello-interval, triggered-hello, hello-holdtime,
joinprune, prune-delay, override-interval, dr-priority, stub interface, prune limit interval, and graft retry
interval on the interface.
ip pim interface if_name [hello-interval seconds] [triggered-hello seconds] [joinprune-interval
seconds] [hello-holdtime seconds] [joinprune-holdtime seconds] [prune-delay milliseconds] [override-
interval milliseconds] [dr-priority priority] [[no] stub] [prune-limit-interval seconds] [graft-retry-
interval seconds]
no ip pim interface if_name

Syntax Definitions

if_name The interface name on which PIM is being enabled or disabled.

hello-interval seconds The frequency at which PIM Hello messages are transmitted on a
specified interface, in seconds. Values may range from 0 to 18000.
triggered-hello seconds Specifies the maximum time, in seconds, before a triggered PIM Hello
message is sent on this interface. Values may range from 0 to 60.
joinprune-interval seconds The frequency at which periodic Join/Prune messages are sent on this
interface, in seconds. Values may range from 0 to 18000.
hello-holdtime seconds Specifies the value set in the Holdtime field of PIM Hello messages sent
on this interface, in seconds. Values may range from 0 to 65535.
joinprune-holdtime seconds Specifies the value inserted into the Holdtime field of the Join/Prune
messages sent on this interface, in seconds.Values may range from 0 to
65535.
prune-delay milliseconds Specifies the value of the expected propagation delay between PIM
routers on this network, inserted into the LAN prune-delay option of the
Hello messages sent on this interface, in milliseconds. Values may range
from 0 to 32767.
override-interval milliseconds Specifies the value inserted into the Override Interval field of the LAN
prune-delay option of the Hello messages sent on this interface, in
milliseconds. Values may range from 0 to 65535.
dr-priority priority Specifies the Designated Router priority inserted into the DR priority
option on a specified interface. The DR priority option value can range
between 1 to 192. A higher numeric value denotes a higher priority.
prune-limit-interval seconds Specifies the minimum interval that must elapse between two successive
prune messages sent on this interface, in seconds. Values may range
from 0 to 65535.
graft-retry-interval seconds Specifies the minimum interval that must elapse between two successive
graft messages sent on this interface, in seconds. Values may range from
0 to 65535.
stub Specifies the interface not to send any PIM packets through this
interface, and to ignore received PIM packets.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-29
ip pim interface PIM Commands

Defaults

parameter default
hello-interval seconds 30
triggered-hello seconds 5
joinprune-interval seconds 60
hello-holdtime seconds 105
joinprune-holdtime seconds 210
prune-delay milliseconds 500
override-interval milliseconds 2500
dr-priority priority 1
prune-limit-interval seconds 60
graft-retry-interval seconds 3
stub Disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete a PIM interface.

• PIM must be enabled globally on the switch before it runs on the interface. To globally enable or
disable PIM-SM on the switch, refer to the ip pim sparse admin-state command on page 30-5. To
enable or disable PIM-DM on the switch, refer to the ip pim dense admin-state command on
page 30-6.
• Specifying zero for the hello-interval represents an infinite time, in which case periodic PIM Hello
messages are not sent.
• Specifying zero for the joinprune-interval represents an infinite time, in which case periodic PIM Join/
Prune messages are not sent.
• Specifying the value of 65535 for hello-holdtime represents an infinite time. If a PIM router gets Hello
packet from a neighbor with its hello-holdtime value as infinte time, then the PIM router will not time
out the sender(neighbor). It is recommended that you should use a hello-holdtime interval that is 3.5
times the value of the hello-interval, or 65535 seconds if the hello-interval is set to zero.
• Specifying the value of 65535 for joinprune-holdtime represents an infinite time. The receipt of Join/
Prune messages with its joinprune-holdtime value as infinte time, then this specifies an infinite
holdtime for the particular join/prune message. It is recommended that you use a joinprune-holdtime
interval that is 3.5 times the value of the Join/Prune interval defined for the interface, or 65535 seconds
if the joinprune-interval is set to zero.
• The interface configured as a stub will not send any PIM packets through that interface, and any
received PIM packets are also ignored. By default, a PIM interface is not set to be a stub one.
• The graft-retry-interval and prune-limit-interval options can be used only with the PIM-DM mode.

page 30-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim interface

Examples
-> ip pim interface vlan-2 hello-interval 100 triggered-hello 10 joinprune-inter-
val 100 hello-holdtime 350 joinprune-holdtime 400
-> no ip pim interface vlan-2

Release History
Release 8.1.1; command introduced.

Related Commands

show ip pim interface Displays detailed PIM settings for a specific interface. In general, it
displays PIM settings for all the interfaces if no argument is
specified.

MIB Objects
alaPimInterfaceTable
alaPimInterfaceIfIndex
alaPimInterfaceStatus
alaPimInterfaceHelloInterval
alaPimInterfaceTrigHelloInterval
alaPimInterfaceJoinPruneInterval
alaPimInterfaceHelloHoldtime
alaPimInterfaceJoinPruneHoldtime
alaPimInterfacePropagationDelay
alaPimInterfaceOverrideInterval
alaPimInerfaceDRPriority
alaPimInterfaceStubInterface
alaPimInterfacePruneLimitInterval
alaPimInterfaceGraftRetryInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-31
ip pim neighbor-loss-notification-period PIM Commands

ip pim neighbor-loss-notification-period
Specifies the minimum time that must elapse between PIM neighbor loss notifications originated by the
router.
ip pim neighbor-loss-notification-period seconds

Syntax Definitions

seconds Specifies the time value that must elapse between neighbor loss
notifications, in seconds (0–65535).

Defaults

parameter default
seconds 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The maximum value of 65535 represents an infinite time. The PIM neighbor loss notifications are
never sent in case of infinite time.
• This command is used with both IPv4 and IPv6 PIM.

Examples
-> ip pim neighbor-loss-notification-period 100

Release History
Release 8.1.1; command introduced.

Related Commands

show ip pim notifications Displays the configuration of the configured notification periods as
well as information on the events triggering the notifications.

MIB Objects
alaPim
alaPimNeighborLossNotificationPeriod

page 30-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim invalid-register-notification-period

ip pim invalid-register-notification-period
Specifies the minimum time that must elapse between the PIM invalid register notifications originated by
the router.
ip pim invalid-register-notification-period seconds

Syntax Definitions

seconds Specifies the minimum time value that must elapse between invalid
register notifications, in seconds (10–65535).

Defaults

parameter default
seconds 65535

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The default value of 65535 represents an infinite time. The PIM invalid register notifications are never
sent in case of infinite time.
• The non-zero minimum allowed value provides resilience against the propagation of denial-of-service
attacks from the data and control planes to the network management plane.
• This value is used with both IPv4 and IPv6 PIM.

• This command is supported only in the sparse mode.

Examples
-> ip pim invalid-register-notification-period 100

Release History
Release 8.1.1; command introduced.

Related Commands

show ip pim notifications Displays the configuration of the configured notification periods as
well as information on the events triggering the notifications.

MIB Objects
alaPim
alaPimInvalidRegisterNotificationPeriod

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-33
ip pim invalid-joinprune-notification-period PIM Commands

ip pim invalid-joinprune-notification-period
Specifies the minimum time that must elapse between the PIM invalid joinprune notifications originated
by the router.
ip pim invalid-joinprune-notification-period seconds

Syntax Definitions

seconds Specifies the minimum time value that must elapse between invalid
joinprune notifications, in seconds (10–65535).

Defaults

parameter default
seconds 65535

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The default value of 65535 represents an infinite time. The PIM invalid joinprune notifications are
never sent in case of infinite time.
• The non-zero minimum allowed value provides resilience against the propagation of denial-of-service
attacks from the control plane to the network management plane.
• This value is used with both IPv4 and IPv6 PIM.

Examples
-> ip pim invalid-joinprune-notification-period 100

Release History
Release 8.1.1; command introduced.

Related Commands

show ip pim notifications Displays the configuration of the configured notification periods as
well as information on the events triggering the notifications.

MIB Objects
alaPim
alaPimInvalidJoinPruneNotificationPeriod

page 30-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim rp-mapping-notification-period

ip pim rp-mapping-notification-period
Specifies the minimum time that must elapse between the PIM RP mapping notifications originated by the
router.
ip pim rp-mapping-notification-period seconds

Syntax Definitions

seconds Specifies the minimum time value that must elapse between RP
mapping notifications, in seconds (0–65535).

Defaults

parameter default
seconds 65535

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The default value of 65535 represents an infinite time. The RP mapping notifications are never sent in
case of infinite time.
• This value is used with both IPv4 and IPv6 PIM.

• This command is supported only in the sparse mode.

Examples
-> ip pim rp-mapping-notification-period 100

Release History
Release 8.1.1; command introduced.

Related Commands

show ip pim notifications Displays the configuration of the configured notification periods as
well as information on the events triggering the notifications.

MIB Objects
alaPim
alaPimRPMappingNotificationPeriod

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-35
ip pim interface-election-notification-period PIM Commands

ip pim interface-election-notification-period
Specifies the minimum time that must elapse between the PIM interface election notifications originated
by the router.
ip pim interface-election-notification-period seconds

Syntax Definitions

seconds Specifies the minimum time value that must elapse between interface
election notifications, in seconds (0–65535).

Defaults

parameter default
seconds 65535

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The default value of 65535 represents an infinite time. The interface election notifications are never
sent in case of infinite time.
• This value is used with both IPv4 and IPv6 PIM.

• This command is supported only in the sparse mode.

Examples
-> ip pim interface-election-notification-period 100

Release History
Release 8.1.1; command introduced.

Related Commands

show ip pim notifications Displays the configuration of the configured notification periods as
well as information on the events triggering the notifications.

MIB Objects
alaPim
alaPimInterfaceElectionNotificationPeriod

page 30-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim mbr all-sources

ip pim mbr all-sources

Configures whether or not PIM notifies DVMRP about the routes to all multicast sources learned. This
command applies only when the local switch is operating as a Multicast Border Router (MBR).
ip pim mbr all-sources
no ip pim mbr all-sources

Syntax Definitions

N/A

Defaults
By default, PIM only notifies DVMRP about the routes for subnets directly connected to PIM interfaces.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable notification of all route sources learned.

• This command applies to both PIM-SM and PIM-DM. Note that PIM-SSM does not support MBR
functionality.
• DVMRP advertises the routes received from PIM within the DVMRP domain using standard DVMRP
mechanisms.

Examples
-> ip pim mbr all-sources
-> no ip pim mbr all-sources

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-37
ip pim mbr all-sources PIM Commands

Related Commands

show ip pim sparse Displays the status of the various global parameters for the PIM
sparse mode.
show ip pim dense Displays the status of the various global parameters for the PIM
dense mode.
ip mroute mbr Configures the switch to operate as a Multicast Border Router to
provide interoperability between PIM and DVMRP.
ip dvmrp interface mbr- Configures whether or not the DVMRP interface on a Multicast
default-information Border Router advertises a default route.

MIB Objects
alaPimGlobalConfig
alaPimMbrAllSourcesStatus

page 30-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim bfd-state

ip pim bfd-state
Enables or disables the BFD protocol at global level for PIM on the switch.
ip pim bfd-state {enable | disable}

Syntax Definitions

enable Enable the BFD protocol at global level for PIM protocol.
disable Disable the BFD protocol at global level for PIM protocol.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip pim bfd-state enable
-> ip pim bfd-state disable

Release History
Release 8.2.1; command introduced.

Related Commands

show ip pim sparse Displays the status of the various global parameters for the PIM
sparse mode
show ip pim dense Displays the status of the various global parameters for the PIM
dense mode

MIB Objects
alaPimBfdStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-39
ip pim bfd-state all-interfaces PIM Commands

ip pim bfd-state all-interfaces

Enables or disables the BFD protocol at global level for all PIM interfaces on the switch.
ip pim bfd-state all-interfaces {enable | disable}

Syntax Definitions

enable Enable the BFD protocol at global level for all PIM interfaces.
disable Disable the BFD protocol at global level for all PIM interfaces.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip pim bfd-state all-interfaces enable
-> ip pim bfd-state all-interfaces disable

Release History
Release 8.2.1; command introduced.

Related Commands

show ip pim interface Displays detailed PIM settings for PIM interfaces.

MIB Objects
alaPimBfdAllInterfaceStatus

page 30-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim interface bfd-state

ip pim interface bfd-state

Enables or disables the BFD for a specified PIM interface.
ip pim interface if_name [bfd-state enable|disable]
no ip pim interface if_name

Syntax Definitions

if_name The PIM interface name for which the BFD is enabled or disabled.
enable Enable the MoFRR for all PIM-SM routes on the switch.
disable Disable the MoFRR for all PIM-SM routes on the switch.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete a PIM interface.

Examples
-> ip pim interface vlan-2 bfd-state enable
-> no ip pim interface vlan-2

Release History
Release 8.2.1; command introduced.

Related Commands

show ip pim interface Displays detailed PIM settings for PIM interfaces.

MIB Objects
alaPimInterfaceBFDStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-41
ip pim mofrr-state PIM Commands

ip pim mofrr-state
Enables or disables the MoFRR for PIM on the switch.
ip pim mofrr-state {enable | disable}

Syntax Definitions

enable Enable the MoFRR on the switch.

disable Disable the MoFRR on the switch.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If enabled, MoFRR is applied only for the multicast routes that have local clients.

• If enabled, results in the consumption of bandwidth for the secondary (redundant) path. The secondary
path in MoFRR will only be established on edge routers where there are local clients.

Note: MoFRR is not supported for PIM-SM with (*, g) enabled and PIM-Bidirectional.

Examples
-> ip pim mofrr-state enable
-> ip pim mofrr-state disable

Release History
Release 8.2.1; command introduced.

Related Commands

show ip pim sparse Displays the status of the various global parameters for the PIM
sparse mode
show ip pim dense Displays the status of the various global parameters for the PIM
dense mode

MIB Objects
alaPimMofrrStatus

page 30-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ip pim mofrr-state all-routes

ip pim mofrr-state all-routes

Enables or disables the MoFRR for all PIM routes on the switch.
ip pim mofrr-state all-routes {enable | disable}

Syntax Definitions

enable Enable the MoFRR for all PIM routes on the switch.
disable Disable the MoFRR for all PIM routes on the switch.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If enabled, this command enables MoFRR for all PIM routes, whether there are local clients or not.

• If enabled, this command enables the secondary path for all routes, whether there are local clients or
not. However, since PIM-SM is not established for secondary paths for any (*, G) routes, MoFRR is
not supported for PIM-SM with (*, g) enable.

Notes.
• MoFRR supports only 2 ECMP routes.
• MoFRR is not supported for PIM-Bidirectional.

Examples
-> ip pim mofrr-state all-routes enable
-> ip pim mofrr-state all-routes disable

Release History
Release 8.2.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-43
ip pim mofrr-state all-routes PIM Commands

Related Commands

show ip pim sparse Displays the status of the various global parameters for the PIM
sparse mode
show ip pim dense Displays the status of the various global parameters for the PIM
dense mode

MIB Objects
alaPimMofrrStatus

page 30-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ip pim sparse

show ip pim sparse

Displays the status of the various global parameters for the PIM sparse mode.
show ip pim sparse

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip pim sparse
Status = enabled,
Keepalive Period = 210,
Max RPs = 32,
Probe Time = 5,
Register Checksum = header,
Register Suppress Timeout = 60,
RP Threshold = 1,
SPT Status = enabled,
BIDIR Status = disabled,
BIDIR Periodic Interval = 60,
BIDIR DF Abort Status = disabled,
BFD Status = enabled,
MoFRR Status = disabled,
MoFRR All Routes Status = disabled,
MBR All Sources Status = enabled,
MBR Operational Status = disabled

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-45
show ip pim sparse PIM Commands

output definitions
Status The current global (i.e., switch-wide) status of PIM-SM. Options
include enabled and disabled.
Keepalive Period The duration of the Keepalive timer. The default value is 210.
Max RPs The maximum number of Rendezvous Points (RPs) allowed in the
PIM-SM domain (1–100). The default value is 32.
Probe Time The amount of time before the Register Suppression timer expires, at
which point the Designated Router (DR) sends a Null Register message
to the Rendezvous Point (RP). This allows the RP to refresh the
Register-Stop. If the Register Suppression timer expires, the DR will
resume encapsulating packets from the source to the RP. Values may
range from 1 to 300. The default value is 5.
Register Checksum The current application of the checksum function on register messages
in the domain. Options include header and full. The default setting is
header.
Register Suppress Timeout The amount of time, in seconds, the Designated Router (DR) will stop
sending registers to the Rendezvous Point (RP) once a Register-Stop is
received (1–300). The default value is 60.
RP Threshold Displays the current RP data rate threshold. This value indicates the
rate, in bits per second (bps), at which the Rendezvous Point (RP) will
attempt to switch to native forwarding by issuing an (S, G) Join
message toward the source. Values may range from 0 to 2147483647.
The default value is 1. A value of 0 indicates that the feature is
currently disabled.
SPT Status The current status of last hop Designated Router (DR) switching to the
Shortest Path Tree (SPT). Options include enabled (the default) and
disabled.
BIDIR Status Not supported in the current release.
BIDIR Periodic Interval
BIDIR DF Abort Status
BFD Status Global Administrative status of PIM with the BFD protocol on this
router.
MoFRR Status Global Administrative status of MoFRR on this router.
MoFRR All Routes Status Administrative status of MoFRR for all routes on this router.
MBR All Sources Statu Indicates whether or not PIM notifies DVMRP about the routes to all
multicast sources learned. Options include enabled (routes to all
sources) or disabled (only routes on PIM interfaces). This status only
applies when the switch is operating in the Multicast Border Router
(MBR) mode.
MBR Operational Status Indicates whether or not PIM interaction with DVMRP is enabled or
disabled on a MBR switch. MBR functionality is not operationally
active until both PIM and DVMRP have at least one enabled and active
interface.

Release History
Release 8.1.1; command introduced.
Release 8.2.1; command output modified.

page 30-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ip pim sparse

Related Commands

ip pim sparse admin-state Globally enables or disables PIM-SM protocol on the switch.
ip pim interface Enables or disables the PIM protocol on a specific interface.
ip pim keepalive-period Configures the period during which the (S,G) Join state will be
maintained in the absence of (S,G) Join messages or explicit (S,G)
local membership.
ip pim max-rps Configures the maximum number of C-RP routers allowed in the
PIM-SM domain.
ip pim probe-time Configures the amount of time before the Register Suppression
timer expires, at which point the Designated Router (DR) sends a
Null Register message to the Rendezvous Point (RP). This allows
the RP to refresh the Register-Stop. If the Register Suppression
timer expires, the DR will resume encapsulating packets from the
source to the RP.
ip pim register checksum Configures the application of the checksum function on sent and
received register messages in the domain.
ip pim register-suppress- Specifies the period during which a Designated Router (DR) stops
timeout sending Register-encapsulated packets to the Rendezvous Point
(RP) after receiving a Register-Stop message.
ip pim rp-threshold Specifies the data rate, in bits per second (bps), at which the
Rendezvous Point (RP) will attempt to switch to native forwarding
by issuing a source-specific (S, G) Join message toward the source.
ip pim spt admin-state Enables or disables last hop Designated Router (DR) switching to
the Shortest Path Tree (SPT). If enabled, last hop DR switching to
the SPT begins once the first data packet is received.
ip pim mbr all-sources Configures PIM to notify DVMRP of all learned routes to sources.
This command only applies when the switch is operating in the
Multicast Border Router mode.

MIB Objects
alaPimsmGlobalConfig
alaPimsmAdminStatus
alaPimKeepalivePeriod
alaPimsmMaxRPS
alaPimsmProbeTime
alaPimsmOldRegisterMessageSupport
alaPimRegisterSuppressionTime
alaPimsmRPThreshold
alaPimsmAdminSPTConfig
alaPimMbrAllSourcesStatus
alaPimMbrOperStatus
alaPimBfdStatus
alaPimMoFRRStatus
alaPimMoFRRAllRouteStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-47
show ip pim dense PIM Commands

show ip pim dense

Displays the status of the various global parameters for the PIM dense mode.
show ip pim dense

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip pim dense
Status = enabled,
Source Lifetime = 210,
State Refresh Interval = 60,
State Refresh Limit Interval = 0,
State Refresh TTL = 16,
BFD Status = enabled,
MoFRR Status = disabled,
MBR All Sources Status = disabled,
MBR Operational Status = enabled

output definitions
Status The current global (i.e., switch-wide) status of PIM-DM. Options
include enabled and disabled.
Source Lifetime The duration of the Keepalive or Source Lifetime timer. The default
value is 210.
State Refresh Interval The time-interval, in seconds, between successive State Refresh
messages originated by the router. The default value is 60.
State Refresh Limit Interval Displays the limit at which a router will not forward the State Refresh
messages, if they are received at less than the interval.
State Refresh TTL Displays the TTL to be used in the router’s originated State Refresh
messages. The default value is 16.
BFD Status Global Administrative status of PIM with the BFD protocol on this
router.
MoFRR Status Global Administrative status of MoFRR on this router.

page 30-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ip pim dense

output definitions (continued)

MBR All Sources Status Indicates whether or not PIM notifies DVMRP about the routes to all
multicast sources learned. Options include enabled (routes to all
sources) or disabled (only routes on PIM interfaces). This status only
applies when the switch is operating in the Multicast Border Router
(MBR) mode.
MBR Operational Status Indicates whether or not PIM interaction with DVMRP is enabled or
disabled on a MBR switch. MBR functionality is not operationally
active until both PIM and DVMRP have at least one enabled and active
interface.

Release History
Release 8.1.1; command introduced.
Release 8.2.1; command output modified.

Related Commands

ip pim dense admin-state Globally enables or disables PIM-DM protocol on the switch.
ip pim interface Enables or disables the PIM protocol on a specific interface.
ip pim state-refresh-interval Sets the interval between successive State Refresh messages
originated by a router.
ip pim state-refresh-limit Sets the limit at which a router will not forward successive State
Refresh messages if they are received at less than the interval.
ip pim state-refresh-ttl Sets the Time to Live to be used in a router’s originated State
Refresh messages if the data packet’s Time to Live is not recorded.
ip pim keepalive-period Configures the period during which the (S,G) Join state will be
maintained in the absence of (S,G) Join messages or explicit (S,G)
local membership.
ip pim mbr all-sources Configures PIM to notify DVMRP of all learned routes to sources.
This command only applies when the switch is operating in the
Multicast Border Router mode.

MIB Objects
alaPimdmGlobalConfig
alaPimdmAdminStatus
alaPimKeepalivePeriod
alaPimRefreshInterval
alaPimdmStateRefreshLimitInterval
alaPimdmStateRefreshTimeToLive
alaPimMbrAllSourcesStatus
alaPimMbrOperStatus
alaPimBfdStatus
alaPimMoFRRStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-49
show ip pim ssm group PIM Commands

show ip pim ssm group

Displays the static configuration of multicast group mappings for the PIM-Source Specific Multicast
(SSM) mode.
show ip pim ssm group

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the group prefixes configured for two or more rows in this table overlap, the row with the greatest
prefix length value is used for the overlapping range.
• This command is supported only in the sparse mode.

Examples
-> show ip pim ssm group
Group Address/Pref Length Mode Override Precedence Status
---------------------------+-----+--------+----------+--------
224.0.0.0/4 ssm false none enabled

output definitions
Group Address/Pref Length The 32-bit IP address for a multicast group, along with the mask length,
shown in bits. The group IP address and mask are separated by a slash
( / ).
Mode The PIM mode to be used for groups in this prefix. The possible values
include asm, ssm, or dm.
Override Specifies this static RP configuration to override the dynamically
learned RP information for the specified group.
Precedence Specifies the precedence value to be used for this static RP
configuration.
Status Displays whether this entry is currently enabled or disabled. Options
include enabled and disabled.

Release History
Release 8.1.1; command introduced.

page 30-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ip pim ssm group

Related Commands

ip pim ssm group Statically maps the specified IP multicast group to the PIM Source
Specific Multicast mode (SSM).
show ip pim group-map Displays the PIM group mapping table.

MIB Objects
alaPimStaticRPTable
alaPimStaticRPGrpAddress
alaPimStaticRPGrpPrefixLength
alaPimStaticRPPimMode
alaPimStaticRPOverrideDynamic
alaPimStaticRPPrecedence
alaPimStaticRPRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-51
show ip pim dense group PIM Commands

show ip pim dense group

Displays the static configuration of multicast group mappings for PIM-Dense Mode (DM).
show ip pim dense group

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the group prefixes configured for two or more rows in this table overlap, the row with the greatest
prefix length value is used for the overlapping range.
• This command is supported only on PIM dense mode.

Examples
-> show ip pim dense group
Group Address/Pref Length Mode Override Precedence Status
---------------------------+-----+--------+----------+--------
224.0.0.0/4 dm false none enabled

output definitions
Group Address/Pref Length The 32-bit IP address for a multicast group, along with the mask length,
shown in bits. The group IP address and mask are separated by a slash
( / ).
Mode The PIM mode to be used for groups in this prefix. The possible values
include asm, ssm, or dm.
Override Specifies this static RP configuration to override the dynamically
learned RP information for the specified group.
Precedence Specifies the precedence value to be used for this static RP
configuration.
Status Displays whether this entry is currently enabled or disabled. Options
include enabled and disabled.

Release History
Release 8.1.1; command introduced.

page 30-52 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ip pim dense group

Related Commands

ip pim dense group Creates and manages the static configuration of dense mode (DM)
group mappings.
show ip pim group-map Displays the PIM group mapping table.

MIB Objects
alaPimStaticRPTable
alaPimStaticRPGrpAddress
alaPimStaticRPGrpPrefixLength
alaPimStaticRPRowStatus
alaPimStaticRPOverrideDynamic
alaPimStaticRPPrecedence
alaPimStaticRPPimMode

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-53
show ip pim neighbor PIM Commands

show ip pim neighbor

Displays a list of active PIM neighbors.
show ip pim neighbor [ip_address]

Syntax Definitions

ip_address The 32-bit IP address for the PIM neighbor.

Defaults
If a neighbor’s IP address is not specified, the entire PIM neighbor table is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
To view more detailed information about a particular neighbor, specify the neighbor's IP address in the
command line. Additional information will be displayed, which includes LAN Prune Delay, Override
Interval, TBit field, State Refresh capable, and Designated Router option status.

Examples
-> show ip pim neighbor
Neighbor Address Interface Name Uptime Expires DR Priority
-----------------+--------------------+-----------+-----------+-------------
212.61.20.250 vlan-2 01h:07m:07s 00h:01m:38s 100
212.61.60.200 vlan-6 01h:07m:07s 00h:01m:38s 100
214.28.4.254 vlan-26 01h:07m:07s 00h:01m:38s 100

If a specific neighbor IP address is specified in the command line, detailed information for the
corresponding neighbor only displays:
-> show ip pim neighbor 212.61.30.7
Neighbor IP Address = 212.61.30.7,
Interface Name = vlan-30,
Uptime = 00h:04m:14s,
Expires = 00h:01m:31s,
Lan Prune Delay Present = true,
Propagation Delay = 500,
Override Interval = 2500,
TBit field = false,
Gen ID Present = true,
Gen ID Value = 0x79ca868e,
BiDir Capable = false,
DR Priority Present = true,
DR Priority = 1,
State Refresh Capable = true

page 30-54 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ip pim neighbor

output definitions
Neighbor (IP) Address The 32-bit IP address of the active PIM neighbor.
Interface Name The name of the interface used to reach this PIM neighbor.
Uptime The amount of time since this PIM neighbor last became a neighbor of
the local router, displayed in hours, minutes, and seconds.
Expiry time The minimum amount of time remaining before the PIM neighbor will
be aged out, displayed in hours, minutes, and seconds.
Lan Prune Delay Present Evaluates to TRUE if this neighbor is using the Lan Prune Delay
option.
Propagation Delay The expected propagation delay between PIM routers on this network.
DR Priority Present Evaluates to TRUE if the neighbor is using the DR Priority option.
DR Priority The value of the Designated Router Priority from the last PIM Hello
message received from this neighbor. This object is always zero if the
DR Priority Present value is FALSE.
TBit field The value of the Tbit field of the LAN prune delay option received
from this neighbor. The Tbit specifies the ability of the neighbor to
disable Join suppression.
Generation ID Present Evaluates to TRUE if this neighbor is using the Generation ID option.
Generation ID Value The value of the Generation ID from the last PIM Hello message
received from the neighbor.
BiDir Capable Evaluates to TRUE if this neighbor is using the Bidirectional-PIM
Capable option.
State Refresh Capable Displays whether the neighbor is capable of receiving State Refresh
messages. Options include true or false.
Override Interval The current Override Interval. This value is used to avoid
synchronization of override messages when multiple downstream
routers share a multi-access link. The sending of override messages is
delayed at random time intervals. The amount of randomization used
by a router is dictated by this number. Values may range from 0 to
65535. The default value is 2500.

Release History
Release 8.1.1; command introduced.

Related Commands
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-55
show ip pim neighbor PIM Commands

MIB Objects
alaPimNeighborTable
alaPimNeighborAddress
alaPimNeighborIfIndex
alaPimNeighborUpTime
alaPimNeighborExpiryTime
alaPimNeighborLanPruneDelayPresent
alaPimNeighborPropagationDelay
alaPimNeighborTBit
alaPimNeighborGenerationIDPresent
alaPimNeighborGenerationIDValue
alaPimNeighborBidirCapable
alaPimNeighborDRPriorityPresent
alaPimNeighborDRPriority
alaPimNeighborOverrideInterval
alaPimNeighborSRCapable

page 30-56 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ip pim candidate-rp

show ip pim candidate-rp

Displays the IP multicast groups for which the local router advertises itself as a Candidate-RP.
show ip pim candidate-rp

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip pim candidate-rp
RP Address Group Address Priority Interval Status
------------------+---------------+---------+---------+--------
172.21.63.11 224.0.0.0/4 192 60 enabled

output definitions
RP Address A 32-bit IP address that is advertised as the Candidate-Rendezvous
Point (RP).
Group Address The 32-bit IP address for a multicast group, along with the mask length,
shown in bits. The group IP address and mask are separated by a slash
( / ). This is the group for which the local router advertises itself as a C-
RP.
Priority The C-RP router’s priority. The lower the value, the higher the priority.
Interval The time interval at which the C-RP advertisements are sent to the
BSR.
Status The current status of this entry. The status is shown as enabled only if
the PIM-SM is globally enabled and the PIM interface is enabled.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-57
show ip pim candidate-rp PIM Commands

Related Commands

ip pim candidate-rp Configures the local router as the Candidate-Rendezvous Point (C-
RP) for a specified IP multicast group.

MIB Objects
alaPimBsrCandidateRPTable
alaPimBsrCandidateRPAddress
alaPimBsrCandidateRPGroupAddress
alaBsrCandidateRPGroupPrefixLength
alaPimBsrCandidateRPPriority
alaPimBsrCandidateRPInterval
alaPimBsrCandidateRPStatus

page 30-58 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ip pim group-map

show ip pim group-map

Displays the PIM group mapping table.
show ip pim group-map [bsr | static-rp | ssm | dense]

Syntax Definitions

N/A

Defaults
If the keywords bsr, static-rp, ssm, or dense are included in the command line, then only the entries that
were created by the specified origin are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If static RP configuration is being used, this information is obtained from those static RP addresses that
are defined through the ip pim static-rp command. As long as the RP addresses defined in the static
RP set are reachable, they will be added to the group mapping table.
• If the IP multicast groups are mapped to the mode SSM or DM, then the entries created by local SSM
address range configuration using the ip pim ssm group command and local Dense Mode address
range configuration using the ip pim dense group command are displayed.
• If the bootstrap mechanism is being used, this information is obtained from received Candidate-RP
advertisements (when the local router is the BSR; when the local router is not the BSR, this
information is obtained from received bootstrap messages).

Examples
-> show ip pim group-map
Origin Group Address/Pref Length RP Address Mode Precedence
---------+---------------------------+-------------+-----+-----------
BSR 224.0.0.0/4 172.21.63.11 asm 192
BSR 224.0.0.0/4 214.0.0.7 asm 192
Static 232.0.0.0/8 ssm

-> show ip pim group-map bsr

Origin Group Address/Pref Length RP Address Mode Precedence
---------+---------------------------+-------------+-----+-----------
BSR 224.0.0.0/4 172.21.63.11 asm 192
BSR 224.0.0.0/4 214.0.0.7 asm 192

-> show ip pim group-map static

Origin Group Address/Pref Length RP Address Mode Precedence
---------+---------------------------+-------------+-----+-----------
Static 232.0.0.0/8 ssm

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-59
show ip pim group-map PIM Commands

output definitions
Origin The mechanism by which the PIM mode and RP for the group were
learned. The possible values include 'static RP' for local static RP
configuration, 'static SSM' for both SSM group configuration and
Dense Mode Group configuration, and 'BSR' for the PIM Bootstrap
Router mechanism.
Group Address/Prefix Length The 32-bit IP address for a multicast group, along with the mask length,
shown in bits. The group IP address and mask are separated by a slash
( / ).
RP Address The IP address of the Rendezvous Point to be used for groups within
the group prefix. There is no RP address if the PIM mode is either SSM
or DM.
Mode The PIM mode to be used for groups in this prefix.
Mapping Precedence The precedence value of a particular row, which determines which row
applies to a given group address. Numerically higher values for this
object indicate lower precedences, with the value zero denoting the
highest precedence.

Release History
Release 8.1.1; command introduced.

Related Commands

ip pim ssm group Creates and manages the static configuration of a Source Specific
Multicast mode group mappings.
ip pim dense group Creates and manages the static configuration of dense mode (DM) group
mappings.
ip pim static-rp Adds, modifies, or deletes a static RP for a group (“modifies” applies
only to the RP address, since the table is indexed from group address
and mask parameters).

MIB Objects
alaPimGroupMappingTable
alaPimGroupMappingOrigin
alaPimGroupMappingGrpAddress
alaPimGroupMappingPrecedence
alaPimGroupMappingRPAddress
alaPimGroupMappingPimMode
alaPimGroupMappingGrpPrefixLength

page 30-60 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ip pim interface

show ip pim interface

Displays detailed PIM settings for a specific interface. In general, it displays PIM settings for all the
interfaces if no argument is specified.
show ip pim interface [if_name]

Syntax Definitions

if_name The interface name.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
To view more detailed information about a particular interface, specify the interface name in the command
line. Additional information includes Triggered Hello Interval, Hello Holdtime, Prune Delay status and
value, Override Interval, LAN Delay status, Generation ID status, and Join/Prune Holdtime.

Examples
-> show ip pim interface
Total 1 Interfaces

Interface IP Address Designated Hello J/P Oper BFD

Name Router Interval Interval Status Status
----------+------------+---------------+----------+----------+----------+----------
vlan-203 10.11.203.8 10.11.203.27 30 60 enabled enabled
vlan-204 10.11.204.8 10.11.204.8 30 60 enabled disabled

-> show ip pim interface tesvl

Interface Name = tesvl,
IP Address = 50.1.1.1,
Designated Router = 50.1.1.1,
Hello Interval = 30,
Triggered Hello Interval = 5,
Hello HoldTime = 105,
Join/Prune Interval = 60,
Join/Prune HoldTime = 210,
Propagation (Prune) Delay = 500,
Override Interval = 2500,
Generation ID = 0x46e68b13,
DR Priority = 1,
DR Priority Enabled = true,
Lan Delay Enabled = true,
Effective Propagation Delay = 500,
Effective Override Interval = 2500,
Suppression Enabled = true,

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-61
show ip pim interface PIM Commands

Stub Interface = false,

Prune Limit Interval = 60,
Graft Retry Interval = 3,
State Refresh Enabled = true,
Operational Status = enabled,
BFD Status = enabled

output definitions
Interface Name The name of the interface on which PIM is enabled.
IP address Specifies the IP address of the specified interface.
Designated Router The 32-bit IP address for the Designated Router (DR). The DR acts on
behalf of any directly-connected hosts with respect to the PIM-SM
protocol. Only one router in the LAN will act as the DR.
Hello Interval The frequency at which PIM Hello messages are transmitted on a
specified interface. Values range from 1 to 18000.
Join/Prune Interval The Join/Prune interval for the associated interface. The Join/Prune
interval is the interval at which periodic PIM-SM Join/Prune messages
are sent. Values range from 1 to 18000.
Triggered Hello Interval The current Triggered Hello Interval. This value indicates the
maximum time, in seconds, before a triggered PIM Hello message is
transmitted on the corresponding interface. Values range from 1 to 60.
Hello Holdtime The current Hello Holdtime value. This value indicates the maximum
amount of time, in seconds, Hello messages will be held before they are
considered invalid. Values range from 0 to 65535.
Join/Prune Holdtime The current Join/Prune Holdtime value. This value indicates the
maximum amount of time, in seconds, Join/Prune messages will be
held before they are considered invalid. Values range from 0 to 65535.
Propagation Delay The expected propagation delay between PIM routers on this network.
Override Interval The current Override Interval. This value is used to avoid
synchronization of override messages when multiple downstream
routers share a multi-access link. The sending of override messages is
delayed at random time intervals. The amount of randomization used
by a router is dictated by this number. Values range from 0 to 65535.
Generation ID Option The value of the Generation ID this router inserted in the last PIM
Hello message it sent on this interface.
DR Priority Displays the Designated Router priority for each interface. This value is
used in determining the Designated Router on an interface. Values
range from 1 to 192. A higher numeric value denotes a higher priority.
Note that priority-based election is used only if all routers on the
interface are using the DR priority option.
Lan Delay Enabled Options include true and false. The value will be true if all neighbors
on the interface are using the LAN Prune Delay option. Otherwise, the
setting will be false.
Effective Propagation Delay The Effective Propagation Delay on this interface.
Effective Override Interval The Effective Override Interval on this interface.
Suppression Enabled Specifies whether the Join suppression is enabled on this interface.

page 30-62 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ip pim interface

output definitions (continued)

DR Priority Enabled Evaluates to TRUE if all routers on this interface are using the DR
Priority option.
Stub Interface Specifies whether this interface is a 'stub interface'. If this is TRUE,
then no PIM packets are sent out on this interface, and any received
PIM packets are ignored.
Prune Limit Interval The minimum interval that must transpire between two successive
Prunes sent by a router. This is used only with PIM-DM.
Graft Retry Interval Displays the time-interval a router waits for a Graft acknowledgment
before resending a Graft on the interface. This is used only with PIM-
DM. Values range from 1 to 65535.
SR Priority Enabled Evaluates to TRUE if all routers on this interface are using the State
Refresh option. This is used only by PIM-DM.
Operational Status The operational status of the corresponding interface (enabled or
disabled). Indicates whether the IP interface is operationally up. For
example, if PIM is enabled on the interface, but the IP interface is
currently down, this field will display as disabled. Configured through
the ip pim sparse admin-state and ip pim dense admin-state
commands.
BFD Status Specifies whether BFD is enabled or disabled for a specified interface.

Release History
Release 8.1.1; command introduced.
Release 8.2.1; command output modified.

Related Commands

ip pim interface Enables or disables the PIM protocol on a specific interface.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-63
show ip pim interface PIM Commands

MIB Objects
alaPimInterfaceTable
alaPimInterfaceIfIndex
alaPimInterfaceDR
alaPimInterfaceHelloInterval
alaPimInterfaceJoinPruneInterval
alaPimInterfaceStatus
alaPimInterfaceAddress
alaPimInterfaceTrigHelloInterval
alaPimInterfaceHelloHoldtime
alaPimInterfaceJoinPruneHoldtime
alaPimInterfacePropagationDelay
alaPimInterfaceOverrideInterval
alaPimInterfaceGenerationIDValue
alaPimInterfaceDRPriority
alaPimInterfaceLanDelayEnabled
alaPimInterfaceEffectPropagDelay
alaPimInterfaceEffectOverrideIvl
alaPimInterfaceSuppressionEnabled
alaPimInterfaceDRPriorityEnabled
alaPimInterfaceStubInterface
AlaPimInterfacePruneLimitInterval
alaPimInterfaceGraftRetryInterval
alaPimInterfaceSRPriorityEnabled
alaPimInterfaceBfdStatus

page 30-64 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ip pim static-rp

show ip pim static-rp

Displays the PIM Static RP table for the ASM mode, which includes group address/prefix length, the
static Rendezvous Point (RP) address, and the current status of the Static RP configuration (i.e., enabled or
disabled).
show ip pim static-rp

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If the group prefixes configured for two or more rows in this table overlap, the row with the greatest prefix
length value is used for the overlapping range

Examples
-> show ip pim static-rp
Group Address/Pref Length RP Address Mode Override Precedence Status
---------------------------+-------------+-----+--------+----------+--------
224.0.0.0/4 172.21.63.11 asm false none enabled

output definitions
Group Address/Pref Length The 32-bit IP address for a multicast group, along with the mask length,
shown in bits. The group IP address and mask are separated by a slash
( / ). To change the current multicast group address and mask, refer to
the ip pim static-rp command on page 30-13.
RP Address A 32-bit IP address of the Rendezvous Point (RP). To change the
current RP address, refer to the ip pim static-rp command on
page 30-13.
Mode The PIM mode to be used for groups in this prefix. The possible values
include asm, ssm, or dm.
Override Specifies this static RP configuration to override the dynamically
learned RP information for the specified group.
Precedence Specifies the precedence value to be used for this static RP
configuration.
Status Displays whether static RP configuration is currently enabled or
disabled. Options include enabled and disabled. To change the current
status, refer to the ip pim static-rp command on page 30-13.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-65
show ip pim static-rp PIM Commands

Release History
Release 8.1.1; command introduced.

Related Commands

ip pim static-rp Adds, modifies, or deletes a static RP for a group (“modifies”

applies only to the RP address, since the table is indexed from group
address and mask parameters).

MIB Objects
alaPimStaticRPTable
alaPimStaticRPGrpAddress
alaPimStaticRPGrpPrefixLength
alaPimStaticRPAddress
alaPimStaticRPPimMode
alaPimStaticRPOverrideDynamic
alaPimStaticRPPrecedence
alaPimStaticRPRowStatus

page 30-66 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ip pim cbsr

show ip pim cbsr

Displays the Candidate-BSR information that is used in the Bootstrap messages.
show ip pim cbsr

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip pim cbsr
CBSR Address = 214.0.0.7,
Status = enabled,
CBSR Priority = 0,
Hash Mask Length = 30,
Elected BSR = False,
Timer = 00h:00m:00s

output definitions
CBSR Address The 32-bit address that the local router uses to advertise itself as a
Candidate-BSR.
Status The current status of this entry. The status is shown as enabled only if
the PIM-SM is globally enabled and the PIM interface is enabled.
CBSR Priority The value for the local router as a Candidate-BSR. The higher the
value, the higher the priority.
Hash Mask Length The 32-bit mask length that is advertised in the bootstrap messages.
The length of the mask is used in the hash function when computing the
Rendezvous Point (RP) for a multicast group.
Elected BSR Specifies whether the local router is the elected BSR.
Timer The time value that is remaining before the local router originates the
next bootstrap message. This value is zero if this router is not the
elected BSR.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-67
show ip pim cbsr PIM Commands

Related Commands

ip pim cbsr Configures the Candidate-BSR information that is used in the

Bootstrap messages.

MIB Objects
alaPimBSrCandidateBSRTable
alaPimBsrCandidateBSRAddress
alaPimBsrCandidateBSRPriority
alaPimBsrCandidateBSRHashMaskLength
alaPimBsrCandidateBSRElectedBSR
alaPimBsrCandidateBSRBootstrapTimer
alaPimBsrCandidateBSRStatus

page 30-68 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ip pim bsr

show ip pim bsr

Displays information about the elected BSR.
show ip pim bsr

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip pim bsr
BSR Address = 214.0.0.7
BSR Priority = 192,
Hash Mask Length = 30,
Expiry Time = 00h:01m:35s

output definitions
BSR Address The 32-bit address of the elected BSR.
BSR Priority The priority value of the elected BSR. The higher the value, the higher
the priority.
Hash Mask Length The 32-bit mask length that is advertised in the bootstrap messages by
the elected BSR (the length of the mask is used in the hash function
when computing the Rendezvous Point (RP) for a multicast group).
Expiry Time The minimum time remaining before the elected BSR will be declared
down.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-69
show ip pim bsr PIM Commands

Related Commands

ip pim cbsr Configures the Candidate-BSR information that is used in the

Bootstrap messages.

MIB Objects
alaPimBsrElectedBSRTable
alaPimBsrElectedBSRAddress
alaPimBsrElectedBSRPriority
alaPimBsrElectedBSRHashMaskLength
alaPimBsrElectedBSRExpiryTime

page 30-70 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ip pim notifications

show ip pim notifications

Displays the configuration of the configured notification periods as well as information on the events
triggering the notifications.
show ip pim notifications

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The outputs from this command includes both IPv4 and IPv6 information.

Examples
-> show ip pim notifications
Neighbor Loss Notifications
Period = 0
Count = 0
Invalid Register Notifications
Period = 65535
Msgs Rcvd = 0
Origin = None
Group = None
RP = None
Invalid Join Prune Notifications
Period = 65535
Msgs Rcvd = 0
Origin = None
Group = None
RP = None
RP Mapping Notifications
Period = 65535
Count = 0
Interface Election Notifications
Period = 65535
Count = 0

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-71
show ip pim notifications PIM Commands

output definitions
Neighbor Loss Notification Period: Minimum time interval that must elapse between the PIM
neighbor loss notification originated by the device.
Count: The number of neighbor loss events that have occurred. This
counter is incremented whenever a neighbor loss notification is
generated.
Invalid Register Notification Period: Minimum time interval that must elapse between the PIM
invalid register notifications originated by the device.
Msgs Rcvd: The number of invalid PIM register notification messages
that have been received by the device.
Group: The multicast group address to which the last unexpected
Register message received by the device was addressed.
RP: The RP address to which the last unexpected Register message
received by the device was delivered.
Origin: The source address of the last unexpected Register message
received by the device.
Invalid Join/Prune Period: Minimum time that must elapse between PIM invalid
Notification joinprune notifications originated by the device.
Msgs Rcvd: The number of invalid PIM join/prune messages that have
been received by the device.
Origin: The source address of the last unexpected join/prune message
received by the device.
Group: The multicast group address carried in the last unexpected
joinprune message received by the device.
RP: The RP address carried in the last unexpected join/prune message
received by the device.
RP Mapping Notifications Period: Minimum time that must elapse between PIM RP mapping
change notifications originated by the device.
Count: The number of changes to active RP mappings on this device.
Interface Election Period: Minimum time that must elapse between PIM Interface
Notifications Election traps originated by the router.
Count: The number of times this device has been elected DR on any
interface.

Release History
Release 8.1.1; command introduced.

page 30-72 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ip pim notifications

Related Commands

ip pim neighbor-loss- Specifies the minimum time that must elapse between PIM
notification-period neighbor loss notifications originated by the router.
ip pim invalid-register- Specifies the minimum time that must elapse between PIM invalid
notification-period register notifications originated by the router.
ip pim invalid-joinprune- Specifies the minimum time that must elapse between PIM invalid
notification-period joinprune notifications originated by the router.
ip pim rp-mapping- Specifies the minimum time that must elapse between PIM RP
notification-period mapping notifications originated by this router.
ip pim interface-election- Specifies the minimum time that must elapse between the PIM
notification-period interface election notifications originated by the router.

MIB Objects
alaPim
alaPimNeighborLossNotificationPeriod
alaPimNeighborLossCount
alaPimInvalidRegisterNotificationPeriod
alaPimInvalidRegisterMsgsRcvd
alaPimInvalidRegisterGroup
alaPimInvalidRegisterRp
alaPimInvalidJoinPruneNotificationPeriod
alaPimInvalidJoinPruneMsgsRcvd
alaPimInvalidJoinPruneOrigin
alaPimInvalidJoinPruneGroup
alaPimInvalidJoinPruneRP
alaPimRPMappingNotificationPeriod
alaPimRPMappingChangeCount
alaPimInterfaceElectionNotificationPeriod
alaPimInterfaceElectionWinCount

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-73
show ip pim groute PIM Commands

show ip pim groute

Displays all (*,G) state that the IPv4 PIM has.
show ip pim groute [group_address]

Syntax Definitions

group_address A 32-bit multicast address. If an IP address is not specified, the current

PIM status for all multicast route entries are displayed.

Defaults
By default, entire (*,G) routing table is displayed. To view more detailed (*,G) state information about a
particular group, specify the group address in the command line.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
When the group_address is specified in the command line, the detailed information displayed also
includes the detailed state of every outgoing interface.

Examples
-> show ip pim groute

Total 1 (*,G)

Group Address RP Address RPF Interface Upstream Neighbor UpTime

---------------+--------------+-------------------+-----------------+-----------
225.0.0.0 212.61.60.8 vlan-30 212.61.30.7 00h:01m:43s
225.0.0.1 212.61.60.8 vlan-30 212.61.30.7 00h:01m:43s

-> show ip pim groute 225.0.0.0

(*,225.0.0.0)
UpTime = 00h:01m:49s
RP Address = 212.61.60.8,
PIM Mode = ASM,
PIM Mode Origin = BSR,
Upstream Join State = Joined,
Upstream Join Timer = 00h:00m:11s,
Upstream Neighbor = 212.61.30.7,
RPF Interface = vlan-30,
RPF Next Hop = 212.61.30.7,
RPF Route Protocol = OSPF,
RPF Route Address = 212.61.60.0/24,
RPF Route Metric Pref = 110,
RPF Route Metric = 2,
Interface Specific State:
vlan-4
UpTime = 00h:01m:49s,

page 30-74 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ip pim groute

Local Membership = True,

Join/Prune State = No Info,
Prune Pending Timer = 00h:00m:00s,
Join Expiry Timer = 00h:00m:00s,
Assert State = No Info,
Assert Timer = 00h:00m:00s,
vlan-5
UpTime = 00h:00m:00s,
Local Membership = False,
Join/Prune State = No Info,
Prune Pending Timer = 00h:00m:00s,
Join Expiry Timer = 00h:00m:00s,
Assert State = No Info,
Assert Timer = 00h:00m:00s,
vlan-8
UpTime = 00h:00m:00s,
Local Membership = False,
Join/Prune State = No Info,
Prune Pending Timer = 00h:00m:00s,
Join Expiry Timer = 00h:00m:00s,
Assert State = No Info,
Assert Timer = 00h:00m:00s,
vlan-9
UpTime = 00h:00m:00s,
Local Membership = False,
Join/Prune State = No Info,
Prune Pending Timer = 00h:00m:00s,
Join Expiry Timer = 00h:00m:00s,
Assert State = No Info,
Assert Timer = 00h:00m:00s,
vlan-30
UpTime = 00h:00m:00s,
Local Membership = False,
Join/Prune State = No Info,
Prune Pending Timer = 00h:00m:00s,
Join Expiry Timer = 00h:00m:00s,
Assert State = No Info,
Assert Timer = 00h:00m:00s,

output definitions
Group-address The IPv4 Multicast Group Address.
RP Address The address of the Rendezvous Point (RP) for the group.
RPF Interface The RPF interface towards the RP. The ifIndex is converted to the if-
name for the display.
Upstream Neighbor The primary address of the neighbor on the RPF Interface to which the
local router is sending periodic (*,G) join messages.
UpTime The time since this entry was created.
Pim Mode Origin The mechanism by which the PIM mode and RP for the group were
learned.
Upstream Join State Whether the local router should join the RP tree for the group.
Upstream Join Timer The time remaining before the local router next sends a periodic (*,G)
Join message on the RPF IfIndex.
RPF Next Hop The address of the RPF next hop towards the RP.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-75
show ip pim groute PIM Commands

output definitions (continued)

RPF Route Protocol The routing mechanism through which the route used to find the RPF
interface towards the RP was learned.
RPF Route Address/Prefix The IPv6 address combined with the prefix length identifies the route
Length used to find the RPF interface towards the RP.
Route Metric Pref The metric preference of the route used to find the RPF interface
towards the RP.
Route Metric The routing metric of the route used to find the RPF interface towards
the RP.
Interface Name The interface name that corresponds to the ifIndex.
Local Membership Whether the local router has (*,G) local membership on this interface.
Join Prune State The state resulting from (*,G) Join/Prune messages received on this
interface.
Prune Pending Timer The time remaining before the local router acts on a (*,G) Prune
message received on this interface, during which the router is waiting to
see whether another downstream router will override the Prune
message.
Join Expiry Timer The time remaining before (*,G) Join state for this interface expires.
Assert State The (*,G) Assert state for this interface. The possible values are No
Info, Winner or Loser.
Assert Timer If Assert State is 'Winner', this is the time remaining before the local
router next sends a (*,G) Assert message on this interface. If the Assert
State is 'Loser', this is the time remaining before the (*,G) assert state
expires.
Assert Winner Address If the Assert State is 'Loser', this is the address of the assert winner.
Assert Winner Metric Pref If the Assert State is 'Loser', this is the metric preference of the route to
the RP advertised by the assert winner; otherwise, this is zero.
Assert Winner Metric If the Assert State is 'Loser', this is the routing metric of the route to the
RP advertised by the assert winner; otherwise, this is zero.

Release History
Release 8.1.1; command introduced.

Related Commands
N/A

page 30-76 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ip pim groute

MIB Objects
alaPimStarGTable
alaPimStarGGrpAddress
alaPimStarGRPAddress
alaPimStarGRPFIfIndex
alaPimStarGUpstreamNeighbor
alaPimStarGUpTime
alaPimStarGPimModeOrigin
alaPimStarGUpstreamJoinState
alaPimStarGUpstreamJoinTimer
alaPimStarGRPFNextHop
alaPimStarGRPFRouteProtocol
alaPimStarGRPFRouteAddress
alaPimStarGRPFRoutePrefixLength
alaPimStarGRPFRouteMetricPref
alaPimStarGRPFRouteMetric
alaPimStarGITable
alaPimStarGIIfIndex
alaPimStarGILocalMembership
alaPimStarGIJoinPruneState
alaPimStarGIPrunePendingTimer
alaPimStarGIPrunePendingTimer
alaPimStarGIAssertState
alaPimStarGIAssertTimer
alaPimStarGIAssertWinnerAddress
alaPimStarGIAssertWinnerAddress
alaPimStarGIAssertWinnerMetric

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-77
show ip pim sgroute PIM Commands

show ip pim sgroute

Displays all (S,G) state that the IPv4 PIM has.
show ip pim sgroute [source_address group_address]

Syntax Definitions

source_address The 32-bit IP address for a specific multicast source.

group_address A 32-bit multicast address.

Defaults
By default, entire (S,G) routing table is displayed. To view the detailed information for a particular (S,G)
entry, use the source_address and group_address associated with that entry.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When the source_address and group_address is specified in the command line, the detailed
information displayed also includes the detailed state of every outgoing interface.
• If an IP address is not specified, the current PIM status for all multicast route entries are displayed.

Examples
-> show ip pim sgroute
Legend: Flags: D = Dense, S = Sparse, s = SSM Group,
L = Local, R = RPT, T = SPT, F = Register,
P = Pruned, O = Originator
Total 1 (S,G)

Source Address Group Address RPF Interface Upstream Neighbor UpTime Flags
--------------+-------------+--------------+-----------------+-----------+--------
172.21.63.2 225.0.0.0 vlan-30 212.61.30.7 00h:02m:09s ST
172.21.63.2 225.0.0.1 vlan-30 212.61.30.7 00h:02m:09s ST

-> show ip pim sgroute 172.21.63.2 225.0.0.0

(172.21.63.2,225.0.0.0)
UpTime = 00h:02m:16s
PIM Mode = ASM,
Upstream Join State = Joined,
Upstream RPT State = Not Pruned,
Upstream Join Timer = 00h:00m:44s,
Upstream Neighbor = 212.61.30.7,
RPF Interface = vlan-30,
RPF Next Hop = 212.61.30.7,
RPF Route Protocol = OSPF,
RPF Route Address = 172.21.63.0/24,
RPF Route Metric Pref = 110,
RPF Route Metric = 2,

page 30-78 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ip pim sgroute

SPT Bit = True,

DR Register State = No Info,
DR Register Stop Timer = 00h:00m:00s,
Interface Specific State:
vlan-4
UpTime = 00h:02m:16s,
Local Membership = True,
Join/Prune State = No Info,
RPT State = No Info,
Prune Pending Timer = 00h:00m:00s,
Join Expiry Timer = 00h:00m:00s,
Assert State = No Info,
Assert Timer = 00h:00m:00s,
vlan-5
UpTime = 00h:00m:00s,
Local Membership = False,
Join/Prune State = No Info,
RPT State = No Info,
Prune Pending Timer = 00h:00m:00s,
Join Expiry Timer = 00h:00m:00s,
Assert State = No Info,
Assert Timer = 00h:00m:00s,
vlan-8
UpTime = 00h:00m:00s,
Local Membership = False,
Join/Prune State = No Info,
RPT State = No Info,
Prune Pending Timer = 00h:00m:00s,
Join Expiry Timer = 00h:00m:00s,
Assert State = No Info,
Assert Timer = 00h:00m:00s,
vlan-9
UpTime = 00h:00m:00s,
Local Membership = False,
Join/Prune State = No Info,
RPT State = No Info,
Prune Pending Timer = 00h:00m:00s,
Join Expiry Timer = 00h:00m:00s,
Assert State = No Info,
Assert Timer = 00h:00m:00s,
vlan-30
UpTime = 00h:00m:00s,
Local Membership = False,
Join/Prune State = No Info,
RPT State = No Info,
Prune Pending Timer = 00h:00m:00s,
Join Expiry Timer = 00h:00m:00s,
Assert State = No Info,
Assert Timer = 00h:00m:00s,

output definitions
Source-address The IPv4 Source address.
Group-address The IPv4 Multicast Group Address.
RPF Interface The RPF interface towards the RP. The ifIndex is converted to the if-
name for the display.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-79
show ip pim sgroute PIM Commands

output definitions (continued)

Upstream Neighbor The primary address of the neighbor on the RPF Interface to which the
local router is sending periodic (S,G) join messages.
UpTime The time since this entry was created.
Flags Flags indicating SPTBit, Prune State, Join State, etc.
Pim Mode Whether the Group Address is SSM, ASM or DM.
Upstream Join State Whether the local router should join the SPT for the source and group
represented by this entry.
Upstream Join Timer The time remaining before the local router next sends a periodic (S,G)
Join message.
RPF Next Hop The address of the RPF next hop towards the source.
RPF Route Protocol The routing mechanism through which the route used to find the RPF
Interface towards the source was learned.
RPF Route Address/Prefix The IP address which when combined with the Route Prefix length
Length identifies the route used to find the RPF interface towards the source.
RPF Route Metric Pref The metric preference of the route used to find the RPF interface
towards the source.
RPF Route Metric The metric preference of the route used to find the RPF interface
towards the source.
DR Register State Whether the local router should encapsulate (S,G) data packets in
Register messages and send them to the RP. The possible values
include No Info, Join, Join Pending, or Prune.
DR Register Stop Timer The value of the Register Stop Timer. If the Register State is 'prune',
this is the time remaining before the local router sends a Null-Register
message to the RP. If the State is 'joinPending', this is the time
remaining before the local router resumes encapsulating data packets
and sending them to the RP.
Upstream Prune State Whether the local router has pruned itself from the tree. This is only
used by PIM-DM. The possible values include forwarding, Ack
Pending, or Pruned.
Upstream Prune Limit Timer The time remaining before the local router may send a (S,G) prune
message on alaPimSGRPFIfIndex. This is only used by PIM-DM.
Originator State Whether this router is an originator for the (S,G) message flow. This is
only used by PIM-DM. The possible values include Not Originator or
Originator.
Source Active Timer If this router is the Originator, this is the time remaining before the
local router reverts to notOriginator state. Otherwise, this is zero. This
is only used by PIM-DM.
State Refresh Timer If Originator state is 'originator', this is the time remaining before the
local router sends a State Refresh Message. Otherwise, this is zero. This
is only used by PIM-DM.
Interface Name The interface name corresponding to the ifIndex that corresponds to
this entry.
Uptime The time since this entry was created.
Local Membership Whether the local router has (S,G) local membership on this interface.

page 30-80 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ip pim sgroute

output definitions (continued)

Join Prune State The state resulting from (S,G) Join/Prune messages received on this
interface. The possible values include No Info, Join, or Prune Pending.
Prune Pending Timer The time remaining before the local router acts on an (S,G) Prune
message received on this interface, during which the router is waiting to
see whether another downstream router will override the Prune
message.
Join Expiry Timer The time remaining before (S,G) Join state for this interface expires.
Assert State The (S,G) Assert state for this interface. The possible values include No
Info, Winner, or Loser.
Assert Timer If Assert State is Winner, this is the time remaining before the local
router sends a (S,G) Assert message on this interface. If the Assert State
is Loser, this is the time remaining before the (S,G) Assert state expires.
Assert Winner If the Assert State is Loser, this is the address of the assert winner.
Assert Winner Metric Pref If the Assert State is Loser, this is the metric preference of the route to
the source advertised by the assert winner.
Assert Winner Metric Metric If the Assert State is Loser, this is the routing metric of the route to the
source advertised by the assert winner.

Release History
Release 8.1.1; command introduced.

Related Commands
N/A

MIB Objects
alaPimSGTable
alaPimSGSrcAddress
alaPimSGGrpAddress
alaPimSGRPFIfIndex
alaPimSGUpstreamNeighbor
alaPimSGUpTime
alaPimSGSPTBit
alaPimSGUpstreamPruneState
alaPimSGUpstreamJoinState
alaPimSGPimMode
alaPimSGUpstreamJoinState
alaPimSGUpstreamJoinTimer
alaPimSGRPFNextHop
alaPimSGRPFRouteProtocol
alaPimSGRPFRouteAddress
alaPimSGRPFRoutePrefixLength
alaPimSGRPFRouteMetricPref
alaPimSGRPFRouteMetric
alaPimSGDRRegisterState
alaPimSGDRRegisterStopTimer
alaPimSGUpstreamPruneState
alaPimSGUpstreamPruneLimitTimer
alaPimSGOriginatorState

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-81
show ip pim sgroute PIM Commands

alaPimSGSourceActiveTimer
alaPimSGStateRefreshTimer
alaPimSGITable
alaPimSGIIfIndex
alaPimSGIUpTime
alaPimSGILocalMembership
alaPimSGIJoinPruneState
alaPimSGIPrunePendingTimer
alaPimSGIJoinExpiryTimer
alaPimSGIAssertState
alaPimSGIAssertTimer
alaPimSGIAssertWinnerAddress
alaPimSGIAssertWinnerMetricPref
alaPimSGIAssertWinnerMetric

page 30-82 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ipv6 pim sparse admin-state

ipv6 pim sparse admin-state

Enables or disables the IPv6 PIM-SM (sparse mode) globally for IPv6.
ipv6 pim sparse admin-state {enable | disable}

Syntax Definitions

enable Enables PIM-SM globally for IPv6.

disable Disables PIM-SM globally for IPv6.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command must be set to enable before PIM-SM can run on the switch. In addition, the ip load pim
command must be executed. Refer to page 30-3 for more information.

Examples
-> ipv6 pim sparse admin-state enable
-> ipv6 pim sparse admin-state disable

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 pim interface Enables or disables the PIM protocol on a specific interface.
ip load pim Dynamically loads PIM to memory.
show ipv6 pim sparse Displays the status of the various global parameters for the IPv6
PIM sparse mode.

MIB Objects
alaPimsmGlobalConfig
alaPimsmV6AdminStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-83
ipv6 pim dense admin-state PIM Commands

ipv6 pim dense admin-state

Enables or disables the IPv6 PIM-DM (dense mode) globally for IPv6.
ipv6 pim dense admin-state {enable | disable}

Syntax Definitions

enable Enables PIM-DM globally for IPv6.

disable Disables PIM-DM globally for IPv6.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command must be set to enable before PIM-DM can run on the switch. In addition, the ip load pim
command must be executed. Refer to page 30-3 for more information.

Examples
-> ipv6 pim dense admin-state enable
-> ipv6 pim dense admin-state disable

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 pim interface Enables or disables the PIM protocol on a specific interface.
ip load pim Dynamically loads PIM to memory.
show ipv6 pim dense Displays the status of the various global parameters for the IPv6
PIM dense mode.

MIB Objects
alaPimdmGlobalConfig
alaPimdmV6AdminStatus

page 30-84 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ipv6 pim ssm group

ipv6 pim ssm group

Statically maps the specified IPv6 multicast group to the PIM Source Specific Multicast mode (SSM).
ipv6 pim ssm group group_address/prefix_length [[no] override] [priority priority]
no ipv6 pim ssm group group_address/prefix_length

Syntax Definitions

group_address Specifies the IPv6 multicast group address.

/prefix_length Specifies the prefix length of the IPv6 multicast group. Values may
range from 4 to 128.
override Specifies the static SSM mode mapping configuration to override the
dynamically learned group mapping information for the specified group.
priority Specifies the preference value to be used for this static SSM mode
configuration and provides fine control over which configuration is
overridden by this static configuration. Values may range from 0 to 128.

Defaults
By default, the priority option is not set and the override option is set to false.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a static configuration of a Source Specific Multicast mode
group mapping.
• The IPv6 PIM Source-Specific Multicast (SSM) mode for the default SSM address range (FF3x::/32)
reserved by the Internet Assigned Numbers Authority is not enabled automatically and must be
configured manually to support SSM.
• You can also map additional IPv6 multicast address ranges for the SSM group using this command.
However, the IPv6 multicast groups in the reserved address range can be mapped only to the SSM
mode.
• If the group prefixes configured for two or more rows in this table overlap, the row with the greatest
prefix length value is used for the overlapping range
• Specifying the priority value obsoletes the override option and once the priority option has been
defined, a value of 65535 can be used to un-set the priority.

Examples
-> ipv6 pim ssm group ff30::1234:abcd/128 priority 50
-> no ipv6 pim ssm group ff30::1234:abcd/128

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-85
ipv6 pim ssm group PIM Commands

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 pim group-map Displays the IPv6 PIM group mapping table.
show ipv6 pim ssm group Displays the static configuration of IPv6 multicast group mappings
for PIM-Source Specific Multicast (SSM).

MIB Objects
alaPimStaticRPTable
alaPimStaticRPGrpAddress
alaPimStaticRPGrpPrefixLength
alaPimStaticRPOverrideDynamic
alaPimStaticRPPrecedence
alaPimStaticRPRowStatus

page 30-86 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ipv6 pim dense group

ipv6 pim dense group

Statically maps the specified IPv6 multicast group to the PIM Dense mode (DM).
ipv6 pim dense group group_address/prefix_length [[no] override] [priority priority]
no ipv6 pim dense group group_address/prefix_length

Syntax Definitions

group_address Specifies the IPv6 multicast group address.

/prefix_length Specifies the prefix length of the IPv6 multicast group.
override Specifies the static dense mode mapping configuration to override the
dynamically learned group mapping information for the specified group.
priority Specifies the preference value to be used for this static configuration and
provides fine control over which configuration is overridden by this
static configuration. Values may range from 0 to 128.

Defaults
By default, the priority option is not set and the override option is set to false.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a static configuration of a dense mode group mapping.

• This command specifies the mode as Dense (PIM-DM) for the specified IPv6 multicast group
addresses.
• If the group prefixes configured for two or more rows in this table overlap, the row with the greatest
prefix length value is used for the overlapping range.
• Specifying the priority value obsoletes the override option and once the priority option has been
defined, a value of 65535 can be used to un-set the priority.

Examples
-> ipv6 pim dense group ff0e::1234/128 priority 50
-> no ipv6 pim dense group ff0e::1234/128

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-87
ipv6 pim dense group PIM Commands

Related Commands

show ipv6 pim group-map Displays the IPv6 PIM group mapping table.
show ipv6 pim dense group Displays the static configuration of IPv6 multicast group mappings
for PIM Dense Mode (DM).

MIB Objects
alaPimStaticRPTable
alaPimStaticRPGrpAddress
alaPimStaticRPGrpPrefixLength
alaPimStaticRPOverrideDynamic
alaPimStaticRPPrecedence
alaPimStaticRPRowStatus

page 30-88 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ipv6 pim cbsr

ipv6 pim cbsr

Configures the local router as the Candidate-BSR for the PIM domain.
ipv6 pim cbsr ipv6_address [priority priority] [mask-length bits]
no ipv6 pim cbsr ipv6_address

Syntax Definitions

ipv6_address The IPv6 unicast address that the local router will use to advertise itself
as a Candidate-BSR. The specified address must be a domain-wide
reachable address.
priority The priority value of the local router as a Candidate-BSR. Values may
range from 0 to255.
bits The hash mask length that is advertised in the bootstrap messages for
IPv6 PIM (the length of the mask is used in the hash function when
computing the Rendezvous Point (RP) for a multicast group). Values
may range from 1 to 128.

Defaults

parameter default
priority 64
bits 126

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the association of the device as a Candidate-BSR for a
PIM domain.
• This command is supported only in the sparse mode.

• The information configured using this command is used in the Bootstrap messages.

• Candidate-BSRs also avoid a single point of failure in a PIM domain.

Examples
-> ipv6 pim cbsr 2000::1 priority 100 mask-length 4
-> no ipv6 pim cbsr 2000::1

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-89
ipv6 pim cbsr PIM Commands

Related Commands

show ipv6 pim cbsr Displays the IPv6 Candidate-BSR information that is used in the
Bootstrap messages.

MIB Objects
alaPimBsrCandidateBSRTable
alaPimBsrCandidateBSRAddress
alaPimBsrCandidateBSRPriority
alaPimBsrCandidateBSRHashMaskLength
alaPimBsrCandidateBSRRowStatus

page 30-90 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ipv6 pim static-rp

ipv6 pim static-rp

Adds, modifies, or deletes a static RP for an IPv6 multicast group (“modifies” applies only to the RP
address, since the table is indexed from group address and prefix length parameters).
ipv6 pim static-rp group_address/prefix_length rp_address [[no] override] [priority priority]
no ipv6 pim static-rp group_address/prefix_length rp_address

Syntax Definitions

group_address Specifies the IPv6 multicast group address.

/prefix_length Specifies the prefix length of the IPv6 multicast group.
rp_address Specifies the IPv6 unicast address of the Rendezvous Point (RP). This
must be a domain-wide reachable address.
override Specifies the static RP configuration to override the dynamically learned
RP information for the specified group.
priority Specifies the preference value to be used for this static RP configuration
and provides fine control over which configuration is overridden by this
static configuration. Values may range from 0 to 128.

Defaults
By default, the priority option is not set and the override option is set to false.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete a static RP configuration.

• Specifying the priority value obsoletes the override option.

• The IPv6 PIM Source-Specific Multicast (SSM) mode for the default SSM address range (FF3x::/32)
reserved by the Internet Assigned Numbers Authority is not enabled automatically and must be
configured manually to support SSM. You can also map additional IPv6 multicast address ranges for
the SSM group. However, the IPv6 multicast groups in the reserved address range can be mapped only
to the SSM mode.
• If the group prefixes configured for two or more rows in this table overlap, the row with the greatest
prefix length value is used for the overlapping range
• Note that once the priority option has been defined, a value of 65535 can be used to un-set the priority

• This command is supported only in the sparse mode.

Examples
-> ipv6 pim static-rp ff0e::1234/128 2000::1 priority 10
-> no ipv6 pim static-rp ff0e::1234/128 2000::1

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-91
ipv6 pim static-rp PIM Commands

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 pim group-map Displays the IPv6 PIM group mapping table.
show ipv6 pim static-rp Displays the IPv6 PIM Static RP table, which includes IPv6
multicast group address/prefix length, the static Rendezvous Point
(RP) address, and the current status of the Static RP configuration
(i.e., enabled or disabled).

MIB Objects
alaPimStaticRPTable
alaPimStaticRPGrpAddress
alaPimStaticRPGrpPrefixLength
alaPimStaticRPRPAddress
alaPimStaticRPOverrideDynamic
alaPimStaticRPPrecedence
alaPimStaticRPRowStatus

page 30-92 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ipv6 pim candidate-rp

ipv6 pim candidate-rp

Configures the local router as the Candidate-Rendezvous Point (C-RP) for a specified IPv6 multicast
group.
ipv6 pim candidate-rp rp_address group_address/prefix_length [priority priority] [interval seconds]
no ipv6 pim candidate-rp rp_address group_address/prefix_length

Syntax Definitions

rp_address Specifies the IPv6 unicast address that will be advertised as a Candidate-
RP. This must be a domain-wide reachable address.
group_address Specifies the IPv6 multicast group address for which the local router
will advertise itself as a Candidate-RP.
/prefix_length Specifies the prefix length of the specified IPv6 multicast group address.
priority Specifies the priority value of the Candidate-RP. Values may range
from 0 to 192. The lower the value, the higher the priority.
seconds Specifies the interval at which the C-RP advertisements are sent to the
bootstrap router, in seconds. Values may range from 1 to 300.

Defaults

parameter default
priority 192
seconds 60

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the association of the device as a C-RP for a particular
multicast group.
• Only one RP address is supported per switch. If multiple candidate-RP entries are defined, they must
specify the same rp-address.
• This command is supported only in the sparse mode.

Examples
-> ipv6 pim candidate-rp 2000::1 ff0e::1234/128 priority 100 interval 100
-> no ipv6 pim candidate-rp 2000::1 ff0e::1234/128

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-93
ipv6 pim candidate-rp PIM Commands

Related Commands

show ipv6 pim candidate-rp Displays the IPv6 multicast groups for which the local router will
advertise itself as a Candidate-RP.

MIB Objects
alaPimBsrCandidateRPTable
alaPimBsrCandidateRPAddress
alaPimBsrCandidateRPGroupAddress
alaPimBsrCandidateRPGroupPrefixLength
alaPimBSrCandidateRPPriority
alaPimBsrCandidateRPAdvInterval
alaPimBsrCandidateRPRowStatus

page 30-94 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ipv6 pim rp-switchover

ipv6 pim rp-switchover

Enables or disables an RP to attempt switching to native forwarding upon receiving the first register-
encapsulated packet in the IPv6 PIM domain.
ipv6 pim rp-switchover {enable | disable}

Syntax Definitions

enable Enables the RP to switch to native forwarding.

disable Disables the RP from switching to native forwarding.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• You cannot specify a pre-configured threshold, such as the RP threshold, as you would do for IPv4
PIM.
• This command is supported only in the sparse mode.

Examples
-> ipv6 pim rp-switchover enable
-> ipv6 pim rp-switchover disable

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 pim sparse Displays the status of the various global parameters for the IPv6
PIM sparse mode.

MIB Objects
alaPimsmGlobalConfig
alaPimsmV6RPSwitchover

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-95
ipv6 pim spt admin-state PIM Commands

ipv6 pim spt admin-state

Enables or disables last hop Designated Router (DR) switching to the Shortest Path Tree (SPT).
ipv6 pim spt admin-state {enable | disable}

Syntax Definitions

enable Enables last hop DR switching to the SPT.

disable Disables last hop DR switching to the SPT.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is supported only in the sparse mode.

• If the SPT status is enabled, last hop DR switching to the SPT begins once the first data packet is
received.

Examples
-> ipv6 pim spt admin-state enable
-> ipv6 pim spt admin-state disable

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 pim sparse Displays the status of the various global parameters for the IPv6
PIM sparse mode.

MIB Objects
alaPimsmGlobalConfig
alaPimsmV6SPTConfig

page 30-96 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ipv6 pim interface

ipv6 pim interface

Enables IPv6 PIM and configures the statistics such as hello-interval, triggered-hello, hello-holdtime,
joinprune, prune-delay, override-interval, dr-priority, stub interface, prune limit interval, and graft retry
interval on the IPv6 interface.
ipv6 pim interface if_name [hello-interval seconds] [triggered-hello seconds] [joinprune-interval
seconds] [hello-holdtime seconds] [joinprune-holdtime seconds] [prune-delay milliseconds] [override-
interval milliseconds] [dr-priority priority] [[no] stub] [prune-limit-interval seconds] [graft-retry-
interval seconds]
no ipv6 pim interface if_name

Syntax Definitions

if_name The interface name on which the IPv6 PIM is being enabled or disabled.
hello-interval seconds The frequency at which IPv6 PIM Hello messages are transmitted on
this interface, in seconds. Values may range from 0 to 18000.
triggered-hello seconds Specifies the maximum time, in seconds, before a triggered IPv6 PIM
Hello message is sent on this interface. Values may range from 0 to 60.
joinprune-interval seconds The frequency at which periodic IPv6 PIM Join/Prune messages are sent
on this interface, in seconds. Values may range from 0 to 18000.
hello-holdtime seconds Specifies the value of the IPv6 PIM hello-holdtime for this interface.
This value is set in the Holdtime field of IPv6 PIM Hello messages sent
on this interface, in seconds. Values may range from 0 to 65535.
joinprune-holdtime seconds Specifies the value that is set in the Holdtime field of the IPv6 PIM
Joinprune messages sent on this interface, in seconds.Values may range
from 0 to 65535.
prune-delay milliseconds Specifies the value of the expected propagation delay between IPv6 PIM
routers on this network, inserted into the LAN prune-delay option of the
IPv6 PIM Hello messages sent on this interface, in milliseconds. Values
may range from 0 to 32767.
override-interval milliseconds Specifies the value set in the Override Interval field of the LAN prune-
delay option of the IPv6 PIM Hello messages sent on this interface, if
the prune-delay status is enabled, in milliseconds. Values may range
from 0 to 65535.
dr-priority priority Specifies the Designated Router priority set in the DR priority option on
this interface. The DR priority option value (1–192). A higher numeric
value denotes a higher priority.
prune-limit-interval seconds Specifies the minimum interval that must elapse between two successive
IPv6 PIM prune messages sent on this interface, in seconds. Values may
range from 0 to 65535.
graft-retry-interval seconds Specifies the minimum interval that must elapse between two successive
IPv6 PIM graft messages sent on this interface, in seconds. Values may
range from 0 to 65535.
stub Specifies the interface not to send any IPv6 PIM packets through this
interface, and to ignore received IPv6 PIM packets.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-97
ipv6 pim interface PIM Commands

Defaults

parameter default
hello-interval seconds 30
triggered-hello seconds 5
joinprune-interval seconds 60
hello-holdtime seconds 105
joinprune-holdtime seconds 210
prune-delay milliseconds 500
override-interval milliseconds 2500
dr-priority priority 1
prune-limit-interval seconds 60
graft-retry-interval seconds 3
stub Disabled

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete an IPv6 PIM interface.

• IPv6 PIM must be enabled globally on the switch before IPv6 PIM will begin running on the interface.
To globally enable or disable IPv6 PIM-SM on the switch, refer to the ipv6 pim sparse admin-state
command on page 30-83. To enable or disable IPv6 PIM-DM on the switch, refer to the ipv6 pim
dense admin-state command on page 30-84.
• Specifying zero for IPv6 PIM hello-interval represents an infinite time, in which case the periodic IPv6
PIM hello messages are not sent.
• Specifying zero for IPv6 PIM joinprune-interval represents an infinite time, in which case the periodic
IPv6 PIM joinprune messages are not sent.
• Specifying the value of 65535 for IPv6 PIM hello-holdtime represents an infinite time. If an IPv6 PIM
router gets IPv6 PIM Hello packet from a neighbor with its hello-holdtime value as infinte time, then
the router will not time out the sender(neighbor). It is recommended that you use an IPv6 PIM hello-
holdtime interval that is 3.5 times the value of the IPv6 PIM hello-interval, or 65535 seconds if the
IPv6 PIM hello-interval is set to zero
• Specifying the value of 65535 for IPv6 PIM joinprune-holdtime represents an infinite time. The receipt
of IPv6 Join/Prune messages with its joinprune-holdtime value as infinte time, then this specifies an
infinite holdtime for the particular IPv6 join/prune message. It is recommended that you use a
joinprune- holdtime interval that is 3.5 times the value of the IPv6 PIM Join/Prune interval defined for
the interface, or 65535 seconds if the IPv6 PIM joinprune-interval is set to zero.
• The interface configured as a stub will not send any IPv6 PIM packets through that interface, and any
received IPv6 PIM packets are also ignored. By default, an IPv6 PIM interface is not set to be a stub
one.

page 30-98 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands ipv6 pim interface

• The IPv6 PIM graft-retry-interval and prune-limit-interval options can be used only with the IPv6
PIM-DM mode.

Examples
-> ipv6 pim interface vlan-2 hello-interval 100 triggered-hello 10 joinprune-
interval 100 hello-holdtime 350 joinprune-holdtime 400
-> no ipv6 pim interface vlan-2

Release History
Release 8.1.1; command introduced.
Related Command

show ipv6 pim interface Displays detailed IPv6 PIM settings for a specific interface.

MIB Objects
alaPimInterfaceTable
alaPimInterfaceIfIndex
alaPimInterfaceStatus
alaPimInterfaceHelloInterval
alaPimInterfaceTrigHelloInterval
alaPimInterfaceJoinPruneInterval
alaPimInterfaceHelloHoldtime
alaPimInterfaceJoinPruneHoldtime
alaPimInterfacePropagationDelay
alaPimInterfaceOverrideInterval
alaPimInerfaceDRPriority
alaPimInterfaceStubInterface
alaPimInterfacePruneLimitInterval
alaPimInterfaceGraftRetryInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-99
show ipv6 pim sparse PIM Commands

show ipv6 pim sparse

Displays the status of the various global parameters for the IPv6 PIM sparse mode.
show ipv6 pim sparse

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 pim sparse
Status = enabled,
Keepalive Period = 210,
Max RPs = 32,
Probe Time = 5,
Register Suppress Timeout = 60,
RP Switchover = enabled,
SPT Status = enabled,

output definitions
Status The current global (i.e., switch-wide) status of the IPv6 PIM sparse
mode. Options include enabled and disabled.
Keepalive Period The duration of the Keepalive timer. The default value is 210.
Max RPs The maximum number of Rendezvous Points (RPs) allowed in the IPv6
PIM-SM domain (1–100). The default value is 32.
Probe Time The amount of time before the Register Suppression timer expires, at
which point the Designated Router (DR) sends a Null Register message
to the Rendezvous Point (RP). This allows the RP to refresh the
Register-Stop. If the Register Suppression timer expires, the DR will
resume encapsulating packets from the source to the RP. Values may
range from 1 to 300. The default value is 5.
Register Suppress Timeout The amount of time, in seconds, the Designated Router (DR) will stop
sending registers to the Rendezvous Point (RP) once a Register-Stop is
received (1–300). The default value is 60.

page 30-100 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ipv6 pim sparse

output definitions
RP switchover The current status of the RP Switchover capability. RP switchover
enables or disables an RP to attempt switching to native forwarding
upon receiving the first register-encapsulated data packet. Options
include enabled and disabled. The default setting is enabled.
SPT Status The current status of last hop Designated Router (DR) switching to the
Shortest Path Tree (SPT). Options include enabled and disabled.
The default setting is enabled.

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 pim rp-switchover Enables or disables an RP to attempt switching to native forwarding

upon receiving the first register-encapsulated packet in the IPv6
PIM domain.
ipv6 pim spt admin-state Enables or disables last hop Designated Router (DR) switching to
the Shortest Path Tree (SPT). If enabled, last hop DR switching to
the SPT begins once the first multicast data packet is received.
ipv6 pim sparse admin-state Enables or disables the IPv6 PIM-SM (sparse mode) globally for
IPv6.
ipv6 pim interface Enables IPv6 PIM and configures statistics such as hello-interval,
triggered-hello, hello-holdtime, joinprune, prune-delay, override-
interval, dr-priority, stub interface, prune limit interval, and graft
retry interval on the interface.
ip pim max-rps Configures the maximum number of C-RP routers allowed in the
PIM-SM domain.
ip pim probe-time Configures the amount of time before the Register Suppression
timer expires, at which point the Designated Router (DR) sends a
Null Register message to the Rendezvous Point (RP). This allows
the RP to refresh the Register-Stop. If the Register Suppression
timer expires, the DR will resume encapsulating packets from the
source to the RP.
ip pim register-suppress- Specifies the period during which a Designated Router (DR) stops
timeout sending Register-encapsulated packets to the Rendezvous Point
(RP) after receiving a Register-Stop message.

MIB Objects
alaPimsmGlobalConfig
alaPimsmV6AdminStatus
alaPimKeepalivePeriod
alaPimsmMaxRPS
alaPimsmProbeTime
alaPimRegisterSuppressionTime
alaPimsmV6RPSwitchover
alaPimsmV6AdminSPTConfig

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-101
show ipv6 pim dense PIM Commands

show ipv6 pim dense

Displays the status of the various global parameters for the IPv6 PIM dense mode.
show ipv6 pim dense

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show IPv6 pim dense
Status = enabled,
Source Lifetime = 210,
State Refresh Interval = 60,
State Refresh Limit Interval = 0,
State Refresh TTL = 16

output definitions
Status The current global (i.e., switch-wide) status of the IPv6 PIM dense
mode. Options include enabled and disabled.
Source Lifetime The duration of the Keepalive or Source Lifetime timer. The default
value is 210.
State Refresh Interval The time-interval, in seconds, between successive State Refresh
messages originated by the router. The default value is 60.
State Refresh Limit Interval Displays the limit at which a router will not forward the State Refresh
messages, if they are received at less than the interval. The default
value is 0.
State Refresh TTL Displays the TTL to be used in the router’s originated State Refresh
messages. The default value is 16.

Release History
Release 8.1.1; command introduced.

page 30-102 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ipv6 pim dense

Related Commands

ipv6 pim dense admin-state Enables or disables IPv6 PIM-DM (dense mode) globally on the
switch.
ip pim keepalive-period Configures the period during which the (S,G) Join state will be
maintained in the absence of (S,G) Join messages or explicit (S,G)
local membership.
ip pim state-refresh-interval Sets the interval between successive State Refresh messages
originated by a router.
ip pim state-refresh-limit Sets the limit at which a router will not forward successive State
Refresh messages if they are received at less than the interval.
ip pim state-refresh-ttl Sets the Time to Live to be used in a router’s originated State
Refresh messages if the data packet’s Time to Live is not recorded.

MIB Objects
alaPimdmGlobalConfig
alaPimdmV6AdminStatus
alaPimKeepalivePeriod
alaPimRefreshInterval
alaPimdmStateRefreshLimitInterval
alaPimdmStateRefreshTimeToLive

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-103
show ipv6 pim ssm group PIM Commands

show ipv6 pim ssm group

Displays the static configuration of IPv6 multicast group mappings for PIM-Source Specific Multicast
(SSM).
show ipv6 pim ssm group

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If the group prefixes configured for two or more rows in this table overlap, the row with the greatest prefix
length value is used for the overlapping range.

Examples
-> show ipv6 pim ssm group

Group Address/Pref Length Mode Override Precedence Status

---------------------------+-----+--------+----------+--------
ff00::/8 ssm false none enabled
ff34::/32 ssm false none enabled

output definitions
Group Address/Pref Length The IPv6 multicast group address along with the prefix length.
Mode The IPv6 PIM mode that is used for the groups in this prefix.
Override Specifies this static RP configuration to override the dynamically
learned RP information for the specified group.
Precedence The precedence value that can be used for this static RP configuration.
Status Displays whether this entry is currently enabled or disabled. Options
include enabled and disabled.

Release History
Release 8.1.1; command introduced.

page 30-104 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ipv6 pim ssm group

Related Commands

ipv6 pim ssm group Statically maps the specified IPv6 multicast group to the PIM
Source Specific Multicast mode (SSM).

MIB Objects
alaPimStaticRPTable
alaPimStaticRPGrpAddress
alaPimStaticRPGrpPrefixLength
alaPimStaticRPPimMode
alaPimStaticRPOverrideDynamic
alaPimStaticRPPrecedence
alaPimStaticRPRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-105
show ipv6 pim dense group PIM Commands

show ipv6 pim dense group

Displays the static configuration of IPv6 multicast group mappings for PIM Dense Mode (DM).
show ipv6 pim dense group

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If the group prefixes configured for two or more rows in this table overlap, the row with the greatest prefix
length value is used for the overlapping range.

Examples
-> show ipv6 pim dense group
Group Address/Pref Length Mode Override Precedence Status
---------------------------+-----+--------+----------+--------
ff00::/8 dm false none enabled
ff34::/32 dm false none enabled

output definitions
Group Address/Pref Length The IPv6 multicast group address along with the prefix length.
Mode The IPv6 PIM mode that is used for the groups in this prefix.
Override Specifies this static RP configuration to override the dynamically
learned RP information for the specified group.
Precedence The precedence value that can be used for this static RP configuration.
Status Displays whether this entry is currently enabled or disabled. Options
include enabled and disabled.

Release History
Release 8.1.1; command introduced.

page 30-106 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ipv6 pim dense group

Related Commands

ipv6 pim dense group Statically maps the specified IPv6 multicast group to the PIM Dense
mode (DM).

MIB Objects
alaPimStaticRPTable
alaPimStaticRPRowStatus
alaPimStaticRPGrpPrefixLength
alaPimStaticRPPimMode
alaPimStaticRPOverrideDynamic
alaPimStaticRPPrecedence
alaPimStaticRPGrpAddress

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-107
show ipv6 pim interface PIM Commands

show ipv6 pim interface

Displays detailed IPv6 PIM settings for a specific interface. In general, it displays IPv6 PIM settings for all
the interfaces if no argument is specified.
show ipv6 pim interface [if_name]

Syntax Definitions

if_name The name of the interface.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
To view more detailed information about a particular interface, specify the interface name in the command
line. Additional information includes Triggered Hello Interval, Hello Holdtime, Prune Delay status and
value, Override Interval, LAN Delay status, Generation ID status, and Join/Prune Holdtime.

Examples
-> show ipv6 pim interface

Interface Name Designated Hello Join/Prune Oper

Router Interval Interval Status
--------------------+--------------------------+--------+----------+---------
vlan-5 fe80::2d0:95ff:feac:a537 30 60 enabled
vlan-30 fe80::2d0:95ff:feac:a537 30 60 disabled
vlan-40 fe80::2d0:95ff:fee2:6eec 30 60 enabled

-> show ipv6 pim interface vlan-5

Interface Name = vlan-5,
IP Address = fe80::2d0:95ff:fee2:6eec,
Designated Router = fe80::2d0:95ff:fee2:a537,
Hello Interval = 30,
Triggered Hello Interval = 5,
Hello HoldTime = 105,
Join/Prune Interval = 60,
Join/Prune HoldTime = 210,
Propagation (Prune) Delay = 500,
Override Interval = 2500,
Generation ID = 0x4717be4d,
DR Priority = 1,
DR Priority Enabled = true,
Lan Delay Enabled = true,
Effective Propagation Delay = 500,
Effective Override Interval = 2500,
Suppression Enabled = true,

page 30-108 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ipv6 pim interface

Stub Interface = false,

Prune Limit Interval = 60,
Graft Retry Interval = 3,
State Refresh Enabled = true,
Operational Status = enabled

output definitions
Interface Name The name of the IPv6 PIM interface.
IPv6 address Specifies the IPv6 address of the specified interface.
Designated Router The primary IP address for the Designated Router (DR). The DR acts
on behalf of any directly-connected hosts with respect to the PIM-SM
protocol. Only one router in the LAN will act as the DR.
Hello Interval The frequency at which PIM Hello messages are transmitted on a
specified interface. Values may range from 1 to 18000. The default
value
is 30.
Join/Prune Interval The Join/Prune interval for the associated interface. The Join/Prune
interval is the interval at which periodic PIM-SM Join/Prune messages
are sent. Values may range from 0 to 18000. The default value is 60.
Triggered Hello Interval The current Triggered Hello Interval. This value indicates the
maximum time, in seconds, before a triggered PIM Hello message is
transmitted on the corresponding interface. Values may range from 0 to
60. The default value is 5.
Hello Holdtime The current Hello Holdtime value. This value indicates the maximum
amount of time, in seconds, Hello messages will be held before they are
considered invalid. Values may range from 0 to 65535. The default
value is 105.
Join/Prune Holdtime The current Join/Prune Holdtime value. This value indicates the
maximum amount of time, in seconds, Join/Prune messages will be
held before they are considered invalid. Values may range from 0 to
65535. The default value is 210.
Propagation Delay The expected propagation delay between PIM routers on the network.
Values may range from 0 to 32767. The default value is 500.
Override Interval The current Override Interval. This value is used to avoid
synchronization of override messages when multiple downstream
routers share a multi-access link. The sending of override messages is
delayed at random time intervals. The amount of randomization used
by a router is dictated by this number. Values may range from 0 to
65535. The default value is 2500.
Generation ID Option The value of the Generation ID this router inserted in the last PIM
Hello message it sent on this interface.
DR Priority Displays the Designated Router priority for each interface. This value is
used in determining the Designated Router on an interface. Values may
range from 1 to 192. A higher numeric value denotes a higher priority.
Note that priority-based election is used only if all routers on the
interface are using the DR priority option. The default value is 1.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-109
show ipv6 pim interface PIM Commands

output definitions (continued)

Lan Delay Enabled Options include true and false. The value will be true if all neighbors
on the interface are using the LAN Prune Delay option. Otherwise, the
setting will be false.
Effective Propagation Delay The Effective Propagation Delay on this interface.
Effective Override Interval The Effective Override Interval on this interface.
Suppression Enabled Specifies whether the Join suppression is enabled on this interface.
DR Priority Enabled Evaluates to TRUE if all routers on this interface are using the DR
Priority option.
Stub Interface Specifies whether this interface is a 'stub interface'. If this is TRUE,
then no PIM packets are sent out on this interface, and any received
PIM packets are ignored.
Prune Limit Interval The minimum interval that must transpire between two successive
Prunes sent by a router. This is used only with PIM-DM. Values may
range from 0 to 65535. The default value is 60.
Graft Retry Interval Displays the time-interval a router waits for a Graft acknowledgment
before resending a Graft on the interface. This is only used with PIM-
DM. Values may range from 0 to 65535. The default value is 3.
SR Priority Enabled Evaluates to TRUE if all routers on this interface are using the State
Refresh option. This is used only by PIM-DM.
Operational Status The current operational status of the corresponding interface. Options
include enabled and disabled. This value indicates whether the IPv6
interface is operationally up. For example, if PIM is enabled on the
interface, but the interface is currently down, this field will display as
disabled. The default setting is disabled. To enable or disable PIM on
an interface, refer to the ipv6 pim interface. To globally enable or
disable PIM on the switch, refer to the ipv6 pim sparse admin-state
and ipv6 pim dense admin-state.

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 pim interface Enables IPv6 PIM and configures statistics such as hello-interval,
triggered-hello, hello-holdtime, joinprune, prune-delay, override-
interval, dr-priority, stub interface, prune limit interval, and graft
retry interval on the interface.

page 30-110 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ipv6 pim interface

MIB Objects
alaPimInterfaceTable
alaPimInterfaceIfIndex
alaPimInterfaceDR
alaPimInterfaceHelloInterval
alaPimInterfaceJoinPruneInterval
alaPimInterfaceStatus
alaPimInterfaceAddress
alaPimInterfaceTrigHelloInterval
alaPimInterfaceHelloHoldtime
alaPimInterfaceJoinPruneHoldtime
alaPimInterfacePropagationDelay
alaPimInterfaceOverrideInterval
alaPimInterfaceGenerationIDValue
alaPimInterfaceDRPriority
alaPimInterfaceLanDelayEnabled
alaPimInterfaceEffectPropagDelay
alaPimInterfaceEffectOverrideIvl
alaPimInterfaceSuppressionEnabled
alaPimInterfaceDRPriorityEnabled
alaPimInterfaceStubInterface
AlaPimInterfacePruneLimitInterval
alaPimInterfaceGraftRetryInterval
alaPimInterfaceSRPriorityEnabled

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-111
show ipv6 pim neighbor PIM Commands

show ipv6 pim neighbor

Displays a list of active IPv6 PIM neighbors.
show ipv6 pim neighbor [ipv6_address] [if_name]

Syntax Definitions

ipv6_address The IPv6 address for the PIM neighbor.

if_name The name of the interface.

Defaults
If the neighbor’s IPv6 address or interface name is not specified, the entire IPv6 PIM neighbor table is
displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
To view more detailed information about a particular neighbor, specify the neighbor's IPv6 address or the
associated interface name in the command line. Additional information will be displayed, which includes
LAN Prune Delay, Override Interval, TBit field, State Refresh capable, and Designated Router option
status.

Examples

-> show ipv6 pim neighbor

Neighbor Address Interface Name Uptime Expires DR Pri
------------------------------+--------------------+-----------+-----------+------
fe80::2d0:95ff:feac:a537 vlan-30 02h:56m:51s 00h:01m:28s 1

If a specific neighbor address is specified in the command line, detailed information for the correspond-
ing neighbor only displays:

-> show ipv6 pim neighbor fe80::2d0:95ff:feac:a537

vlan-30
Neighbor IPv6 Address = fe80::2d0:95ff:feac:a537,
Uptime = 02h:57m:09s,
Expires = 00h:01m:40s,
Lan Prune Delay Present = True,
Propagation Delay = 500,
Override Interval = 2500,
TBit Field = True,
Gen ID Present = True,
Gen ID Value = 0x7720c123,
BiDir Capable = False,
DR Priority Present = True,
DR Priority = 1,

page 30-112 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ipv6 pim neighbor

State Refresh Capable = True,

Secondary Addresses:
3000::11

vlan-40
Neighbor IPv6 Address = fe80::2d0:95ff:feac:a537,
Uptime = 03h:57m:03s,
Expires = 00h:01m:20s,
Lan Prune Delay Present = True,
Propagation Delay = 500,
Override Interval = 2500,
TBit Field = True,
Gen ID Present = True,
Gen ID Value = 0x7720c123,
BiDir Capable = False,
DR Priority Present = True,
DR Priority = 1,
State Refresh Capable = True,
Secondary Addresses:
4000::11

If a specific interface name is specified in the command line, detailed information corresponding to all
neighbors on the specified interface only displays:

-> show IPv6 pim neighbor vlan-30

vlan-30
Neighbor IPv6 Address = fe80::2d0:95ff:feac:a537,
Uptime = 02h:57m:09s,
Expires = 00h:01m:40s,
Lan Prune Delay Present = True,
Propagation Delay = 500,
Override Interval = 2500,
TBit Field = True,
Gen ID Present = True,
Gen ID Value = 0x7720c123,
BiDir Capable = False,
DR Priority Present = True,
DR Priority = 1,
State Refresh Capable = True,
Secondary Addresses:
3000::11

output definitions
Neighbor IPv6 Address The IPv6 address of the active PIM neighbor.
Interface Name The name of the IPv6 PIM interface that is used to reach the neighbor.
Uptime The amount of time since this PIM neighbor last became a neighbor of
the local router, displayed in hours, minutes, and seconds.
Expires The minimum amount of time remaining before the PIM neighbor will
be aged out, displayed in hours, minutes, and seconds.
LAN Prune Delay present Specifies whether this neighbor is using the LAN Prune Delay option.
Options include true or false.
Propagation Delay The value of the propagation-delay field of the LAN prune-delay
option received from this neighbor. A value of 0 indicates that no LAN
prune-delay option was received from this neighbor.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-113
show ipv6 pim neighbor PIM Commands

output definitions (continued)

Override Interval The current Override Interval of the LAN prune-delay option received
from this neighbor. This value is used to avoid synchronization of
override messages when multiple downstream routers share a multi-
access link. The sending of override messages is delayed at random
time intervals. The amount of randomization used by the neighboring
router is dictated by this number. Values may range from 0 to 65535. A
value of 0 indicates that no LAN prune-delay option was received from
this neighbor.
TBit field The value of the Tbit field of the LAN prune-delay option received
from this neighbor. The Tbit specifies the ability of the neighbor to
disable Join suppression.
Gen ID present Specifies whether this neighbor is using Generation ID option. Options
include true or false.
Gen ID Value The value of the Generation ID in the last PIM Hello message received
from this neighbor.
BiDir Capable Specifies whether this neighbor is using the Bidirectional-PIM Capable
option.
DR Priority Present Displays whether the neighbor is using the Designated Router option.
Options include true or false.
DR priority The value of the Designated Router Priority in the last PIM Hello
message received from this neighbor.
State Refresh Capable Displays whether the neighbor is capable of receiving State Refresh
messages. Options include true or false.
Secondary Addresses The secondary IPv6 address of this PIM neighbor.

Release History
Release 8.1.1; command introduced.

Related Commands
N/A

MIB Objects
alaPimNeighborTable
alaPimNeighborAddress
alaPimNeighborIfIndex
alaPimNeighborUpTime
alaPimNeighborExpiryTime
alaPimNeighborLanPruneDelayPresent
alaPimNeighborPropagationDelay
alaPimNeighborTBit
alaPimNeighborGenerationIDPresent
alaPimNeighborGenerationIDValue
alaPimNeighborBidirCapable
alaPimNeighborDRPriorityPresent
alaPimNeighborDRPriority
alaPimNeighborSRCapable

page 30-114 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ipv6 pim neighbor

alaPimNbrSecAddressTable
alaPimNbrSecAddress

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-115
show ipv6 pim static-rp PIM Commands

show ipv6 pim static-rp

Displays the IPv6 PIM Static RP table, which includes IPv6 multicast group address/prefix length, the
static Rendezvous Point (RP) address, and the current status of the static RP configuration (i.e., enabled or
disabled).
show ipv6 pim static-rp

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If the group prefixes configured for two or more rows in this table overlap, the row with the greatest prefix
length value is used for the overlapping range.

Examples
-> show ipv6 pim static-rp

Group Address/Pref Length RP Address Mode Override Precedence Status

---------------------------+-------------+-----+--------+----------+--------
ff00::/8 3000::11 asm false none enabled
ff34::/32 3000::11 asm false none enabled

output definitions
Group Address/Pref Length The IPv6 multicast group address along with the prefix length.
RP Address The IPv6 address of the RP that is mapped for the groups within the
group prefix. This field is set to zero, if the specified IPv6 PIM mode is
SSM or DM.
Mode The IPv6 PIM mode that is used for the groups in this prefix. The
possible values include ASM, SSM, or DM.
Override Specifies that this static RP configuration can override the dynamically
learned RP information for the specified group.
Precedence The precedence value that is used for this static RP configuration.
Status Displays whether the static RP configuration is currently enabled or
disabled. Options include enabled and disabled.

Release History
Release 8.1.1; command introduced.

page 30-116 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ipv6 pim static-rp

Related Commands

ipv6 pim static-rp Adds, modifies, or deletes a static RP for an IPv6 multicast group
(“modifies” applies only to the RP address, since the table is
indexed from group address and prefix length parameters).

MIB Objects
alaPimStaticRPTable
alaPimStaticRPGrpAddress
alaPimStaticRPGrpPrefixLength
alaPimStaticRPAddress
alaPimStaticRPPimMode
alaPimStaticRPOverrideDynamic
alaPimStaticRPRowStatus
alaPimStaticRPPrecedence

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-117
show ipv6 pim group-map PIM Commands

show ipv6 pim group-map

Displays the IPv6 PIM group mapping table.
show ipv6 pim group-map [bsr | static-rp | ssm | dense]

Syntax Definitions

N/A

Defaults
If the keywords bsr, static-rp, ssm, or dense are included in the command line, then only the entries that
were created by the specified origin are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If static RP configuration is being used, this information is obtained from those static RP addresses that
are defined through the ipv6 pim static-rp command. As long as the RP addresses defined in the static
RP set are reachable, they will be added to the group mapping table.
• If the IPv6 multicast groups are mapped to the mode DM or SSM, then the entries created by local
SSM address range configuration using the ipv6 pim ssm group command and local Dense Mode
address range configuration using the ipv6 pim dense group command are displayed.
• If the bootstrap mechanism is being used, this information is obtained from received Candidate-RP
advertisements (when the local router is the BSR; when the local router is not the BSR, this
information is obtained from received bootstrap messages).

Examples
-> show ipv6 pim group-map
Origin Group Address/Pref Length RP Address Mode Precedence
---------+---------------------------+-------------+-----+-----------
BSR ff00::/8 3000::11 asm 192
BSR ff00::/8 4000::7 asm 192
SSM ff33::/32 ssm

-> show ipv6 pim group-map bsr

Origin Group Address/Pref Length RP Address Mode Precedence
---------+---------------------------+-------------+-----+-----------
BSR ff00::/8 3000::11 asm 192
BSR ff00::/8 4000::7 asm 192

-> show ipv6 pim group-map ssm

Origin Group Address/Pref Length RP Address Mode Precedence
---------+---------------------------+-------------+-----+-----------

page 30-118 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ipv6 pim group-map

SSM ff33::/32 ssm

output definitions
Origin The mechanism by which the PIM mode and RP for the group were
learned. The possible values include 'static RP' for local static RP
configuration, 'static SSM' for both static SSM group configuration and
Dense Mode Group configuration, and 'BSR' for the PIM Bootstrap
Router mechanism.
Group Address/Prefix Length The IPv6 multicast group address along with the prefix length.
RP Address The IPv6 address of the Rendezvous Point to be used for groups within
the group prefix.
Mode The IPv6 PIM mode to be used for groups in this prefix.
Mapping Precedence The precedence value of a particular row, that determines which row
applies to a given group address. Numerically higher values for this
object indicate lower precedences, with the value zero denoting the
highest precedence.

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 pim static-rp Adds, modifies, or deletes a static RP for an IPv6 multicast group
(“modifies” applies only to the RP address, since the table is indexed
from group address and prefix length parameters).
ipv6 pim ssm group Statically maps the specified IPv6 multicast group to the PIM Source
Specific Multicast mode (SSM).
ipv6 pim dense group Statically maps the specified IPv6 multicast group to the PIM Dense
mode (DM).

MIB Objects
alaPimGroupMappingTable
alaPimGroupMappingOrigin
alaPimGroupMappingGrpAddress
alaPimGroupMappingGrpPrefixLength
alaPimGroupMappingRPAddress
alaPimGroupMappingPimMode
alaPimGroupMappingPrecedence

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-119
show ipv6 pim candidate-rp PIM Commands

show ipv6 pim candidate-rp

Displays the IPv6 multicast groups for which the local router advertises itself as a Candidate-RP.
show ipv6 pim candidate-rp

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 pim candidate-rp
RP Address Group Address Priority Interval Status
------------------+---------------+---------+---------+--------
3000::11 FF00::/8 192 60 enabled

output definitions
RP Address An IPv6 unicast address that is advertised as the Candidate-Rendezvous
Point (RP).
Group Address The IPv6 multicast group address along with the prefix length. This is
the group for which the local router advertises itself as a C-RP.
Priority The C-RP router’s priority. The lower the value, the higher the priority.
Interval The time interval at which the C-RP advertisements are sent to the
BSR.
Status The current status of this entry. The status is shown as enabled only if
the IPv6 PIM-SM is globally enabled and the IPv6 PIM interface is
enabled.

Release History
Release 8.1.1; command introduced.

page 30-120 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ipv6 pim candidate-rp

Related Commands

ipv6 pim candidate-rp Configures the local router as the Candidate-Rendezvous Point (C-
RP) for a specified IPv6 multicast group.

MIB Objects
alaPimBsrCandidateRPTable
alaPimBsrCandidateRPAddress
alaPimBsrCandidateRPGroupAddress
alaPimBsrCandidateRPGroupPrefixLength
alaPimBsrCandidateRPPriority
alaPimBsrCandidateRPInterval
alaPimBsrCandidateRPStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-121
show ipv6 pim cbsr PIM Commands

show ipv6 pim cbsr

Displays the IPv6 Candidate-BSR information that is used in the Bootstrap messages.
show ipv6 pim cbsr

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 pim cbsr
CBSR Address = 3000::7,
Status = enabled,
CBSR Priority = 0,
Hash Mask Length = 126,
Elected BSR = False,
Timer = 00h:00m:00s

output definitions
CBSR Address An IPv6 unicast address that the local router uses to advertise itself as a
Candidate-BSR.
Status The current status of this entry. The status is shown as enabled only if
the IPv6 PIM-SM is globally enabled and the IPv6 PIM interface is
enabled.
CBSR Priority The value for the local router as a Candidate-BSR. The higher the
value, the higher the priority.
Hash Mask Length The hash mask length that is advertised in the bootstrap messages (the
length of the mask is used in the hash function when computing the
Rendezvous Point (RP) for an IPv6 multicast group)
Elected BSR Specifies whether the local router is the elected BSR.
Timer The time value that is remaining before the local router originates the
next Bootstrap message. This value is zero if this router is not the
elected BSR.

page 30-122 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ipv6 pim cbsr

Release History
Release 8.1.1; command introduced.

Related Commands

ipv6 pim cbsr Configures the Candidate-BSR information that is used in the
Bootstrap messages.

MIB Objects
alaPimBsrCandidateBSRTable
alaPimBsrCandidateBSRAddress
alaPimBsrCandidateBSRStatus
alaPimBSrCandidateBSRHashMaskLength
alaPimBsrCandidateBSRElectedBSR
alaPimBsrCandidateBSRBootstrapTimer
alaPimBsrCandidateBSRPriority

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-123
show ipv6 pim bsr PIM Commands

show ipv6 pim bsr

Displays information about the elected IPv6 BSR.
show ipv6 pim bsr

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 pim bsr
BSR Address = 3000::7,
BSR Priority = 192,
Hash Mask Length = 126,
Expiry Time = 00h:01m:35s

output definitions
BSR Address The IPv6 unicast address of the elected BSR.
BSR Priority The priority value of the elected BSR. The higher the value, the higher
the priority.
Hash Mask Length The hash mask length that is advertised in the Bootstrap messages by
the elected BSR (the length of the mask is used in the hash function
when computing the Rendezvous Point (RP) for a multicast group.
Expiry Time The minimum time remaining before the elected BSR will be declared
down.

Release History
Release 8.1.1; command introduced.

page 30-124 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ipv6 pim bsr

Related Commands

ipv6 pim cbsr Configures the Candidate-BSR information that is used in the
Bootstrap messages.

MIB Objects
alaPimBsrElectedBSRTable
alaPimBsrElectedBSRAddress
alaPimBsrElectedBSRPriority
alaPimBsrElectedBSRHashMaskLength
alaPimBsrElectedBSRExpiryTime

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-125
show ipv6 pim groute PIM Commands

show ipv6 pim groute

Displays all (*,G) state that the IPv6 PIM has.
show ipv6 pim groute [group_address]

Syntax Definitions

group_address The IPv6 address of the Multicast Group.

Defaults
By default, entire (*,G) routing table is displayed. To view more detailed (*,G) state information about a
particular group, specify the group address in the command line.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
When the group_address is specified in the command line, the detailed information displayed also
includes the detailed state of every outgoing interface.

Examples
-> show ipv6 pim groute
Total 1 (*,G)

Group Address RP Address RPF Interface UpTime

----------------------+-------------------+----------------------------+-----------
ff0e::7 5ffe::3 vlan-4 00h:01m:23s

-> show ipv6 pim groute ff0e::7

(*,ff0e::7)
UpTime = 00h:01m:28s
RP Address = 5ffe::3,
PIM Mode = ASM,
PIM Mode Origin = BSR,
Upstream Join State = Not Joined,
Upstream Join Timer = 00h:00m:00s,
Upstream Neighbor = fe80::220:fcff:fe1e:2455,
RPF Interface = vlan-4,
RPF Next Hop = fe80::220:fcff:fe1e:2455,
RPF Route Protocol = Static,
RPF Route Address = 5ffe::3/128,
RPF Route Metric Pref = 10,
RPF Route Metric = 10,
Interface Specific State:
vlan-3
UpTime = 00h:01m:28s,
Local Membership = False,
Join/Prune State = Joined,

page 30-126 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ipv6 pim groute

Prune Pending Timer = 00h:00m:00s,

Join Expiry Timer = 00h:02m:02s,
Assert State = Loser,
Assert Timer = 00h:01m:32s,
Assert Winner Address = fe80::220:fcff:fe1e:2454,
Assert Winner Metric Pref = 9 (rpt),
Assert Winner Metric = 10,
vlan-4
UpTime = 00h:00m:00s,
Local Membership = False,
Join/Prune State = No Info,
Prune Pending Timer = 00h:00m:00s,
Join Expiry Timer = 00h:00m:00s,
Assert State = No Info,
Assert Timer = 00h:00m:00s,
vlan-5
UpTime = 00h:00m:00s,
Local Membership = False,
Join/Prune State = No Info,
Prune Pending Timer = 00h:00m:00s,
Join Expiry Timer = 00h:00m:00s,
Assert State = No Info,
Assert Timer = 00h:00m:00s,

output definitions
Group-address The IPv6 Multicast Group Address.
RP Address The address of the Rendezvous Point (RP) for the group.
RPF Interface The RPF interface towards the RP. The ifIndex is converted to the if-
name for the display.
Upstream Neighbor The primary address of the neighbor on the RPF Interface that the local
router is sending periodic (*,G) join messages to.
UpTime The time since this entry was created.
Pim Mode Origin The mechanism by which the PIM mode and RP for the group were
learned.
Upstream Join State Whether the local router should join the RP tree for the group.
Upstream Join Timer The time remaining before the local router next sends a periodic (*,G)
Join message on the RPF IfIndex.
RPF Next Hop The address of the RPF next hop towards the RP.
RPF Route Protocol The routing mechanism through which the route used to find the RPF
interface towards the RP was learned.
RPF Route Address/Prefix The IPv6 address combined with the prefix length identifies the route
Length used to find the RPF interface towards the RP.
Route Metric Pref The metric preference of the route used to find the RPF interface
towards the RP.
Route Metric The routing metric of the route used to find the RPF interface towards
the RP.
Interface Name The interface name that corresponds to the ifIndex.
Local Membership Whether the local router has (*,G) local membership on this interface.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-127
show ipv6 pim groute PIM Commands

output definitions (continued)

Join Prune State The state resulting from (*,G) Join/Prune messages received on this
interface.
Prune Pending Timer The time remaining before the local router acts on a (*,G) Prune
message received on this interface, during which the router is waiting to
see whether another downstream router will override the Prune
message.
Join Expiry Timer The time remaining before (*,G) Join state for this interface expires.
Assert State The (*,G) Assert state for this interface. The possible values are No
Info, Winner or Loser.
Assert Timer If Assert State is 'Winner', this is the time remaining before the local
router next sends a (*,G) Assert message on this interface. If the Assert
State is 'Loser', this is the time remaining before the (*,G) assert state
expires.
Assert Winner Address If the Assert State is 'Loser', this is the address of the assert winner.
Assert Winner Metric Pref If the Assert State is 'Loser', this is the metric preference of the route to
the RP advertised by the assert winner; otherwise, this is zero.
Assert Winner Metric If the Assert State is 'Loser', this is the routing metric of the route to the
RP advertised by the assert winner; otherwise, this is zero.

Release History
Release 8.1.1; command introduced.

Related Commands
N/A

MIB Objects
alaPimStarGTable
alaPimStarGGrpAddress
alaPimStarGRPAddress
alaPimStarGRPFIfIndex
alaPimStarGUpstreamNeighbor
alaPimStarGUpTime
alaPimStarGPimModeOrigin
alaPimStarGUpstreamJoinState
alaPimStarGUpstreamJoinTimer
alaPimStarGRPFNextHop
alaPimStarGRPFRouteProtocol
alaPimStarGRPFRouteAddress
alaPimStarGRPFRoutePrefixLength
alaPimStarGRPFRouteMetricPref
alaPimStarGRPFRouteMetric
alaPimStarGITable
alaPimStarGIIfIndex
alaPimStarGILocalMembership
alaPimStarGIJoinPruneState
alaPimStarGIPrunePendingTimer
alaPimStarGIPrunePendingTimer
alaPimStarGIAssertState

page 30-128 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ipv6 pim groute

alaPimStarGIAssertTimer
alaPimStarGIAssertWinnerAddress
alaPimStarGIAssertWinnerAddress
alaPimStarGIAssertWinnerMetric

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-129
show ipv6 pim sgroute PIM Commands

show ipv6 pim sgroute

Displays all (S,G) state that the IPv6 PIM has.
show ipv6 pim sgroute [source_address group_address]

Syntax Definitions

source_address The IPv6 address for a specific multicast source.

group_address A IPv6 multicast address.

Defaults
By default, entire (S,G) routing table is displayed. To view the detailed information for a particular (S,G)
entry, use the source_address and group_address associated with that entry.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When the source_address and group_address is specified in the command line, the detailed
information displayed also includes the detailed state of every outgoing interface.
• If an IPv6 address is not specified, the current PIM status for all multicast route entries are displayed.

Examples
-> show ipv6 pim sgroute

Legend: Flags: D = Dense, S = Sparse, s = SSM Group,

L = Local, R = RPT, T = SPT, F = Register,
P = Pruned, O = Originator

Total 1 (S,G)

Source Address Group Address RPF Interface UpTime Flags

---------------------+---------------------+----------------+-----------+------
8ffe::3 ff0e::7 00h:01m:34s SR

-> show ipv6 pim sgroute 8ffe::3 ff0e::7

(8ffe::3,ff0e::7)
UpTime = 00h:01m:40s
PIM Mode = ASM,
Upstream Join State = Not Joined,
Upstream RPT State = Not Pruned,
Upstream Join Timer = 00h:00m:00s,
Upstream Neighbor = none,
SPT Bit = False,
DR Register State = No Info,
DR Register Stop Timer = 00h:00m:00s,
Interface Specific State:

page 30-130 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ipv6 pim sgroute

vlan-3
UpTime = 00h:01m:40s,
Local Membership = False,
Join/Prune State = No Info,
RPT State = No Info,
Prune Pending Timer = 00h:00m:00s,
Join Expiry Timer = 00h:00m:00s,
Assert State = No Info,
Assert Timer = 00h:00m:00s,
vlan-4
UpTime = 00h:00m:00s,
Local Membership = False,
Join/Prune State = No Info,
RPT State = No Info,
Prune Pending Timer = 00h:00m:00s,
Join Expiry Timer = 00h:00m:00s,
Assert State = No Info,
Assert Timer = 00h:00m:00s,
vlan-5
UpTime = 00h:00m:00s,
Local Membership = False,
Join/Prune State = No Info,
RPT State = No Info,
Prune Pending Timer = 00h:00m:00s,
Join Expiry Timer = 00h:00m:00s,
Assert State = No Info,
Assert Timer = 00h:00m:00s,

output definitions
Source-address The IPv6 Source address.
Group-address The IPv6 Multicast Group Address.
RPF Interface The RPF interface towards the RP. The ifIndex is converted to the if-
name for the display.
Upstream Neighbor The primary address of the neighbor on the RPF Interface that the local
router is sending periodic (S,G) join messages to.
UpTime The time since this entry was created.
Flags Flags indicating SPTBit, Prune State, Join State, etc.
Pim Mode Whether the Group Address is SSM, ASM or DM.
Upstream Join State Whether the local router should join the SPT for the source and group
represented by this entry.
Upstream Join Timer The time remaining before the local router next sends a periodic (S,G)
Join message.
RPF Next Hop The address of the RPF next hop towards the source.
RPF Route Protocol The routing mechanism through which the route used to find the RPF
Interface towards the source was learned.
RPF Route Address/Prefix The IP address which when combined with the Route Prefix length
Length identifies the route used to find the RPF interface towards the source.
RPF Route Metric Pref The metric preference of the route used to find the RPF interface
towards the source.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-131
show ipv6 pim sgroute PIM Commands

output definitions (continued)

RPF Route Metric The metric preference of the route used to find the RPF interface
towards the source.
DR Register State Whether the local router should encapsulate (S,G) data packets in
Register messages and send them to the RP. The possible values
include No Info, Join, Join Pending, or Prune.
DR Register Stop Timer The value of the Register Stop Timer. If the Register State is 'prune',
this is the time remaining before the local router sends a Null-Register
message to the RP. If the State is 'joinPending', this is the time
remaining before the local router resumes encapsulating data packets
and sending them to the RP.
Upstream Prune State Whether the local router has pruned itself from the tree. This is only
used by PIM-DM. The possible values include forwarding, Ack
Pending, or Pruned.
Upstream Prune Limit Timer The time remaining before the local router may send a (S,G) prune
message on alaPimSGRPFIfIndex. This is only used by PIM-DM.
Originator State Whether this router is an originator for the (S,G) message flow. This is
only used by PIM-DM. The possible values include Not Originator or
Originator.
Source Active Timer If this router is the Originator, this is the time remaining before the
local router reverts to notOriginator state. Otherwise, this is zero. This
is only used by PIM-DM.
State Refresh Timer If Originator state is 'originator', this is the time remaining before the
local router sends a State Refresh Message. Otherwise, this is zero. This
is only used by PIM-DM.
Interface Name The interface name corresponding to the ifIndex that corresponds to
this entry.
Uptime The time since this entry was created.
Local Membership Whether the local router has (S,G) local membership on this interface.
Join Prune State The state resulting from (S,G) Join/Prune messages received on this
interface. The possible values include No Info, Join, or Prune Pending.
Prune Pending Timer The time remaining before the local router acts on an (S,G) Prune
message received on this interface, during which the router is waiting to
see whether another downstream router will override the Prune
message.
Join Expiry Timer The time remaining before (S,G) Join state for this interface expires.
Assert State The (S,G) Assert state for this interface. The possible values include No
Info, Winner, or Loser.
Assert Timer If Assert State is Winner, this is the time remaining before the local
router sends a (S,G) Assert message on this interface. If the Assert State
is Loser, this is the time remaining before the (S,G) Assert state expires.
Assert Winner If the Assert State is Loser, this is the address of the assert winner.
Assert Winner Metric Pref If the Assert State is Loser, this is the metric preference of the route to
the source advertised by the assert winner.
Assert Winner Metric Metric If the Assert State is Loser, this is the routing metric of the route to the
source advertised by the assert winner.

page 30-132 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
PIM Commands show ipv6 pim sgroute

Release History
Release 8.1.1; command introduced.

Related Commands
N/A

MIB Objects
alaPimSGTable
alaPimSGSrcAddress
alaPimSGGrpAddress
alaPimSGRPFIfIndex
alaPimSGUpstreamNeighbor
alaPimSGUpTime
alaPimSGSPTBit
alaPimSGUpstreamPruneState
alaPimSGUpstreamJoinState
alaPimSGPimMode
alaPimSGUpstreamJoinState
alaPimSGUpstreamJoinTimer
alaPimSGRPFNextHop
alaPimSGRPFRouteProtocol
alaPimSGRPFRouteAddress
alaPimSGRPFRoutePrefixLength
alaPimSGRPFRouteMetricPref
alaPimSGRPFRouteMetric
alaPimSGDRRegisterState
alaPimSGDRRegisterStopTimer
alaPimSGUpstreamPruneState
alaPimSGUpstreamPruneLimitTimer
alaPimSGOriginatorState
alaPimSGSourceActiveTimer
alaPimSGStateRefreshTimer
alaPimSGITable
alaPimSGIIfIndex
alaPimSGIUpTime
alaPimSGILocalMembership
alaPimSGIJoinPruneState
alaPimSGIPrunePendingTimer
alaPimSGIJoinExpiryTimer
alaPimSGIAssertState
alaPimSGIAssertTimer
alaPimSGIAssertWinnerAddress
alaPimSGIAssertWinnerMetricPref
alaPimSGIAssertWinnerMetric

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 30-133
show ipv6 pim sgroute PIM Commands

page 30-134 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 31 Multicast Routing
Commands

This chapter describes multicast routing commands. Multicast routing is used in conjunction with IP
Multicast Switching (IPMS). IPMS can operate either with or without multicast routing. However, for
multicast routing to function, IPMS must be configured.
Multicast uses Class D IP addresses in the range 224.0.0.0 to 239.255.255.255. Addresses in the range
239.0.0.0 to 239.255.255.255 are reserved for boundaries, which are used to prevent multicast traffic from
being forwarded on a VLAN group or network.
The multicast route boundary is extended to include the non-standard multicast group range (224.0.0.0 to
239.255.255.255). This allows to stop all multicast traffic from being forwarded on a VLAN group or
network.
IP multicast routing is a way of controlling multicast traffic across networks. The multicast router
discovers which networks want to receive multicast traffic by sending out Internet Group Management
Protocol (IGMP) queries and receiving IGMP reports from attached networks. The IGMP reports signal
that users want to join or leave a multicast group. If there is more than one multicast router in the network,
the router with the lowest IP address is elected the querier router, which is responsible for querying the
subnetwork for group members.
The current release also provides support for IPv6 multicast addresses. In the IPv6 addressing scheme,
multicast addresses begin with the prefix ff00::/8. Similar to IPv6 unicast addresses, IPv6 multicast
addresses also have different scopes depending on their prefix, though the range of possible scopes is
different.
Multicast Listener Discovery (MLD) is the protocol used by an IPv6 router to discover the nodes which
request multicast packets on its directly attached links and the multicast addresses that are of interest to
those neighboring nodes. MLD is derived from version 2 of IPv4's Internet Group Management Protocol,
IGMPv2. MLD uses ICMPv6 message types, rather than IGMP message types.
MIB information for the multicast routing commands is as follows:
Filename: ALCATEL-IND1-IPMRM-MIB.mib
Module: alcatelIND1IPMRMMIB
Filename: IPMCAST-MIB.mib
Module: IpMcastMib

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 31-1
 Multicast Routing Commands

A summary of the available commands is listed here:

ip mroute-boundary
ip mroute-boundary extended
ip mroute interface ttl
ip mroute mbr
show ip mroute-boundary
show ip mroute
show ip mroute interface
show ip mroute-nexthop
show ip mroute mbr
ipv6 mroute interface ttl
show ipv6 mroute
show ipv6 mroute interface
show ipv6 mroute-nexthop

page 31-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Multicast Routing Commands ip mroute-boundary

ip mroute-boundary
Adds or deletes scoped multicast address boundaries for a router interface. When a user on the specified
interface joins the multicast group as defined by the scoped address—plus the mask length—all multicast
traffic will stop being forwarded on that interface. This provides a mechanism for the end user to control
multicast traffic from the network.
Refer to the “Configuring Multicast Address Boundaries” chapter in the applicable OmniSwitch AOS
Release 8 Advanced Routing Configuration Guide for detailed information.
ip mroute-boundary if_name scoped_address mask
no ip mroute-boundary if_name scoped_address mask

Syntax Definitions

if_name The interface name on which the boundary is being assigned.

scoped_address A scoped multicast address identifying the group range for the bound-
ary. Scoped addresses may range from 239.0.0.0–239.255.255.255.
mask A corresponding Class A, B, or C mask address (e.g., 255.0.0.0).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to delete the scoped multicast address boundaries for a router interface.

Examples
-> ip mroute-boundary vlan-2 239.0.0.0 255.0.0.0

Release History
Release 8.1.1; command introduced.

Related Commands

show ip mroute-boundary Displays scoped multicast address boundaries for the switch’s
router interfaces.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 31-3
ip mroute-boundary Multicast Routing Commands

MIB Objects
IpMRouteBoundaryTable
ipMRouteBoundaryIfIndex
ipMRouteBoundaryAddress
ipMRouteBoundaryAddressMask
ipMRouteBoundaryStatus

page 31-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Multicast Routing Commands ip mroute-boundary extended

ip mroute-boundary extended
Enables or disables the multicast route boundary expansion feature. On enabling the multicast route
boundary is extended to all the multicast groups (that is, the non-scoped address, 224.0.0.0 to
239.255.255.255). All multicast traffic will stop being forwarded on that interface. This provides a mecha-
nism for the end user to control multicast traffic from the network.
Refer to the “Configuring Multicast Address Boundaries” chapter in the applicable OmniSwitch AOS
Release 8 Advanced Routing Configuration Guide for detailed information.
ip mroute-boundary extended {enable | disable}

Syntax Definitions

enable The multicast route boundary is extended to all the multicast cast
address groups (224.0.0.0 through 239.255.255.255).
disable The multicast route boundary is limited to administratively scoped mul-
ticast address (239.0.0.0 through 239.255.255.255).

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip mroute-boundary extended enable
-> ip mroute-boundary extended disable

Release History
Release 8.2.1; command introduced.

Related Commands

show ip mroute-boundary Displays multicast address boundaries for the switch’s router inter-
faces.

MIB Objects
IpMRouteBoundaryTable
alaIpmrmExtendedBoundaryStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 31-5
ip mroute interface ttl Multicast Routing Commands

ip mroute interface ttl

Specifies a multicast datagram Time to Live (TTL) threshold for an existing router interface. IP multicast
datagrams with a TTL value lower than the specified TTL threshold value will not be forwarded out of the
interface.
ip mroute interface if_ name ttl threshold

Syntax Definitions

if_name The interface name that has one of the Multicast routing protocols run-
ning (either DVMRP or PIM).
threshold The TTL threshold value. Values may range from 0–255. The default
value of 0 allows all multicast packets to be forwarded out of the inter-
face.

Defaults

parameter default
threshold 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ip mroute interface vlan-1 ttl 255

Release History
Release 8.1.1; command introduced.

Related Commands

show ip mroute interface Displays IP multicast interface information.

MIB Objects
alaIpMcastInterfaceTable
alaIpMcastInterfaceIfIndex
alaIpMcastInterfaceTtl

page 31-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Multicast Routing Commands ip mroute mbr

ip mroute mbr
Configures the switch to serve as a Multicast Border Router (MBR) that will provide interoperability
between DVMRP and PIM domains.
ip mroute mbr admin-state {enable | disable}

Syntax Definitions

enable Enables MBR functionality on the switch.

disable Disables MBR functionality on the switch.

Defaults
MBR functionality is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• To configure the switch to operate as an MBR, first configure the DVMRP and PIM protocols for the
switch then enable MBR functionality.
• The MBR functionality is operationally enabled only when there is at lease one PIM interface and one
DVMRP interface enabled and both interfaces are operationally active on the switch.
• The MBR feature only supports interoperability between DVMRP and PIM (includes PIM-DM and
PIM-SM) domains; no other routing protocols are supported.
• The following is not supported by the MBR feature in the current release:
– PIM-SSM
– Interoperability between multiple PIM domains
– IPv6 (only IPv4)

Examples
-> ip mroute mbr admin-state enable
-> ip mroute mbr admin-state disable

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 31-7
ip mroute mbr Multicast Routing Commands

Related Commands

show ip mroute mbr Displays MBR configuration information.

MIB Objects
alaIpmrmMbrStatus

page 31-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Multicast Routing Commands ipv6 mroute interface ttl

ipv6 mroute interface ttl

Specifies a multicast datagram Time to Live (TTL) threshold for an existing IPv6 interface. Any IP multi-
cast datagrams with a TTL value lower than the specified TTL threshold value will not be forwarded out
of the interface.
ipv6 mroute interface if_name ttl threshold

Syntax Definitions

if_name The name of the IPv6 interface.

threshold The TTL threshold value. Values may range from 0–255. The default
value of 0 allows all multicast packets to be forwarded out of the inter-
face.

Defaults

parameter default
threshold 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ipv6 mroute interface vlan-1 ttl 255

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 mroute interface Displays IPv6 multicast interface information.

MIB Objects
alaIpMcastInterfaceTable
alaIpMcastInterfaceIfIndex
alaIpMcastInterfaceTtl

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 31-9
show ip mroute-boundary Multicast Routing Commands

show ip mroute-boundary
Displays the status of multicast address boundaries for the switch’s router interfaces.
show ip mroute-boundary

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip mroute-boundary
Extended Boundary Address Range: enabled

Interface Name Interface Address Boundary Address

--------------+------------------+------------------
vlan-4 214.0.0.7 239.1.1.1/32
vlan-2 170.2.0.1 224.2.2.2/24

output definitions
Extended Boundary Address Displays the status of extended multicast route boundary on the inter-
Range face.
Interface Name The name of the interface on which the boundary is assigned. Packets
with a destination address in the associated address/mask range will not
be forwarded from this interface.
Interface Address The IP address of this interface where the boundary is assigned.
Boundary Address The multicast address when combined with the boundary mask identi-
fies the boundary range. The boundary’s subnet mask is shown using
the CIDR prefix length: 255.0.0.0 equals /8; 255.255.0.0 equals /16;
255.255.255.0 equals /24.

Release History
Release 8.1.1; command introduced.
Release 8.2.1; Extended Boundary Address Range output filed added.

page 31-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Multicast Routing Commands show ip mroute-boundary

Related Commands

ip mroute-boundary Adds or deletes a router’s scoped multicast address boundaries.

ip mroute-boundary extended Enables or disables the multicast route boundary expansion feature.
show ip mroute interface Displays IP multicast interface information.

MIB Objects
IpMRouteBoundaryTable
ipMRouteBoundaryIfIndex
ipMRouteBoundaryAddress
ipMRouteBoundaryAddressMask
alaIpmrmExtendedBoundaryStatus
ipMRouteBoundaryStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 31-11
show ip mroute Multicast Routing Commands

show ip mroute
Displays multicast routing information for IP datagrams sent by particular sources to the IP multicast
groups known to this router.
show ip mroute

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip mroute

Total 2 Mroutes
Group Address Src Address Upstream Nbr Route Address Proto
--------------+---------------+---------------+----------------+----------
225.0.0.0 214.0.0.2/32 0.0.0.0 214.0.0.0/24 PIM-SM
225.0.0.1 214.0.0.2/32 0.0.0.0 214.0.0.0/24 PIM-DM

output definitions
Group Address The IP multicast group address for this entry.
Src Address The network address which identifies the source for this entry.
Upstream Nbr The address of the upstream neighbor from which IP datagrams from
these sources to this multicast address are received.
Route Address The address portion of the route used to find the upstream or parent
interface for this multicast forwarding entry.
Proto The multicast routing protocol through which this multicast forwarding
entry was learned (i.e., DVMRP, PIM-SM or PIM-DM).

Release History
Release 8.1.1; command introduced.

page 31-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Multicast Routing Commands show ip mroute

Related Commands

show ip mroute interface Displays IP multicast interface information.

show ip mroute-nexthop Displays IP next-hop information on outgoing interfaces for routing
IP multicast datagrams.

MIB Objects
alaIpMcastRouteTable
alaIpMcastRouteGroup
alaIpMcastRouteSource
alaIpMcastRouteInIfIndex
alaIpMcastRouteUpstreamNeighbor
alaIpMcastRouteRtAddress
alaIpMcastRouteRtPrefixLength
alaIpMcastRouteProtocol

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 31-13
show ipv6 mroute Multicast Routing Commands

show ipv6 mroute

Displays multicast routing information for IPv6 datagrams sent by particular sources to the IPv6 multicast
groups known to this router.
show ipv6 mroute

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 mroute
Total 2 Mroutes
Group Address Source Address Interface Upstream Neighbor Route Addr/Prefix Len
Proto
-------------+--------------+---------+------------------------+------------------
+------+
ff06:7777::1 2600::7 vlan-30 fe80::2d0:95ff:feac:a537 2600::/64
PIM-SM
ff06:7777::2 2600::7 vlan-30 fe80::2d0:95ff:feac:a537 2600::/64
PIM-SM

output definitions
Group Address The IPv6 multicast group address for this entry.
Source Address The IPv6 multicast address, which identifies the source for this entry.
Interface The name of the IPv6 interface on which the datagrams sent by these
sources to this IPv6 multicast address are received.
Upstream Neighbor The IPv6 address of the upstream neighbor from which the datagrams
from these sources to this multicast address are received.
Route Addr/Prefix len The IPv6 address portion of the route used to find the upstream or par-
ent interface for this IPv6 multicast forwarding entry.
Proto The IPv6 multicast routing protocol through which this IPv6 multicast
forwarding entry was learned.

Release History
Release 8.1.1; command introduced.

page 31-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Multicast Routing Commands show ipv6 mroute

Related Commands

show ipv6 mroute interface Displays IPv6 multicast interface information.

show ipv6 mroute-nexthop Displays IPv6 next-hop information on outgoing interfaces for rout-
ing IPv6 multicast datagrams.

MIB Objects
alaIpMcastRouteTable
alaIpMcastRouteGroup
alaIpMcastRouteSource
alaIpMcastRouteInIfIndex
alaIpMcastRouteUpstreamNeighbor
alaIpMcastRouteRtAddress
alaIpMcastRouteRtPrefixLength
alaIpMcastRouteProtocol

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 31-15
show ip mroute interface Multicast Routing Commands

show ip mroute interface

Displays IP multicast interface information.
show ip mroute interface [interface_name]

Syntax Definitions

interface_name The name of the interface.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Not specifying an interface name displays all known IP multicast interfaces information.

Examples
-> show ip mroute interface

Interface Name IP Address TTL Multicast Protocol

---------------+---------------+------+--------------------
vlan-4 214.0.0.7 0 PIM
vlan-26 172.21.63.7 0 PIM
vlan-11 212.61.11.7 0 PIM

output definitions
Interface Name The name configured for the interface.
IP Address The IP address of this interface entry.
TTL The datagram TTL threshold for the interface. Any IP multicast data-
grams with a TTL less than the threshold displayed in the table will not
be forwarded out of the interface. The default value, 0, specifies that all
multicast packets are forwarded out of the interface.
Multicast Protocol The multicast routing protocol currently running on this interface.
Options include DVMRP and PIM.

Release History
Release 8.1.1; command introduced.

page 31-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Multicast Routing Commands show ip mroute interface

Related Commands

show ip mroute Displays multicast routing information for IP datagrams sent by

particular sources to the IP multicast groups known to this router.
show ip mroute-nexthop Displays IP next-hop information on outgoing interfaces for routing
IP multicast datagrams.

MIB Objects
alaIpMcastInterfaceTable
alaIpMcastInterfaceIfIndex
alaIpMcastInterfaceTtl
alaIpMcastInterfaceProtocol

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 31-17
show ipv6 mroute interface Multicast Routing Commands

show ipv6 mroute interface

Displays IPv6 multicast interface information.
show ipv6 mroute interface {interface_name}

Syntax Definitions

interface_name The name of the interface.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Not specifying an interface name displays all known IPv6 multicast interfaces information.

Examples
-> show ipv6 mroute interface

Interface Name IP Address TTL Multicast Protocol

---------------+---------------+------+--------------------
vlan-4 2000::1 0 PIM
vlan-26 2000::2 0 PIM
vlan-11 2000::3 0 PIM

output definitions
Interface Name The name configured for the IPv6 interface.
IP Address The IPv6 address of this interface entry.
TTL The datagram TTL threshold for the interface. Any IPv6 multicast data-
grams with a TTL less than the threshold displayed in the table will not
be forwarded out of the interface. The default value, 0, specifies that all
multicast packets are forwarded out of the interface.
Multicast Protocol The multicast routing protocol currently running on this interface.
Options include DVMRP and PIM.

Release History
Release 8.1.1; command introduced.

page 31-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Multicast Routing Commands show ipv6 mroute interface

Related Commands

show ipv6 mroute Displays multicast routing information for IPv6 datagrams sent by
particular sources to the IPv6 multicast groups known to this router.
show ipv6 mroute-nexthop Displays IPv6 next-hop information on outgoing interfaces for rout-
ing IPv6 multicast datagrams.

MIB Objects
alaIpMcastInterfaceTable
alaIpMcastInterfaceIfIndex
alaIpMcastInterfaceTtl
alaIpMcastInterfaceProtocol

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 31-19
show ip mroute-nexthop Multicast Routing Commands

show ip mroute-nexthop
Displays next-hop information on outgoing interfaces for routing IP multicast datagrams.
show ip mroute-nexthop

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ip mroute-nexthop

Total 10 Nexthops

Group Address Src Address Interface Name

Next Hop Protocol
Address
-------------+-------------+----------------+-------------+----------
225.0.0.0 214.0.0.2/32 vlan-26 225.0.0.0 PIM-SM
225.0.0.1 214.0.0.2/32 vlan-26 225.0.0.1 PIM-SM
225.0.0.2 214.0.0.2/32 vlan-26 225.0.0.2 PIM-SM
225.0.0.3 214.0.0.2/32 vlan-26 225.0.0.3 PIM-SM
225.0.0.4 214.0.0.2/32 vlan-26 225.0.0.4 PIM-SM
225.0.0.5 214.0.0.2/32 vlan-26 225.0.0.5 PIM-SM
225.0.0.6 214.0.0.2/32 vlan-26 225.0.0.6 PIM-SM
225.0.0.7 214.0.0.2/32 vlan-26 225.0.0.7 PIM-SM
225.0.0.8 214.0.0.2/32 vlan-26 225.0.0.8 PIM-SM
225.0.0.9 214.0.0.2/32 vlan-26 225.0.0.9 PIM-SM

output definitions
Group Address The IP multicast group address for this entry.
Src Address The network address, which identifies the source for this entry.
Interface Name Generally, this is the name configured for the interface.
Next Hop Address The address of the next-hop that is specific to this entry.
Protocol The routing protocol by which this next-hop was learned
(i.e., DVMRP or PIM-SM).

page 31-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Multicast Routing Commands show ip mroute-nexthop

Release History
Release 8.1.1; command introduced.

Related Commands

show ip mroute Displays multicast routing information for IP datagrams sent by

particular sources to the IP multicast groups known to this router.
show ip mroute interface Displays IP multicast interface information.

MIB Objects
alaIpMcastRouteNextHopTable
alaIpMcastRouteNextHopGroup
alaIpMcastRouteNextHopSource
alaIpMcastRouteNextHopIfIndex
alaIpMcastRouteNextHopAddress
alaIpMcastRouteNextHopProtocol

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 31-21
show ipv6 mroute-nexthop Multicast Routing Commands

show ipv6 mroute-nexthop

Displays IPv6 next-hop information on outgoing interfaces for routing IPv6 multicast datagrams.
show ipv6 mroute-nexthop

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ipv6 mroute-nexthop
Total 2 Nexthops
Group Address Source Address Interface Next Hop Address Protocol
---------------+-----------------+------------+-----------------------+---------
ff06:7777::1 2600::7 vlan-40 ff06:7777::1 PIM-SM
ff06:7777::2 2600::7 vlan-40 ff06:7777::2 PIM-SM

output definitions
Group Address The IPv6 multicast group address for this entry.
Src Address The IPv6 multicast address, which identifies the source for this entry.
Interface Name The name of the IPv6 interface on which the datagrams sent by these
sources to this IPv6 multicast address are received.
Next Hop Address The IPv6 address of the next-hop that is specific to this entry.
Protocol The IPv6 multicast routing protocol by which this IPv6 multicast for-
warding entry was learned.

Release History
Release 8.1.1; command introduced.

Related Commands

show ipv6 mroute Displays multicast routing information for IPv6 datagrams sent by
particular sources to the IPv6 multicast groups known to this router.
show ipv6 mroute interface Displays IPv6 multicast interface information.

page 31-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Multicast Routing Commands show ipv6 mroute-nexthop

MIB Objects
alaIpMcastRouteNextHopTable
alaIpMcastRouteNextHopGroup
alaIpMcastRouteNextHopSource
alaIpMcastRouteNextHopIfIndex
alaIpMcastRouteNextHopAddress
alaIpMcastRouteNextHopProtocol

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 31-23
show ip mroute mbr Multicast Routing Commands

show ip mroute mbr

Displays the MBR status for the switch.
show ip mroute mbr

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The MBR feature only supports interoperability between DVMRP and PIM. Both of these multicast
protocols must be configured and operationally active on the switch.

Examples
-> show ip mroute mbr
MBR Status = enabled,
Protocols Registered = DVMRP PIM

output definitions
MBR Status The administrative status (enabled or disabled) of MBR functionality
on the switch.
Protocols Registered The operationally active multicast protocols (DVMRP, PIM) to which
MBR functionality is applied.

Release History
Release 8.1.1; command introduced.

Related Commands

ip mroute mbr Configures the administrative status of Multicast Border Router

functionality.

MIB Objects
alaIpmrmGlobalConfig
alaIpmrmMbrStatus
alaIpmrmMbrProtocolApps

page 31-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 32 QoS Commands

Alcatel-Lucent’s QoS software provides a way to manipulate flows coming through the switch based on
user-configured policies. The flow manipulation (generally referred to as Quality of Service or QoS) may
be as simple as allowing/denying traffic, or as complicated as remapping 802.1p bits from a Layer 2
network to ToS values in a Layer 3 network.
This chapter provides information about configuring QoS global and port parameters through the
Command Line Interface (CLI). Refer to Chapter 44, “QoS Policy Commands,” for information about
commands used to configure QoS policy rules.
MIB information for the QoS commands is as follows:
Filename: ALCATEL-IND1-QOS-MIB_mib
Module alaQoSMIB
Filename: ALCATEL-IND1-VIRTUAL-FLOW-CONTROL-MIB_mib
Module alcatelIND1VfcMIB

Important Note. Some of the commands listed here are not currently supported on one or more plat-
forms. See command descriptions in this chapter and check release notes for information about com-
mands that are not supported.

The QoS commands are listed here:

Global commands qos

qos trust-ports
qos forward log
qos log console
qos log lines
qos log level
qos stats interval
qos phones
qos quarantine mac-group
qos user-port
qos dei
qos dscp-table
debug qos
debug qos internal
clear qos log
qos apply
qos revert
qos flush
qos reset
qos stats reset
show qos slice
show qos log
show qos config
show qos statistics
show qos dscp-table

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-1
 QoS Commands

Port and Slice commands qos port

qos port reset
qos port trusted
qos port maximum egress-bandwidth
qos port maximum ingress-bandwidth
qos port maximum depth
qos port default 802.1p
qos port default dscp
qos port default classification
qos port dei
show qos port
Queue Management qos qsi qsp
commands qos qsi stats
show qos qsi summary
show qos qsp
show qos qsi
show qos qsi stats
clear qos qsi stats

page 32-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos

qos
Enables or disables QoS. This section describes the base command with a single required option (enable
or disable).
In lieu of this option, the base command (qos) may be used with other keywords to set up global QoS
configuration. These keywords are listed here and described as separate commands later in this chapter. In
addition, some keywords have a no form to remove the parameter or return it to its default.
qos {enable | disable}
[trust-ports]
[forward log]
[log console]
[log lines lines]
[log level level]
[stats interval seconds]
[phones [priority priority_value | trusted]]
[user-port {filter | shutdown} {spoof | bgp | bpdu | rip | ospf | vrrp | dvmrp | pim | isis | dhcp-
server | dns-reply}]

Syntax Definitions

enable Enables QoS. The QoS software in the switch classifies flows coming
into the switch to attempt to match them to QoS policies. If a match is
found, the policy parameters are applied to the flow. The enable setting
may be used alone or in conjunction with optional command keywords.
disable Disables QoS. Flows coming into the switch are not matched to policies.
The disable setting cannot be used with any other command keyword.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When QoS is disabled, flows coming into the switch are classified but not matched to a policy. Traffic
is treated as best effort and assigned to default queues.
• The command keywords may be used with or without enable; these keywords cannot be used with
disable.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-3
qos QoS Commands

Examples
-> qos enable default disposition deny
-> qos disable
-> qos enable

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current
configuration.
policy rule Configures a policy rule on the switch.
show policy rule Displays information for policy rules configured on the switch.

MIB Objects
alaQoSConfigTable
alaQoSConfigEnable
alaQoSConfigTrustedPorts
alaQoSConfigForwardLog
alaQoSConfigLogLines
alaQoSConfigLogLevel
alaQoSConfigLogConsolealaQoSConfigStatsInterval
alaQoSConfigAutoPhones
alaQoSConfigUserportFilter
alaQoSConfigAppliedUserportFilter
alaQoSConfigUserportShutdown
alaQoSConfigAppliedUserportShutdown

page 32-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos trust-ports

qos trust-ports
Configures the global trust mode for QoS ports. Trusted ports can accept 802.1p and ToS/DSCP values in
incoming packets; untrusted ports will set any 802.1p or ToS/DSCP values to zero in incoming packets,
unless a default 802.1p or ToS/DSCP value is configured.
Any port configured through the qos port command will automatically be added in the trust mode speci-
fied by this command. See page 32-34 for more information about this command.
qos trust-ports
qos no trust-ports

Syntax Definitions

N/A

Defaults
By default, all ports are untrusted.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the qos ports trusted command to override the default for a particular port.

• The setting only applies to ports with incoming traffic.

• Mobile ports are always trusted regardless of the global setting.

• Use the qos port default 802.1p or qos port default dscp commands to specify that a value other than
zero should be applied to the incoming packets. Note that this value is overridden if a policy exists that
specifies a different value for such packets.

Examples
-> qos trust-ports
-> qos no trust-ports

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-5
qos trust-ports QoS Commands

Related Commands

qos port Configures a physical port for QoS.

qos port trusted Configures whether or not a particular port is trusted or untrusted.
show qos port Displays information about QoS ports.

MIB Objects
alaQoSConfigTable
alaQoSConfigTrustedPorts

page 32-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos forward log

qos forward log

Enables the QoS software in the switch to send events to the policy server software in the switch in real
time. The policy server software may then be polled by an NMS application for logged events.
qos forward log
qos no forward log

Syntax Definitions

N/A

Defaults
By default, logged events are not sent to the policy server software in the switch.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
An NMS application may query the Policy Manager in the switch for logged events. Use the qos forward
log command to forward each event as it happens.

Examples
-> qos forward log

Release History
Release 8.1.1; command introduced.

Related Commands

qos log lines Configures the number of lines in the QoS log.
show qos log Displays the log of QoS events.

MIB Objects
alaQoSConfigTable
alaQoSConfigForwardLog

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-7
qos log console QoS Commands

qos log console

Sends QoS log messages to the switch logging utility, which is an event logging application available on
the OmniSwitch. The configuration of the switch logging utility determines if QoS messages are sent to a
log file in the switch’s flash file system, displayed on the switch console, or sent to a remote syslog server.
qos log console
qos no log console

Syntax Definitions

N/A

Defaults
QoS log messages are not sent to the switch logging utility by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• To display QoS log events as they happen on an output console attached to the switch, configure the
switch logging utility to output events to the console. This is done using the swlog output command.
• The entire log may be viewed at any time using the show qos log command.

Examples
-> qos log console
-> qos no log console

Release History
Release 8.1.1; command introduced.

Related Commands

qos log lines Configures the number of lines in the QoS log.
swlog output Enables or disables switch logging output to the console, file, or data
socket (remote session).
swlog output Displays the log of QoS events.

MIB Objects
alaQoSConfigTable
alaQoSConfigLogConsole

page 32-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos log lines

qos log lines

Configures the number of lines in the QoS log.
qos log lines lines

Syntax Definitions

lines The number of lines included in the QoS log. A value of zero turns off
logging to the console. The range is 0–512.

Defaults

parameter default
lines 10000

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• To turn off logging, enter 0 for the number of log lines. (Note that error messages will still be logged.)

• If you change the number of log lines, you may clear all messages in the QoS log. To avoid clearing all
messages in the log, enter the qos log lines command in the vcboot.cfg file. The log length will be
changed at the next reboot.

Examples
-> qos log lines 5
-> qos log lines 0

Release History
Release 8.1.1; command introduced.

Related Commands

show qos log Displays the log of QoS events.

MIB Objects
alaQoSConfigTable
alaQoSConfigLogLines

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-9
qos log level QoS Commands

qos log level

Configures the level of log detail.
qos log level level
qos no log level

Syntax Definitions

level The level of log detail, in the range from 1 (least detail) to 8 (most
detail).

Defaults

parameter default
level 5

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the qos debug command to change the type of debugging messages that are logged. The qos log
level command configures the level of detail for these messages.
• If the qos debug command is not configured to log any kind of information (this is the default), the qos
log level command has no effect.
• To log fatal errors only, set the log level to 0.

• Note that a high log level value will impact the performance of the switch.

Examples
-> qos log level 4
-> qos log level 0

Release History
Release 8.1.1; command introduced.

page 32-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos log level

Related Commands

qos log lines Configures the number of lines in the QoS log.
show qos log Displays the log of QoS events.

MIB Objects
alaQoSConfigTable
alaQoSConfigLogLevel

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-11
qos stats interval QoS Commands

qos stats interval

Configures how often the switch polls network interfaces for statistics about QoS events.
qos stats interval seconds

Syntax Definitions

seconds The number of seconds before the switch polls network interfaces for
statistics. The range is 1–3600.

Defaults

parameter default
seconds 60

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Change the statistics interval to a smaller interval if you want to monitor QoS events.

• Change the statistics interval to a larger interval if you want to free some switch memory.

Examples
-> qos stats interval 30

Release History
Release 8.1.1; command introduced.

Related Commands
show qos statistics Displays statistics about the QoS configuration.

MIB Objects
alaQoSConfigTable
alaQoSConfigStatsInterval

page 32-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos phones

qos phones
Enables or disables the automatic prioritization of IP phone traffic.
qos phones [priority priority_value | trusted]
qos no phones

Syntax Definitions

priority_value The priority given to scheduling traffic on the output port. Values range
from 0 (lowest) to 7 (highest).
trusted Trusts IP phone traffic; priority value of the IP phone packet is used.

Defaults

parameter default
priority_value | trusted trusted

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable automatic prioritization of IP phone traffic.

• IP phone traffic is identified by examining the source MAC address of the packet received on the port.
If the source MAC falls within one of the following ranges, the QoS IP phone priority is automatically
assigned to the MAC: 00-80-9F-xx-xx-xx or 00-13-FA-xx-xx-xx
• To automatically apply the QoS IP phone priority to other, non-IP phone traffic, add the source MAC
addresses of such traffic to the QoS “alaPhone” group.
• When automatic prioritization of IP phone traffic is enabled, QoS policies that specify priority are not
applied to the IP phone traffic. Other QoS policies, however, are applied to this type of traffic as usual.
• When automatic prioritization of QoS IP phone traffic is enabled, a rule gets configured in the FFP
(Fast Filtering Processor) with the source MAC address as 00:80:9F:00:00:00 and the mask
FF:FF:FF:00:00:00 and 00-13-FA-xx-xx-xx and mask FF:FF:FF:00:00:00.
• The QoS IP phone prioritization and SIP Snooping features are mutually exclusive. If the QoS IP
phone prioritization feature is enabled when the SIP Snooping feature is enabled, an error message is
displayed and vice versa. Hence, to enable QoS IP phone prioritization, disable the SIP Snooping
feature using the sip-snooping admin-state disable command. Similarly, to enable the SIP Snooping
feature, disable the QoS IP phone prioritization feature using the qos no phones command.

Note. QoS IP phone prioritization is configured, by default, on initialization

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-13
qos phones QoS Commands

Examples
-> qos phones priority 7
-> qos phones trusted
-> qos no phones

Release History
Release 8.1.1; command introduced.

Related Commands
show qos config Displays the QoS configuration for the switch.

MIB Objects
alaQoSConfigTable
alaQoSConfigAutoPhones

page 32-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos quarantine mac-group

qos quarantine mac-group

Configures the name of the Quarantine MAC address group. The OmniVista Quarantine Manager
application identifies source MAC addresses to quarantine and adds these addresses to the Quarantine
MAC group.
qos quarantine mac-group mac_group
qos no quarantine mac-group

Syntax Definitions

mac_group The name of the Quarantine MAC group (up to 31 alphanumeric

characters).

Defaults
By default, the quarantine MAC group is not configured on the switch.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to reset the default MAC group name back to “Quarantined”.

• The mac-group name specified with this command must match the group name specified with the
OmniVista Quarantine Manager application.
• Each switch can have a different Quarantine MAC group name as long as each switch matches the
OmniVista Quarantine Manager MAC group name for that switch. Note that there is only one such
MAC group per switch.
• Do not use the Quarantine MAC group name in regular QoS policies.

• This group is also used by the switch Quarantine Manager and Remediation (QMR) application to
restrict or restore network access to quarantined MACs.
• Note that QMR is not available if VLAN Stacking services or QoS VLAN Stacking inner VLAN and
802.1p policies are configured on the switch.
• QMR is considered active when there are MAC addresses in the Quarantine MAC address group. Use
the show quarantine mac group command to display the contents of this group. In addition, the show
mac-learning command output display identifies quarantined MAC addresses.

Examples
-> qos quarantine mac-group mac_group1
-> no quarantine mac-group

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-15
qos quarantine mac-group QoS Commands

Related Commands

qmr quarantine path Specifies the URL for a remediation server.

qmr quarantine page Configures the Quarantine Manager and Remediation (QMR)
application to send a Quarantined page to a client if a remediation server
is not configured.
show quarantine mac group Displays information about the Quarantine MAC group.
show qmr Displays the QMR configuration for the switch.

MIB Objects
alaQoSConfigTable
alaQoSConfigQuarantineMacGroupName

page 32-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos user-port

qos user-port
Configures the option to filter packets or administratively disable a port when the specified type of traffic
is received on a port that is a member of the pre-defined UserPorts group.
qos user-port {filter | shutdown} {spoof | bgp | bpdu | rip | ospf | vrrp | dvmrp | pim | isis | dhcp-
server | dns-reply}
qos no user-port {filter | shutdown}

Syntax Definitions

filter Filters the specified type of traffic when it is received on UserPort ports.
shutdown Administratively disables UserPort ports that receive the specified type
of traffic.
spoof Detects IP spoofing. The source IP address of a packet ingressing on a
user port is compared to the subnet of the VLAN for the user port; the
packet is dropped if these two items do not match. Also applies to ARP
packets.
bgp Filters only BGP protocol packets from a TCP session that was not
originated by the same switch that has this filter configured.
bpdu Filters conventional Spanning Tree BPDU (destination MAC address
0x0180c2:000000) packets and GVRP (destination MAC address
0x0180c2:000021) packets.
rip Filters RIP protocol packets.
ospf Filters OSPF protocol packets.
vrrp Filters VRRP protocol packets.
dvmrp Filters IGMP packets with a type of 0x13. This applies only to IP
packets with no options.
pim Filters PIMv1, PIM-DM, and PIM-SM packets. The PIMv1 filter
applies only to IP packets with no options.
isis Filters IS-IS protocol packets.
dhcp-server Filters response packets originating from a DHCP or BOOTP server that
is configured on the known UDP port 67.
dns-reply Filters all packets (both TCP and UDP) that originate from the known
DNS port 53.

Defaults

parameter default
filter spoof
shutdown none

Platforms Supported
OmniSwitch 6860, 6860E

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-17
qos user-port QoS Commands

Usage Guidelines
• Use the no form of this command to disable the filter or shutdown function. This form of the command
effects the overall operation of the feature.
• To specify more than one traffic type in the same command line, enter each type separated by a space
(e.g., spoof bgp ospf).
• Note that existing traffic types to filter or shutdown are removed each time the filter or shutdown
option is configured. Specify all desired traffic types each time the qos user-port command is
performed to retain previously configured traffic types.
• No changes to the filtering and shutdown options are applied to the switch until the qos apply
command is performed.
• This command only applies to ports that are members of the UserPorts group. Use the policy port
group command to create and assign members to the UserPorts group.
• An SNMP trap is sent when a port is administratively disabled through a UserPorts shutdown function
or a port disable action.
• To enable a port disabled by a user port shutdown operation, use the interfaces admin command to
administratively enable the port or disconnect and reconnect the port cable.
• Up to 126 IP interfaces are supported with spoof detection on user ports. If the number of interfaces
exceeds this amount, user port packets ingressing on those interfaces that exceed the 126 limit are
dropped.

Examples
-> qos user-port filter spoof bpdu
-> qos user-port shutdown spoof bgp ospf
-> qos no user-port shutdown

Release History
Release 8.1.1; command introduced.

Related Commands
policy port group Configures a port group and its associated slot and port numbers.
show qos config Displays QoS configuration information.

MIB Objects
alaQoSConfigTable
alaQoSConfigUserportFilter
alaQoSConfigAppliedUserportFilter
alaQoSConfigUserportShutdown
alaQoSConfigAppliedUserportShutdown

page 32-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos dei

qos dei
Configures the global Drop Eligible Indicator (DEI) bit mapping and marking setting for all QoS
ports.The DEI setting applies to packets marked yellow (non-conforming) as the result of Tri-Color Mark-
ing (TCM) rate limiting.
qos dei {ingress | egress}
qos no dei {ingress | egress}

Syntax Definitions

ingress Maps the DEI/CFI bit to yellow (non-conforming) if this bit is set for
ingress traffic.
egress Marks the DEI/CFI bit for egress packets if TCM marked the packets
yellow.

Defaults
By default, no DEI/CFI bit marking or mapping is done.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable the global DEI bit mapping (ingress) or marking (egress)
configuration for the switch.
• Use the qos port dei command to set the DEI bit mapping and marking configuration for a specific
port. Note that the port setting takes precedence over the global DEI setting.
• Packets marked yellow by TCM rate limiting are still transmitted when there is no congestion on the
egress port queues. Setting the DEI/CFI bit for yellow egress packets (qos dei egress) ensures that an
upstream switch is made aware that the packet was marked yellow.
• When a switch receives a yellow packet with the DEI/CFI bit set and ingress DEI/CFI bit mapping is
enabled (qos dei ingress), the packet is mapped to an internal drop precedence or yellow color mark-
ing for the switch.

Examples
-> qos dei ingress
-> qos dei egress
-> qos no dei ingress
-> qos no dei egress

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-19
qos dei QoS Commands

Related Commands

qos port Configures a physical port for QoS.

qos port dei Configures the Drop Eligible Indicator (DEI) bit mapping and marking
setting for the specified QoS port.
policy action cir Configures a Tri-Color Marking policy action.
show qos config Displays global information about the QoS configuration.
show qos port Displays information about QoS ports.

MIB Objects
alaQoSConfigTable
alaQoSConfigDEIMapping
alaQoSConfigDEIMarking

page 32-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos dscp-table

qos dscp-table
Configures the internal priority and drop precedence for the specified Differentiated Services Code Point
(DSCP) value. This value defines the six most significant bits of the DS byte in the IP header.
qos dscp-table value[-value2] priority priority drop-precedence {low | medium | high}

Syntax Definitions

value[-value2] The DSCP value. The range is 0–63.

priority The internal priority value to map to the DSCP value. The valid range is
0–7,
low Sets the drop precedence to low for the DSCP value.
medium Sets the drop precedence to medium for the DSCP value.
high Sets the drop precedence to high for the DSCP value.

Defaults
By default, the drop precedence value is set to low precedence.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The priority and drop precedence settings configured with this command are global settings that are
applied to all trusted ports.
• The values set in the DSCP table do not apply to untrusted ports.

Examples
-> qos dscp-table 63 priority 1 drop-precedence medium

Release History
Release 8.1.1; command was introduced.

Related Commands

show qos dscp-table Configures the priority and drop-precedence to be associated with
the configured DSCP table.

MIB Objects
alaQoSDSCPEntryNumber
alaQoSDSCPPriority
alaQoSDSCPDropPrecedence

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-21
debug qos QoS Commands

debug qos
Configures the type of QoS events that will be displayed in the QoS log.
debug qos [info] [config] [rule] [main] [port] [msg] [sl] [ioctl] [mem] [mapper] [slot] [l2] [l3] [classi-
fier] [nat] [sem] [pm] [ingress] [egress]
debug no qos
debug no qos [info] [config] [rule] [main] [port] [msg] [sl] [ioctl] [mem] [mapper] [slot] [l2] [l3] [clas-
sifier] [nat] [sem] [pm] [ingress] [egress]

Syntax Definitions

rule Logs events for rules configured on the switch.

l2 Logs Layer 2 QoS events on the switch.
l3 Logs Layer 3 QoS events on the switch.
nat Logs events for Network Address Translation policies. Not supported
for the OmniSwitch 6624/6648.
port Logs events related to QoS ports.
msg Logs QoS messages.
classifier Logs information whenever the switch classifies a flow; more details are
provided if the log level is higher.
info Logs basic information about the switch
config Logs information about the global configuration.
main Logs information about basic program interfaces.
sl Logs information about source learning.
mem Logs information about memory.
mapper Logs information about mapping queues.
slot Logs events related to slots.
sem Logs information about semaphore, process locking.
pm Logs events related to the Policy Manager.
ingress Logs information about packets arriving on the switch.
egress Logs information about packets leaving the switch.

Defaults
By default basic information messages are logged (info). Error messages are always logged.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to change the type of messages that will be logged or to return
debugging to its default state.

page 32-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands debug qos

• Use this command to troubleshoot QoS events on the switch.

Examples
-> debug qos flows queue
-> qos debug no flows no queue
-> debug no qos

Release History
Release 7.1.1; command was introduced.

Related Commands

qos forward log Enables the switch to send events to the PolicyView application in real
time.
qos log lines Configures the number of lines in the QoS log.
show qos log Displays the log of QoS events.

MIB Objects
alaQoSConfigTable
alaQoSConfigDebug

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-23
debug qos internal QoS Commands

debug qos internal

Displays debugging information for QoS internal to the switch.
debug qos internal [slice slot/slice] [flow] [queue] [port] [l2tree] [l3tree] [vector] [pending] [verbose]
[mapper] [pool] [log] [pingonly | nopingonly]

Syntax Definitions

slot/slice The slot number and slice for which you want to view debugging
information. A slice is a logical section of hardware that corresponds to
particular ports on a network interface module.
flow Displays information about QoS flows.
queue Displays information about QoS queues.
port Displays information about QoS ports.
l2tree Displays information about Layer 2 flows.
l3tree Displays information about Layer 3 flows.
vector Displays information about vectors.
pending Displays information about pending QoS objects.
verbose Sets the output to verbose mode for more detailed information.
mapper Displays information about QoS mapping flows to queues.
pool Displays information about the buffer pool.
log Displays information about QoS information that is logged.
pingonly Specifies that any policies configured with an ICMP protocol condition
apply only to ICMP echo-requests and echo-replies.
nopingonly Configures the switch so that any policies configured with an ICMP
protocol condition apply to any ICMP packets.

Defaults
Debugging is disabled by default.

parameter default
pingonly | nopingonly nopingonly

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the debug qos command to set the level of log detail in the QoS log.

Examples
-> debug qos internal "verbose log"

page 32-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands debug qos internal

Release History
Release 7.1.1; command was introduced.

Related Commands

debug qos Configures the type of QoS events that will be displayed in the QoS log.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-25
clear qos log QoS Commands

clear qos log

Clears messages in the current QoS log.
clear qos log

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command is useful for clearing messages from a large log file so that the file is easier to view. Logs
can get large if invalid rules are configured on the switch, or if a lot of QoS events have taken place.
Clearing the log makes the file easier to manage.

Examples
-> clear qos log

Release History
Release 8.1.1; command introduced.

Related Commands

qos log lines Configures the number of lines in the QoS log.
debug qos Configures the type of QoS events that will be displayed in the QoS log.
show qos log Displays the log of QoS events.

MIB Objects
alaQoSConfigTable
alaQoSConfigClearLog

page 32-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos apply

qos apply
Applies configured global QoS and policy settings to the current configuration (changes will be active and
stored in flash).
qos apply

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is required to activate all QoS and policy commands. This is the only command that
causes current changes to be written to flash.
• Rules are configured through the policy rule command, but are not active on the switch until you enter
qos apply.

Examples
-> qos apply

Release History
Release 8.1.1; command introduced.

Related Commands

qos revert Removes any policies configured through policy rule but not applied to
the current configuration through the qos apply command.
qos reset Resets the QoS configuration to its default values.
qos flush Deletes all pending policy information.

MIB Objects
alaQoSConfigTable
alaQoSConfigApply

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-27
qos revert QoS Commands

qos revert
Deletes any QoS configuration that has not been applied to the configuration through the qos apply
command.
qos revert

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use this command to remove currently configured policies that have not yet been activated through the
qos apply command.

Examples
-> qos revert

Release History
Release 8.1.1; command introduced.

Related Commands

policy rule Configures a policy rule and saves it to the current configuration but
does not make it active on the switch.
qos apply Applies all QoS settings configured on the switch to the current
configuration.
qos reset Resets the QoS configuration to its defaults.

MIB Objects
alaQoSConfigTable
alaQoSConfigRevert

page 32-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos flush

qos flush
Deletes all pending policy information. This command is different from qos revert, which returns the
pending policy configuration to its last applied settings.
qos flush

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If you enter this command, the pending policy configuration is completely erased. If you then enter qos
apply, the erased configuration overwrites the applied policies and you will erase all of your policy
configuration.

Note. Do not use this command unless you want to erase all of your policy configuration and start
configuring new policies.

• Use the qos revert command to return the pending policy configuration to its last applied value.

• Policy configuration includes the following commands:

base commands
policy rule policy mac group
policy network group policy port group
policy service policy condition
policy service group policy action

Examples
-> qos flush

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-29
qos flush QoS Commands

Related Commands

qos revert Deletes any QoS configuration that has not been applied to the
configuration through the qos apply command.
qos apply Applies configured global QoS and policy settings to the current
configuration (changes will be active and stored in flash).
policy server flush Removes all cached LDAP policy data from the switch.

MIB Objects
alaQoSConfigTable
alaQoSConfigFlush

page 32-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos reset

qos reset
Resets the QoS configuration to its defaults.
qos reset

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use this command to reset QoS configuration that has not yet been applied through the qos apply
command. The parameters are reset to their defaults.

Note. If SIP Snooping is enabled for the switch, this command will not reset the automatic IP phone
prioritization to the trusted default value.

Examples
-> qos reset

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies all QoS settings configured on the switch to the current
configuration.
qos revert Deletes any QoS configuration that has not been applied to the
configuration through the qos apply command.

MIB Objects
alaQoSConfigTable
alaQoSConfigReset

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-31
qos stats reset QoS Commands

qos stats reset

Resets QoS statistic counters to zero.
qos stats reset

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use this command to reset global QoS statistics to zero. Statistics may be displayed with the show qos
statistics command.

Examples
-> qos stats reset

Release History
Release 8.1.1; command introduced.

Related Commands

show qos statistics Displays statistics about the QoS configuration.

MIB Objects
alaQoSConfigTable
alaQoSConfigStatsReset

page 32-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos port reset

qos port reset

Resets all QoS port configuration to the default values.
qos port chassis/slot/port[-port2] reset

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The QoS port configuration parameters that are reset include:

parameter default
default queues 8
trusted not trusted

Examples
-> qos port 1/1/1 reset

Release History
Release 8.1.1; command introduced.

MIB Objects
alaQoSPortTable
alaQoSPortSlot
alaQoSPortPort
alaQoSPortReset

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-33
qos port QoS Commands

qos port
Configures QoS parameters for a physical port. This section describes the base command with a single
required option (chassis/slot/port).
In lieu of these options, the base command (qos port) may be used with other keywords to set up a QoS
configuration on a per port basis. These keywords are listed here and described as separate commands later
in this chapter. In addition, some keywords have a no form to remove the parameter or return it to its
default.
qos port chassis/slot/port[-port2]
[trusted]
[maximum egress-bandwidth bps]
[maximum ingress-bandwidth bps]
[maximum depth bps]
[default 802.1p value]
[default dscp value]
[default classification {802.1p | tos | dscp}]

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).

Defaults
• All ports are untrusted.

• By default, QoS ports do not preempt queues of lower priority.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the trusted option to change the trust mode for the port.

Examples
-> qos port 1/1/1 trusted
-> qos port 1/1/2 no trusted

Release History
Release 8.1.1; command introduced.

page 32-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos port

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
qos port Configures whether the default mode for QoS ports is trusted or
untrusted.
show qos port Displays information about QoS ports.

MIB Objects
alaQoSPortTable
alaQoSPortSlot
alaQoSPortPort
alaQoSPortTrusted
alaQoSPortMaximumBandwidth
alaQoSPortMaximumBandwidthStatus
alaQoSPortMaximumIngBandwidth
alaQoSPortMaximumIngBandwidthStatus
alaQoSPortMaximumDefaultDepth
alaQoSPortMaximumDefaultDepthStatus
alaQoSPortDefault8021p
alaQoSPortDefaultDSCP
alaQoSPortDefaultClassification

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-35
qos port trusted QoS Commands

qos port trusted

Configures whether an individual port is trusted or untrusted. Trusted ports can accept the 802.1p and ToS/
DSCP values in incoming packets; untrusted ports will set any 802.1p or ToS/DSCP values to zero in
incoming packets, unless a default 802.1p or ToS/DSCP value is configured.
qos port chassis/slot/port[-port2] trusted
qos port chassis/slot/port[-port2] no trusted

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).

Defaults
By default, all ports are untrusted.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the qos trust ports command to set the default trust mode for all QoS ports. The qos port trusted
command may be used to override the default.
• The setting applies only to ports with incoming traffic.

• Use the qos port default 802.1p or qos port default dscp commands to specify that a value other than
zero should be applied to the incoming packets. Note that this value is overridden if a policy exists that
specifies a different 802.1p or ToS/DSCP value for such packets.

Examples
-> qos port 1/1/1 trusted
-> qos port 1/1/2 no trusted

Release History
Release 8.1.1; command introduced.

page 32-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos port trusted

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
qos port Configures a physical port for QoS.
qos trust ports Configures the global trust mode for QoS ports.
show qos port Displays information about QoS ports.

MIB Objects
alaQoSPortTable
alaQoSPortTrusted

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-37
qos port maximum egress-bandwidth QoS Commands

qos port maximum egress-bandwidth

Configures the maximum rate at which to send traffic on the specified QoS port.
qos port chassis/slot/port[-port2] maximum egress-bandwidth bps[k | m | g | t]
qos port chassis/slot/port[-port2] no maximum egress-bandwidth

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
bps[k | m | g | t] The maximum amount of bandwidth, in bits-per-second, for all traffic
that egresses on the port. The value may be entered as an integer (for
example, 10) or with abbreviated units (for example, 10k, 5m, 1g, 1t).

Defaults
By default, the maximum bandwidth is the maximum allowed for the interface type on which the port
resides.

parameter default
k|m|g|t k

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a configured maximum egress bandwidth value from a
port.
• If the maximum egress bandwidth value is specified as an integer, without an abbreviated unit designa-
tion, the value is applied in kbps by default. For example, if the number 10 is specified, 10K is the
maximum bandwidth value used. However, if 10G is specified, the maximum bandwidth value applied
is 10 gbps.
• The maximum egress bandwidth value cannot exceed the maximum bandwidth of the interface type
associated with the port.
• Modifying the maximum egress bandwidth is most useful for low-bandwidth links.

• Port-based limiting takes the IFG of 20 bytes into account when calculating bandwidth.

Examples
-> qos port 1/1/1 maximum egress-bandwidth 1000
-> qos port 1/1/2-8 maximum egress-bandwidth 10m
-> qos port 1/1/1 no maximum egress-bandwidth
-> qos port 1/1/2-8 no maximum egress-bandwidth

page 32-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos port maximum egress-bandwidth

Release History
Release 8.1.1; command introduced.

Related Commands

qos port maximum ingress- Configures the rate at which traffic is received on a QoS port.
bandwidth
qos apply Applies configured QoS and policy settings to the current configuration.
qos port Configures a physical port for QoS.
show qos port Displays information about QoS ports.

MIB Objects
alaQoSPortTable
alaQoSPortSlot
alaQoSPortPort
alaQoSPortMaximumBandwidth
alaQoSPortMaximumBandwidthStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-39
qos port maximum ingress-bandwidth QoS Commands

qos port maximum ingress-bandwidth

Configures the maximum rate at which traffic is received on a QoS port.
qos port chassis/slot/port[-port2] maximum ingress-bandwidth bps[k | m | g | t]
qos port chassis/slot/port[-port2] no maximum ingress-bandwidth

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
bps[k | m | g | t] The maximum amount of bandwidth, in bits-per-second, for all traffic
that ingresses on the port. The value may be entered as an integer (for
example, 10) or with abbreviated units (for example, 10k, 5m, 1g, 1t).

Defaults
By default, the maximum bandwidth is the maximum allowed for the interface type on which the port
resides.

parameter default
k|m|g|t k

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a configured maximum ingress bandwidth value from a
port.
• If the maximum ingress bandwidth value is specified as an integer, without an abbreviated unit desig-
nation, the value is applied in kbps by default. For example, if the number 10 is specified, 10K is the
maximum bandwidth value used. However, if 10G is specified, the maximum bandwidth value applied
is 10 gbps.
• The maximum ingress bandwidth value cannot exceed the maximum bandwidth of the interface type
associated with the port.
• Modifying the maximum ingress bandwidth is most useful for low-bandwidth links.

• Port-based limiting takes the IFG of 20 bytes into account when calculating bandwidth.

Examples
-> qos port 1/1/1 maximum ingress-bandwidth 1000
-> qos port 1/1/2-8 maximum ingress-bandwidth 10m
-> qos port 1/1/1 no maximum ingress-bandwidth
-> qos port 1/1/2-8 no maximum ingress-bandwidth

page 32-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos port maximum ingress-bandwidth

Release History
Release 8.1.1; command introduced.

Related Commands

qos port maximum egress- Configures the rate at which traffic is sent on a QoS port.
bandwidth
qos apply Applies configured QoS and policy settings to the current configuration.
qos port Configures a physical port for QoS.
show qos port Displays information about QoS ports.

MIB Objects
alaQoSPortTable
alaQoSPortSlot
alaQoSPortPort
alaQoSPortMaximumIngBandwidth
alaQoSPortMaximumIngBandwidthStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-41
qos port maximum depth QoS Commands

qos port maximum depth

Configures the maximum bucket size used for traffic metering. The bucket size determines how much the
traffic can burst over the maximum bandwidth rate.
qos port chassis/slot/port[-port2] maximum depth bps[k | m | g | t]
qos port chassis/slot/port[-port2] no maximum depth

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
bps[k | m | g | t] The maximum bucket size, in bits-per-second. The value may be entered
as an integer (for example, 10) or with abbreviated units (for example,
10k, 5m, 1g).

Defaults

parameter default
k|m|g|t k

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This QoS port parameter is configured in conjunction with the maximum bandwidth parameters. When
the bucket size is reached, the switch starts to drop packets.
• Use the no form of the command to remove the maximum depth setting from a port.

• If the maximum depth value is specified as an integer, without an abbreviated unit designation, the
value is applied in kbps by default. For example, if the number 10 is specified, 10K is the maximum
depth value used. However, if 10G is specified, the maximum depth value applied is 10 gbps.
• Modifying the maximum depth is most useful for low-bandwidth links.

Examples
-> qos port 1/1/1 maximum depth 100
-> qos port 1/1/2-8 maximum depth 10m
-> qos port 1/1/1 no maximum depth
-> qos port 1/1/2-8 no maximum depth

Release History
Release 8.1.1; command introduced.

page 32-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos port maximum depth

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
qos port Configures a physical port for QoS.
show qos port Displays information about QoS ports.

MIB Objects
alaQoSPortTable
alaQoSPortSlot
alaQoSPortPort
alaQoSPortMaximumDefaultDepth

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-43
qos port default 802.1p QoS Commands

qos port default 802.1p

Configures the 802.1p value to be inserted in flows ingressing on an untrusted port.
qos port chassis/slot/port[-port2] default 802.1p value

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
value The priority value to be set. Values range from 0 (lowest priority) to 7
(highest priority).

Defaults

parameter default
value 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• By default untrusted ports will set the 802.1p bit to zero on incoming flows. Use this command to spec-
ify that a different 802.1p value should be applied to the flow.
• The default 802.1p value is not used if there is a matching QoS policy rule that sets the priority.

Examples
-> qos port 1/1/1 default 802.1p 5
-> qos port 1/1/2-8 default 802.1p 7

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
qos port Configures a physical port for QoS.
show qos port Displays information about QoS ports.

MIB Objects
alaQoSPortTable
alaQoSPortDefault8021p

page 32-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos port default dscp

qos port default dscp

Configures the ToS/DSCP value to be inserted in flows ingressing on an untrusted port.
qos port chassis/slot/port[-port2] default dscp value

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
value The ToS/DSCP value. The range is 0–63.

Defaults

parameter default
value 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The value configured by this command sets the upper byte (precedence) and therefore configures the
ToS/DSCP value for the port.
• The default DSCP value is not used if there is a matching QoS policy rule that sets the priority.

Examples
-> qos port 1/1/1 default dscp 63
-> qos port 1/1/2-8 default dscp 33

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
qos port Configures a physical port for QoS.
show qos port Displays information about QoS ports.

MIB Objects
alaQoSPortTable
alaQoSPortDefaultDSCP

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-45
qos port default classification QoS Commands

qos port default classification

Specifies the default egress priority value to use for IP traffic ingressing on trusted ports.
qos port chassis/slot/port[-port2] default classification {tos | 802.1p | dscp}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
tos Specifies that the ToS value of the flow will be used to prioritize flows
coming in on the port.
802.1p Specifies that the 802.1p value of the flow will be used to prioritize
flows coming in on the port.
dscp Specifies that the DSCP value of the flow will be used to prioritize
flows coming in on the port.

Defaults

parameter default
tos | 802.1p | dscp dscp

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The egress priority assigned to an IP packet received on a trusted port is based on the DSCP value of
the packet unless 802.1p is specified using this command.
• The default classification priority is not used if there is a matching QoS policy rule that sets the egress
priority value.
• This command does not affect Layer 2 traffic, which is always classified with 802.1p.

• In some network situations, some IP traffic may be dropped before any QoS rules can take effect for
the traffic.

Examples
-> qos port 1/1/24 default classification dscp
-> qos port 1/1/1-8 default classification dscp
-> qos port 2/1/1 default classification 802.1p
-> qos port 2/5/1-8 default classification 802.1p

Release History
Release 8.1.1; command introduced.

page 32-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos port default classification

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
qos port Configures a physical port for QoS.
show qos port Displays information about QoS ports.

MIB Objects
alaQoSPortTable
alaQoSPortDefaultClassification

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-47
qos port dei QoS Commands

qos port dei

Configures the Drop Eligible Indicator (DEI) bit mapping and marking setting for the specified QoS port.
The DEI setting applies to packets marked yellow (non-conforming) as the result of Tri-Color Marking
(TCM) rate limiting.
qos port chassis/slot/port dei {ingress | egress}
qos port chassis/slot/port no dei {ingress | egress}

Syntax Definitions

chassis/slot/port The chassis ID, slot, and port number (3/1/1) for a specific port.
ingress Maps the DEI/CFI bit to yellow (non-conforming) if this bit is set for
ingress packets.
egress Sets the DEI/CFI bit for egress packets if TCM marked the packets
yellow.

Defaults
By default, no DEI/CFI bit mapping or marking is done.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable the DEI bit mapping (ingress) or marking (egress) configu-
ration for the specified port
• Use the qos dei command to set the global DEI bit mapping and marking configuration for all QoS
switch ports. Note that the port-level setting takes precedence over the global DEI setting.
• Packets marked yellow by TCM rate limiting are still transmitted when there is no congestion on the
egress port queues. Setting the DEI/CFI bit for yellow egress packets (qos port dei egress) ensures that
an upstream switch is made aware that the packet was marked yellow.
• When a switch receives a yellow packet with the DEI/CFI bit set and ingress DEI/CFI bit mapping is
enabled (qos port dei ingress), the packet is mapped to an internal drop precedence or yellow color
marking for the switch.
• When the default QoS classification value is set to DSCP, the DEI bit is not relevant for DSCP pack-
ets. As a result, the color/congestion is derived from the values carried in the DSCP bit, not from the
incoming DEI. However, if the default QoS classification is set to 802.1p, the DEI/CFI is honored for
both Layer 2 and Layer 3 traffic.

Examples
-> qos port 1/1/10 dei ingress
-> qos port 1/1/20 dei egress
-> qos port 1/1/10 no dei ingress
-> qos port 1/1/20 no dei egress

page 32-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos port dei

Release History
Release 8.1.1; command introduced.

Related Commands

qos port Configures a physical port for QoS.

qos dei Configures the global Drop Eligible Indicator (DEI) bit mapping and
marking setting for all QoS ports.
policy action cir Configures a Tri-Color Marking policy action.
show qos config Displays global information about the QoS configuration.
show qos port Displays information about QoS ports.

MIB Objects
alaQoSPortTable
alaQoSPortDEIMapping
alaQoSPortDEIMarking

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-49
qos qsi qsp QoS Commands

qos qsi qsp

Configures the QSet profile (QSP) association for the specified QSet instance (QSI). A QSI is a set of
eight queues that is automatically associated with each port and link aggregate (LAG) ID.
qos qsi {port chassis/slot/port[-port2] | slot slot | linkagg agg_id[-agg_id2]} qsp {qsp_id | qsp_name}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis/slot The chassis ID and slot number (3/1) for a specific slot. Associates all
ports on the slot with QSet (3/1).
agg_id[-agg_id2] The link aggregate ID to associate with the QSet. Use a hyphen to
specify a range of IDs (10-20).
qsp_id An existing QSet profile (QSP) ID number to assign to this instance.
The valid range is 1–4.
qsp_name An existing QSet profile name (qsp-1, qsp-2, qsp-3, qsp-4) to assign to
this instance.

Defaults
By default, QSP 1 is assigned to each QSet instance.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• There is only one QSI per port or LAG ID and only one QSP associated with the QSI.

• A QSI hierarchy exists consisting of parent/child relationships. For example, all member ports of a link
aggregate will import the QSI/QSP settings of the parent link aggregate. When a member port moves
out of the link aggregate, the QSI/QSP settings for that port are reset to the default settings.
• The number of children supported for a LAG ID is 8.

Examples
-> qos qsi port 1/1/2 qsp 2
-> qos qsi port 1/1/2-10 qsp 3
-> qos qsi slot 3/1 qsp 4
-> qos qsi linkagg 10 qsp 2

Release History
Release 8.1.1; command introduced.

page 32-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos qsi qsp

Related Commands

qos qsi stats Configures statistics collection for the QSet instance.
show qos qsi Displays the QSet instance configuration.
show qos qsp Displays the QSet profile attributes.

MIB Objects
alaVfcQsetInstanceTable
alaVfcQsetQSPId
alaVfcQsetQSPName
alaVfcQsetWRPAdminState
alaVfcQsetStatsAdmin
alaVfcQsetStatsInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-51
qos qsi stats QoS Commands

qos qsi stats

Configures the administrative status and interval for statistics collection for the specified QSet instance
(QSI). A QSI is a set of eight queues that is automatically associated with each port and link aggregate
(LAG) ID.
qos qsi {port chassis/slot/port[-port2] | slot chassis/slot | linkagg agg_id[-agg_id]} stats {admin-state
{enable | disable} | interval interval_time}]}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis/slot The chassis ID and slot number (3/1) for a specific slot.
agg_id[-agg_id] The link aggregate ID to associate with the QSet. Use a hyphen to
specify a range of IDs (10-20).
enable Enables statistics collection for the instance.
disable Disables statistics collection for the instance.
interval_time The time interval for statistics gathering. The valid range is 10–300
seconds.

Defaults
By default, statistics collection is disabled and the time interval is set to 10 seconds.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• There is only one QSI per port or LAG ID and only one QSet profile (QSP) associated with the QSI.

• Changing the statistics collection status for a QSI only changes the status for the port or link aggregate
to which the QSI is associated.

Examples
-> qos qsi port 1/1/2 stats admin-state enable
-> qos qsi port 1/1/2 stats interval 30
-> qos qsi port 1/1/5-10 stats admin-state enable
-> qos qsi slot 3/1 stats admin-state enable interval 250
-> qos qsi linkagg 10 stats admin-state enable interval 120

Release History
Release 8.1.1; command introduced.

page 32-52 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands qos qsi stats

Related Commands

qos qsi qsp Configures the QSet profile association for the QSet instance.
show qos qsi Displays the QSet instance configuration.
show qos qsi stats Displays statistics for one or more QSet instances.

MIB Objects
alaVfcQsetInstanceTable
alaVfcQsetQSPId
alaVfcQsetQSPName
alaVfcQsetWRPAdminState
alaVfcQsetStatsAdmin
alaVfcQsetStatsInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-53
show qos port QoS Commands

show qos port

Displays information about all QoS ports or a particular port.
show qos port [chassis/slot/port] [statistics]

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
statistics Displays statistics for high-density gigabit modules.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Information for all ports is displayed unless a particular port is specified.

• Use the qos port command to configure port parameters.

• For ports that are trusted (Yes displays in the Trust field), the Trust field includes one of the following
characters:

character definition
+ Indicates that the port is manually configured as trusted through the qos
port trusted command; the port setting takes precedence over the global
trust setting configured through the qos trust ports command.
* Indicates that the port is automatically trusted regardless of the global
setting set through the qos trust ports command. (Applies to mobile ports
and ports configured for 802.1Q.)

Examples
-> show qos port
chassis/
Slot/ Default Default Bandwidth DEI
Port Active Trust P/DSCP Classification Physical Ingress Egress Map/Mark Type
-----+------+-----+------+---------------+--------+-------+-------+---------+-------------
1/1/1 No No 0/ 0 DSCP 0K - - No / No ethernet
1/1/2 Yes No 0/ 0 DSCP 1.00G - - No / No ethernet-1G
1/1/3 No No 0/ 0 DSCP 0K - - No / No ethernet
1/1/4 No No 0/ 0 DSCP 0K - - No / No ethernet
1/1/5 No No 0/ 0 DSCP 0K - - No / No ethernet
1/1/6 No No 0/ 0 DSCP 0K - - No / No ethernet
1/1/7 No No 0/ 0 DSCP 0K - - No / No ethernet
1/1/8 No No 0/ 0 DSCP 0K - - No / No ethernet
1/1/9 No No 0/ 0 DSCP 0K - - No / No ethernet
1/1/10 No No 0/ 0 DSCP 0K 50K - No / No ethernet

page 32-54 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands show qos port

1/1/11 No *Yes 0/ 0 *802.1P 0K - - No / No ethernet

1/1/12 No *Yes 0/ 0 *802.1P 0K - - No / No ethernet
-> show qos port 1/2
chassis/
Slot/ Default Default Bandwidth DEI
Port Active Trust P/DSCP Classification Physical Ingress Egress Map/Mark Type
-----+------+-----+------+---------------+--------+-------+-------+---------+-------------
1/1/2 Yes No 0/ 0 DSCP 1.00G - - No / No ethernet-1G

output definitions
chassis/slot/port The chassis, slot, and physical port number.
Active Whether or not the port is sending/receiving QoS traffic.
Trust Whether the port is trusted or not trusted. Configured through the qos
port trusted command.
Default P The default 802.1p setting for the port. Configured through the qos
port default 802.1p command.
Default DSCP The default ToS/DSCP setting for the port. Configured through the qos
port default dscp command.
Default Classification The default classification setting for the port (802.1p, ToS, or DSCP).
Configured through the qos port default classification command.
Physical Bandwidth The amount of physical bandwidth available on the port.
Ingress Bandwidth The amount of ingress bandwidth configured for the port. Configured
through the qos port maximum ingress-bandwidth command.
Egress Bandwidth The amount of egress bandwidth configured for the port. Configured
through the qos port maximum egress-bandwidth command.
DEI Map/Mark The Drop Eligible Indicator (DEI) bit mapping and marking setting for
the port. Configured through the qos port dei command.
Type The interface type, ethernet or wan.

Release History
Release 8.1.1; command introduced.

Related Commands

qos port Configures a physical port for QoS.

MIB Objects
alaQoSPortTable
alaQoSPortSlot
alaQoSPortPort
alaQoSPortEnabled
alaQoSPortDefault8021p
alaQoSPortDefaultDSCP
alaQoSPortMaximumDefaultBandwidth
alaQoSPortDefaultClassification

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-55
show qos slice QoS Commands

show qos slice

Displays rule availability and usage information for QoS slices of QoS slots. A slice is a logical section of
hardware and corresponds to particular ports on the interface.
show qos slice [chassis/slot/slice]

Syntax Definitions

chassis/slot/slice The chassis ID, slot number, and slice for which you want to view
information. The number of slices per module varies depending on the
type of module.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Information for all slots/slices is displayed unless a particular slot/slice is requested.

• This command is useful for monitoring switch resources required for policy rules.

Examples
-> show qos slice
Slot/ Ranges Rules Counters Meters
Unit Type Total/Free CAM Total/Free Total/Free Total/Free
1/1/(0) IFP 24/24 0 256/253 256/253 256/256
1 256/255 256/255 256/256
2 256/256 256/256 256/256
3 256/256 256/256 256/256
4 256/256 256/256 256/256
5 256/256 256/256 256/256
6 256/256 256/256 256/256
7 256/256 256/256 256/256
8 256/256 256/256 256/256
9 256/256 256/256 256/256
10 256/256 256/256 256/256
11 256/256 256/256 256/256
12 256/256 256/256 256/256
13 256/256 256/256 256/256
14 256/255 256/254 256/254
15 256/255 256/256 256/256
1/1/(0) EFP 0/0 0 256/256 256/256 256/256
1 256/256 256/256 256/256
2 256/256 256/256 256/256
3 256/256 256/256 256/256

page 32-56 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands show qos slice

output definitions
Slot/Slice The chassis ID, slot, and slice number.
Type The type of slice.
Ranges Total The total number of TCP/UDP port ranges supported per slot/slice.
Ranges Free The number of TCP/UDP port ranges that are still available for use.
CAM The CAM number.
Rules Total The total number of rules supported per CAM.
Rules Free The number of rules that are still available for use. On startup, the
switch uses 27 rules.
Counters Total The total number of counters supported per CAM.
Counter Free The number of counters that are still available for use.
Meters Total The total number of meters supported per CAM.
Meters Free The number of meters that are still available for use.

Release History
Release 8.1.1; command introduced.

Related Commands

policy rule Configures a policy rule on the switch. A rule is made up of a condition
(for classifying incoming traffic) and an action (to be applied to
outgoing traffic).

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-57
show qos log QoS Commands

show qos log

Displays the log of QoS events.
show qos log

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use this command to display the current QoS log. To clear the log, use the qos clear log command.

Examples
-> show qos log
**QOS Log**
Insert rule 0
Rule index at 0
Insert rule 1
Rule index at 1
Insert rule 2
Rule index at 2
Enable rule r1 (1) 1,1
Enable rule r2 (0) 1,1
Enable rule yuba1 (2) 1,1
Verify rule r1(1)
Enable rule r1 (1) 1,1
Really enable r1
Update condition c1 for rule 1 (1)
Verify rule r2(1)
Enable rule r2 (0) 1,1
Really enable r2
Update condition c2 for rule 0 (1)
Verify rule yuba1(1)
Enable rule yuba1 (2) 1,1
Really enable yuba1
Update condition yubamac for rule 2 (1)
QoS Manager started TUE MAR 10 13:46:50 2002

Match rule 2 to 1
Match rule 2 to 2
Match rule 2 to 3

page 32-58 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands show qos log

Release History
Release 8.1.1; command introduced.

Related Commands

qos clear log Clears messages in the current QoS log.

qos log lines Configures the number of lines in the QoS log.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-59
show qos config QoS Commands

show qos config

Displays global information about the QoS configuration.
show qos config

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use this command to view the current global configuration for QoS. Use the show qos statistics command
to view statistics about the QoS software in the switch.

Examples
-> show qos config
QoS Configuration,
Admin = enable,
Trust ports = no,
Phones = trusted,
Log lines = 10240,
Log level = 5,
Log console = no,
Forward log = no,
Stats interval = 5,
User-port filter = spoof,
User-port shutdown = none,
Debug = info,
Pending changes = port

output definitions
Admin Whether or not QoS is enabled or disabled. Configured through the qos
command.
Trust Ports The default trusted mode for switch ports. Configured through the qos
trust ports command.
Phones Whether or not IP Phone traffic is automatically trusted or assigned a
priority value. Configured through the qos phones command.
Log lines The number of lines included in the QoS log. Configured through the
qos log lines command.
Log level The level of log detail. Configured through the qos log level command.

page 32-60 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands show qos config

output definitions (continued)

Log console Whether or not log messages are sent to the console. Configured
through the qos log console command.
Forward log Whether or not logged events are sent to the policy server software in
the switch in real time. Configured through the qos forward log
command.
Stats interval How often the switch polls network interfaces for statistics about QoS
events. Configured through the qos stats interval command.
User-port filter The type of traffic that is filtered on ports that are members of the
UserPorts group. Configured through the qos user-port command.
User-port shutdown The type of traffic that will trigger an administrative shutdown of the
port if the port is a member of the UserPorts group. Configured through
the qos user-port command.
Debug The type of information that will be displayed in the QoS log. A value
of info indicates the default debugging type.
Pending changes QoS changes not yet applied to the configuration.

Release History
Release 8.1.1; command introduced.

Related Commands
qos Enables or disables QoS. This base command may be used with
keyword options to configure QoS globally on the switch.
show qos statistics Displays statistics about the QoS configuration.

MIB Objects
alaQoSConfigTable
alaQoSConfigEnable
alaQosConfigTrustPorts
alaQoSConfigAutoPhones
alaQoSConfigLogLines
alaQoSConfigLogLevel
alaQoSConfigLogConsole
alaQoSConfigStatsInterval
alaQosConfigUserportFilter
alaQosConfigUserportShutdown
alaQosConfigDebug

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-61
show qos statistics QoS Commands

show qos statistics

Displays statistics about the QoS configuration.
show qos statistics

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays statistics about the global QoS configuration. Use the show qos config command
to display information about configurable global parameters.

Examples
-> show qos statistics
QoS stats
Events Matches Drops
L2 : 0 0 0
L3 Inbound : 0 0 0
L3 Outbound : 0 0 0
IGMP Join : 0 0 0
Fragments : 0
Bad Fragments : 0
Unknown Fragments : 0
Sent NI messages : 0
Received NI messages : 85
Failed NI messages : 4
Max PTree nodes : 0
Max PTree depth : 0
Spoofed Events : 0
NonSpoofed Events : 0

Software resources
Applied Pending
Table CLI LDAP Blt Total CLI LDAP Blt Total Max
rules 0 0 0 0 0 0 0 0 8192
actions 0 0 0 0 0 0 0 0 8192
conditions 0 0 0 0 0 0 0 0 8192
services 0 0 0 0 0 0 0 0 256
service groups 0 0 0 0 0 0 0 0 1024
network groups 0 0 1 1 0 0 1 1 1024
port groups 1 0 0 1 1 0 0 1 1024
mac groups 0 0 0 0 0 0 0 0 1024
map groups 0 0 0 0 0 0 0 0 1024

page 32-62 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands show qos statistics

validity periods 0 0 0 0 0 0 0 0 64

Hardware resources TCAM Ranges

Slot Slice Unit Used Free Max Used Free Max
0/ 1 0 0 1 1023 1024 0 32 32

output definitions
Events The number of Layer 2 or Layer 3 flows transmitted on the switch.
Matches The number of Layer 2 or Layer 3 flows that match policies.
Drops The number of Layer 2 or Layer 3 flows that were dropped.
L2 The number of Layer 2 events, matches, and drops.
L3 Ingress The number of Layer 3 ingress events, matches, and drops.
L3 Egress The number of Layer 3 egress events, matches, and drops
IGMP join The number of multicast events, matches, and drops.
Fragments The number of fragments dropped.
Bad Fragments The number of fragments received with an offset of 1.
Unknown Fragments The number of out-of-order fragments received.
Sent NI messages The number of messages sent to network interfaces.
Received NI messages The number of messages received by network interfaces.
Failed NI messages The number of failed message attempts to network interfaces.
Load balanced flows The number of Server Load Balance flow entries.
Reflexive flows The number of reflexive flows.
Reflexive correction The number of reflexive flow corrections.
Flow lookups The number of flow table lookups.
Flow hits The number of flow table lookup hits.
Max PTree nodes The highest number of nodes in the classifier tree.
Max Ptree depth The length of the longest path in the classifier tree.
Spoofed Events The number of spoofed events.
Nonspoofed Events The number of non-spoofed events.
DropServices The number of TCP/UDP flows dropped.

Release History
Release 8.1.1; command introduced.

Related Commands

qos stats reset Resets QoS statistic counters to zero.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-63
show qos statistics QoS Commands

MIB Objects
alaQoSStats
alaQoSStatsL2Events
alaQoSStatsL2matches
alaQoSStatsL2Drops
alaQoSStatsL3IngressEvents
alaQoSStatsL3IngressMatches
alaQoSStatsL3IngressDrops
alaQoSStatsL3EgressEvents
alaQoSStatsL3EgressMatches
alaQoSStatsL3EgressDrops
alaQoSStatsFragments
alaQoSStatsBadFragments
alaQoSStatsUnknownFragments
alaQoSStatsSpoofedEvents
alaQoSStatsNonspoofedEvents

page 32-64 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands show qos dscp-table

show qos dscp-table

Displays the QoS DSCP table. This table contains the internal priority mapping and drop precedence value
for each of the DSCP values.
show qos dscp-table

Syntax Definitions

N/A

Defaults
N/A.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The DSCP table mapping is a global configuration that applies to all trusted ports; does not apply to
untrusted ports.

Examples
-> show qos dscp-table
DSCP-Table Priority Drop-Precedence
------------+--------------+--------------------
0 0 low
1 0 low
2 0 low
3 0 low
4 0 low
5 0 low
6 0 low
7 0 low
8 1 low
9 1 low
10 1 low

output definitions
DSCP-Table The DSCP number.
Priority The priority number mapped to the DSCP value.
Drop-Precedence The drop precedence value mapped to the DSCP value.

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-65
show qos dscp-table QoS Commands

Related Commands

qos dscp-table Configures the priority and drop-precedence value associated with
the DSCP number.

MIB Objects
alaQoSDSCPEntryNumber
alaQoSDSCPPriority
alaQoSDSCPDropPrecedence

page 32-66 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands show qos qsi summary

show qos qsi summary

Displays a list of switch ports showing the QoS profile assigned to each port.
show qos qsi {port chassis/slot/port[-port2] | linkagg agg_id[-agg_id]} summary

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id] A link aggregate ID. Use a hyphen to specify a range of IDs (10-15).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays the summary of the user ports in the switch.

Examples
-> show qos qsi summary
Legends: * indicates port is misconfigured.

Profile
Port # Name Mode Parent
-------+---+------------+----+------
1/1/1 1 qsp-1 NDCB 1/1/1
1/1/2 1 qsp-1 NDCB 1/1/2
1/1/3 1 qsp-1 NDCB 1/1/3
1/1/4 1 qsp-1 NDCB 1/1/4
1/1/5 1 qsp-1 NDCB 1/1/5
1/1/6 1 qsp-1 NDCB 1/1/6
1/1/7 1 qsp-1 NDCB 1/1/7
1/1/8 1 qsp-1 NDCB 1/1/8
1/1/9 1 qsp-1 NDCB 1/1/9

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-67
show qos qsi summary QoS Commands

Related Commands

show qos qsi Displays the QSet profile (QSP) configuration for the switch.
qos qsi qsp Assigns a QSet profile to a port or link aggregate.

MIB Objects
alaVfcQsetInstanceTable
alaVfcQsetId
alaVfcQsetQSPId
alaVfcQsetQSPName
alaVfcQsapParent

page 32-68 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands show qos qsp

show qos qsp

Displays the QSet profile (QSP) configuration for the switch.
show qos qsp [qsp_id | qsp_name] [detail [port chassis/slot/port[-port2]] | slot chassis/slot | linkagg
agg_id[-agg_id]]

Syntax Definitions

qsp_id A QSet profile (QSP) ID number. The valid range is 1–4.

qsp_name A QSP profile name.
detail Displays QSP configuration details for a specific profile, port, slot, or
link aggregate.
chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis/slot The chassis ID and slot number (3/1) for a specific slot. Displays
information for all ports on the slot.
agg_id[-agg_id] The link aggregate ID. Use a hyphen to specify a range of IDs (10-15).

Defaults
By default, displays the configuration for all four of the QSet profiles (QSP 1–4).

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the qse_id or the qsp_name parameter to display information for a specific profile.

• Use the detail parameter to display additional profile information for all ports and link aggregates.

• Use the port chassis/slot/port, slot chassis/slot, and linkagg agg_id parameters to display profile infor-
mation associated with specific ports or link aggregates. These parameters are used in combination
with the detail parameter.

Examples
-> show qos qsp 2
QSP 2 (qsp-2)
#Ports: 0, #Queues: 8, BW (%): 100,
WRP: 1, Name: wrp-1
Scheduler: Qspec, Type: Sta,
Template: 2, Name: qsp-2
QP 1
Qtype: EF,
WRP: 1, Name: wrp-1
CIR (%): 0, PIR (%): 20,
WFQ-Mode: WERR, WFQ-Weight: 0
QP 2
Qtype: SP6,

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-69
show qos qsp QoS Commands

WRP: 1, Name: wrp-1

CIR (%): 0, PIR (%): 100,
WFQ-Mode: WERR, WFQ-Weight: 0
QP 3
Qtype: SP5,
WRP: 1, Name: wrp-1
CIR (%): 0, PIR (%): 100,
WFQ-Mode: WERR, WFQ-Weight: 0
QP 4
Qtype: SP4,
WRP: 1, Name: wrp-1
CIR (%): 0, PIR (%): 100,
WFQ-Mode: WERR, WFQ-Weight: 0
QP 5
Qtype: SP3,
WRP: 1, Name: wrp-1
CIR (%): 0, PIR (%): 100,
WFQ-Mode: WERR, WFQ-Weight: 0
QP 6
Qtype: SP2,
WRP: 1, Name: wrp-1
CIR (%): 0, PIR (%): 100,
WFQ-Mode: WERR, WFQ-Weight: 0
QP 7
Qtype: SP1,
WRP: 1, Name: wrp-1
CIR (%): 0, PIR (%): 100,
WFQ-Mode: WERR, WFQ-Weight: 0
QP 8
Qtype: SP0,
WRP: 1, Name: wrp-1
CIR (%): 0, PIR (%): 100,
WFQ-Mode: WERR, WFQ-Weight: 0

output definitions
QSP The QSet profile (QSP) ID number and name.
#Ports The number of ports to which this profile is attached.
#Queues The number of queues associated with this QSet. Currently there are
eight queues for each QSet.
BW% The bandwidth percentage for the QSet. The bandwidth is shared
between all the queues.
WRP The WRED profile (WRP) ID number associated with the QSet. WRED
is not supported on the OmniSwitch 6860.
Name The WRED profile (WRP) name. WRED is not supported on the
OmniSwitch 6860.
Scheduler The type of scheduler, such as queue specific priority (Qspec) or strict
priority.

page 32-70 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands show qos qsp

output definitions (continued)

Type Whether the QSP is static or dynamic. Currently there are 4 pre-
defined, static profiles (QSP 1–4). User-configured, dynamic profiles
are not supported at this time.
QP 1...8 The queue profile configuration for each QSet queue. The
configuration for each of the individual queue profiles is defined by the
QSP in use. For example, QSP 1 applies a different queue configuration
than QSP 2, 3, or 4.

-> show qos qsp 1 detail

Legends: T (Type): S = Static, D = Dynamic

QSAP QSAP QSAP BW (%) BW (Mbps)

Port Type dQSI ID Name Parent Admin Oper T
-------+----+-----------+--+----------+-----------+------+---------+-
1/1/1 Phy Port 1/1/1 1 qsp-1 Port 1/1/1 100 100 S
1/1/2 Phy Port 1/1/2 1 qsp-1 Port 1/1/2 100 100 S
1/1/3 Phy Port 1/1/3 1 qsp-1 Port 1/1/3 100 100 S
1/1/4 Phy Port 1/1/4 1 qsp-1 Port 1/1/4 100 100 S
1/1/5 Phy Port 1/1/5 1 qsp-1 Port 1/1/5 100 100 S
.
.
.
1/1/52 Phy Port 1/1/52 1 qsp-1 Port 1/1/52 100 100 S
1/1/53 Phy Port 1/1/53 1 qsp-1 Port 1/1/53 100 100 S
1/1/54 Phy Port 1/1/54 1 qsp-1 VFL 1/0 100 100 S
vfl-1/0 Log VFL 1/0 1 qsp-1 VFL 1/0 100 100 S
vfl-1/1 Log VFL 1/1 1 qsp-1 VFL 1/1 100 100 S

-> show qos qsp 1 detail port 1/1/5

Legends: T (Type): S = Static, D = Dynamic

QSAP QSAP QSAP BW (%) BW (Mbps)

Port Type dQSI ID Name Parent Admin Oper T
-------+----+-----------+--+----------+-----------+------+---------+-
1/1/5 Phy Port 1/1/5 1 qsp-1 Port 1/1/5 100 100 S

output definitions
QSAP Port The port number or link aggregate ID for the QSet attachment point
(QSAP). A QSAP is a logical entity generated internally by the switch
to identify the association between a QSet instance and a port or link
aggregate. The QSAP is not configurable at this time.
QSAP Type The type of QSAP port; Phy = physical (chassis/slot/port), Log =
logical (linkagg ID).
dQSI The default QSet instance (dQSI) ID number. This number is generated
internally by the switch to identify the QSI that is automatically
assigned to each port and link aggregate.
ID The QSet profile (QSP) ID number.
Name The QSP name.
QSAP Parent The QSAP parent ID number.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-71
show qos qsp QoS Commands

output definitions (continued)

BW (%) Admin The administrative bandwidth percentage for the QSet. The admin
percentage is not configurable at this time.
BW (Mbps) Oper The operational bandwidth value, which is based on port speed.
Type The QSet profile is a static profile (S).

Release History
Release 8.1.1; command introduced.

Related Commands

qos qsi qsp Changes the QSet profile association for a QSet instance.
show qos qsi Displays the QSet instance configuration.

MIB Objects
alaVfcQsetProfileTable
alaVfcQSPId
alaVfcQSPName
alaVfcQSPBandwidthLimitValue
alaVfcQSPQueueCount
alaVfcQSPWRPId
alaVfcQSPWRPAdminState
alaVfcQSPSchedulingMethod
alaVfcQSPStatsAdmin
alaVfcQSPAttachmentCount

page 32-72 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands show qos qsi

show qos qsi

Displays the QSet instance (QSI) configuration for the switch. A QSI is a logical set of eight virtual output
queues or eight egress queues associated with each port and link aggregate (LAG) ID.
show qos qsi [port chassis/slot/port[-port2] | slot chassis/slot | linkagg agg_id[-agg_id]] [detail]

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis/slot The chassis ID and slot number (3/1) for a specific slot. Displays
information for all ports on the slot.
agg_id[-agg_id] The link aggregate ID. Use a hyphen to specify a range of IDs (10-15).
detail Displays additional queue information for the instance.

Defaults
By default, displays the entire QSI configuration for the switch.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the port chassis/slot/port, slot chassis/slot, and linkagg agg_id parameters to display the QSI
information associated with specific ports or link aggregates.
• Use the detail parameter to display additional profile information, such as the profile configuration
associated with queues and ports.

Examples
-> show qos qsi port 1/1/1
Port 1/1/1
QSAP: Port 1/1/1, Parent: Port 1/1/1
QSI Port 1/1/1
QSP: 1, Name: qsp-1, Admin: Ena, Oper: Dis,
WRP: 1, Name: wrp-1, Admin: Dis, Oper: Dis,
Stats
Admin: Dis, Oper: Dis, Interval: 10
BW
Admin (%): 100, Oper (Mbps): 0

-> show qos qsi port 1/1/1 detail

Port 1/1/1
QSAP: Port 1/1/1, Parent: Port 1/1/1
QSI Port 1/1/1
QSP: 1, Name: qsp-1, Admin: Ena, Oper: Dis,
WRP: 1, Name: wrp-1, Admin: Dis, Oper: Dis,
Stats
Admin: Dis, Oper: Dis, Interval: 10

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-73
show qos qsi QoS Commands

BW
Admin (%): 100, Oper (Mbps): 0
QI 1
Admin: Ena, Oper: Dis, Qtype: SP7,
WRP: 1, Name: wrp-1, Admin: Dis, Oper: Dis,
Stats
Admin: Dis, Oper: Dis
CIR
Admin (%): 0, Oper (Mbps): 0
PIR
Admin (%): 100, Oper (Mbps): 0
QI 2
Admin: Ena, Oper: Dis, Qtype: SP6,
WRP: 1, Name: wrp-1, Admin: Dis, Oper: Dis,
Stats
Admin: Dis, Oper: Dis
CIR
Admin (%): 0, Oper (Mbps): 0
PIR
Admin (%): 100, Oper (Mbps): 0
QI 3
Admin: Ena, Oper: Dis, Qtype: SP5,
WRP: 1, Name: wrp-1, Admin: Dis, Oper: Dis,
Stats
Admin: Dis, Oper: Dis
CIR
Admin (%): 0, Oper (Mbps): 0
PIR
Admin (%): 100, Oper (Mbps): 0
QI 4
Admin: Ena, Oper: Dis, Qtype: SP4,
WRP: 1, Name: wrp-1, Admin: Dis, Oper: Dis,
Stats
Admin: Dis, Oper: Dis
CIR
Admin (%): 0, Oper (Mbps): 0
PIR
Admin (%): 100, Oper (Mbps): 0
QI 5
Admin: Ena, Oper: Dis, Qtype: SP3,
WRP: 1, Name: wrp-1, Admin: Dis, Oper: Dis,
Stats
Admin: Dis, Oper: Dis
CIR
Admin (%): 0, Oper (Mbps): 0
PIR
Admin (%): 100, Oper (Mbps): 0
QI 6
Admin: Ena, Oper: Dis, Qtype: SP2,
WRP: 1, Name: wrp-1, Admin: Dis, Oper: Dis,
Stats
Admin: Dis, Oper: Dis
CIR
Admin (%): 0, Oper (Mbps): 0
PIR
Admin (%): 100, Oper (Mbps): 0
QI 7
Admin: Ena, Oper: Dis, Qtype: SP1,
WRP: 1, Name: wrp-1, Admin: Dis, Oper: Dis,

page 32-74 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands show qos qsi

Stats
Admin: Dis, Oper: Dis
CIR
Admin (%): 0, Oper (Mbps): 0
PIR
Admin (%): 100, Oper (Mbps): 0
QI 8
Admin: Ena, Oper: Dis, Qtype: SP0,
WRP: 1, Name: wrp-1, Admin: Dis, Oper: Dis,
Stats
Admin: Dis, Oper: Dis
CIR
Admin (%): 0, Oper (Mbps): 0
PIR
Admin (%): 100, Oper (Mbps): 0

output definitions
QSAP The QSet attachment point (QSAP) ID number. This is a logical entity
generated internally by the switch to identify the association between a
QSet instance and a port or link aggregate. The QSAP is not
configurable at this time.
Parent The parent QSAP ID. If the parent ID is different than the QSAP ID,
then the port is a member of a link aggregate.
QSI The QSet instance (QSI) ID number, internally generated by the switch.
QSP, Name, Admin, Oper The QSet profile (QSP) ID number and name associated with the QSI.
Also indicates the administrative and operational status of the QSP for
the QSI.
WRP, Name, Admin, Oper The WRED profile (WRP) ID number and name associated with the
QSI. Also indicates the administrative and operational status of the
WRP for the QSI. WRED is not supported on the OmniSwitch 6860.
Stats, Admin, Oper, Interval The QSI administrative status, operational status, and time interval for
statistics collection.
BW Admin (%) The administrative percentage of bandwidth (currently not user-
configurable).
BW Oper (Mbps) The operational amount of bandwidth as determined by the port speed.
For a link aggregate, this value is the sum of the operational bandwidths
for the member ports.
QI 1–8 The queue scheduling and bandwidth configuration for each QSI
queue. These values are determined by which one of the QSet profiles
(QSP 1–4) is associated with the QSI.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-75
show qos qsi QoS Commands

Related Commands

qos qsi qsp Changes the QSet profile association for a QSet instance.
show qos qsi stats Displays packet count statistics collected for a specific QSet instance.

MIB Objects
alaVfcQsetInstanceTable
alaVfcQsetId
alaVfcQsetQsapId
alaVfcQsetAdminState
alaVfcQsetQSPId
alaVfcQsetQSPName
alaVfcQsetWRPId
alaVfcQsetWRPName
alaVfcQsetWRPAdminState
alaVfcQsetWRPOperState
alaVfcQsetSchedulingMethod
alaVfcQsetStatsAdmin
alaVfcQsetStatsOper
alaVfcQInstanceTable
alaVfcQInstanceQId
alaVfcQInstanceWRPAdminState
alaVfcQInstanceWRPOperState
alaVfcQInstanceWRPId
alaVfcQInstanceWRPName
alaVfcQInstanceCIRBandwidthLimitValue
alaVfcQInstancePIRBandwidthLimitValue
alaVfcQInstanceCIROperationalBandwidthLimitValue
alaVfcQInstancePIROperationalBandwidthLimitValue
alaVfcQInstanceStatsAdmin
alaVfcQInstanceStatsOper

page 32-76 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands show qos qsi stats

show qos qsi stats

Displays statistics for the QSet instance (QSI) queues that are associated with the specified port or link
aggregate.
show qos qsi {port chassis/slot/port[-port2] | linkagg agg_id[-agg_id]} [qi qi_id] stats [bytes | rate
[bytes]]

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-15).
qi_id The queue instance (QI) ID number. The valid range is 1–8.
bytes Displays the total number of bytes (instead of packets) that flow through
the QSI queues.
rate Displays the number of packets-per-second that flow through the QSI
queues.

Defaults
By the default, displays the total number of packets that flow through the QSI queues.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The specified port or link aggregate must have statistics collection enabled.

• Use the port chassis/slot/port or linkagg agg_id parameters to display QSI statistics associated with
specific ports or link aggregates.
• Use the qi qi_id parameter to display statistics for a specific queue instance. There are eight queues
associated with a single QSet instance. Each port and link aggregate is associated with one QSet
instance.
• It is possible to combine the bytes parameter with the rate parameter to display the number of bytes-
per-second that flow through the QSI queues. For example, show qos qsi port 1/20 stats rate bytes.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-77
show qos qsi stats QoS Commands

Examples
-> show qos qsi port 1/1/20 stats
Total Total
Port Q Tx Drop
-----------+--+--------------------+--------------------
1/1/20 1 0 0
1/1/20 2 0 0
1/1/20 3 0 0
1/1/20 4 0 0
1/1/20 5 0 0
1/1/20 6 0 0
1/1/20 7 0 0
1/1/20 8 9984 0
-> show qos qsi port 1/1/20 stats bytes
Total Total
Port Q Tx Drop
-----------+--+--------------------+--------------------
1/1/20 1 0 0
1/1/20 2 0 0
1/1/20 3 0 0
1/1/20 4 0 0
1/1/20 5 0 0
1/1/20 6 0 0
1/1/20 7 0 0
1/1/20 8 987424 0
-> show qos qsi port 1/1/20 stats rate
Average Average
Port Q Tx/s Drop/s
-----------+--+--------------------+--------------------
1/1/20 1 0 0
1/1/20 2 0 0
1/1/20 3 0 0
1/1/20 4 0 0
1/1/20 5 0 0
1/1/20 6 0 0
1/1/20 7 0 0
1/1/20 8 7 0
-> show qos qsi port 1/1/20 stats rate bytes
Average Average
Port Q Tx/s Drop/s
-----------+--+--------------------+--------------------
1/1/20 1 0 0
1/1/20 2 0 0
1/1/20 3 0 0
1/1/20 4 0 0
1/1/20 5 0 0
1/1/20 6 0 0
1/1/20 7 0 0
1/1/20 8 694 0

output definitions
Port Configured QoS ports.
Q Number of packets or bytes in queue.
Total Tx Total packets or bytes transmitted.
Total Drop Total packets or bytes dropped.

page 32-78 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands show qos qsi stats

Release History
Release 8.1.1; command introduced.

Related Commands

qos qsi stats Configures the administrative status and interval for statistics collection
for the specified QSet instance.
clear qos qsi stats Clears statistics collected for one or more QSet instances.

MIB Objects
alaVfcQInstanceTable
alaVfcQInstancePacketsEnqueued
alaVfcQInstanceBytesEnqueued
alaVfcQInstancePacketsDropped
alaVfcQInstanceBytesDropped

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-79
clear qos qsi stats QoS Commands

clear qos qsi stats

Clears QSet instance (QSI) statistics.
clear qos qsi {port chassis/slot/port[-port2] | slot chassis/slot | linkagg agg_id[-agg_id]} [qi-id qi_id]
stats

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis/slot The chassis ID and slot number (3/1) for a specific slot. Clears the
statistics for all ports on the slot.
agg_id[-agg_id] The link aggregate ID. Use a hyphen to specify a range of IDs (10-15).
qi-id The queue instance (QI) ID number. The valid range is 1–8.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the port chassis/slot/port, slot chassis/slot, and linkagg agg_id parameters to clear QSI statistics
associated with specific ports or link aggregates.
• Use the qi-id qi_id parameter to clear statistics for a specific queue instance. There are eight queues
associated with a single QSet instance.

Examples
-> clear qos qsi port 1/1/2 qi-id 3 stats
-> clear qos qsi linkagg 10 stats
-> clear qos qsi linkagg 5 qi-id 8 stats
-> clear qos qsi slot 1 stats

Release History
Release 8.1.1; command introduced.

page 32-80 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Commands clear qos qsi stats

Related Commands

show qos qsi stats Displays QSet instance statistics.

MIB Objects
alaVfcQsapTable
alaVfcQsapClearStats
alaVfcQsapQpId

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 32-81
clear qos qsi stats QoS Commands

page 32-82 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 33 QoS Policy Commands

This chapter describes CLI commands used for policy management in the switch. The Quality of Service
(QoS) software in the switch uses policy rules for classifying incoming flows and deciding how to treat
outgoing flows. A policy rule is made up of a policy condition and a policy action. Policy rules may be
created on the switch through CLI or SNMP commands, or they may be created through the PolicyView
GUI application on an attached LDAP server.

Note. Rules created through PolicyView cannot be modified through the CLI; however, you can
create policies in the CLI that take precedence over policies created through PolicyView.

Refer to Chapter 32, “QoS Commands,” for information about commands used to configure QoS software.
MIB information for the QoS policy commands is as follows:
Filename: alcatelIND1Qos.mib
ModuleALCATEL-IND1-QoS-MIB.

Important Note. Some of the commands listed here are not currently supported on one or more
platforms. See command descriptions in this chapter and check release notes for information about
commands that are not supported.

The QoS Policy commands are listed here:

Policy commands policy rule

policy validity-period
policy list
policy list rules
policy condition
policy action
show policy action
show policy condition
show active policy rule
show policy rule
show policy validity period
show active policy list
show policy list
Group commands policy network group
policy service
policy service protocol
policy service group
policy mac group
policy port group
policy map group
show policy network group
show policy mac group
show policy port group
show policy map group
show policy service
show policy service group

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-1
 QoS Policy Commands

Condition commands policy condition

policy condition source ip
policy condition source ipv6
policy condition destination ipv6
policy condition multicast ip
policy condition source network group
policy condition destination network group
policy condition multicast network group
policy condition source ip-port
policy condition destination ip-port
policy condition source tcp-port
policy condition destination tcp-port
policy condition source udp-port
policy condition destination udp-port
policy condition ethertype
policy condition established
policy condition tcpflags
policy condition service
policy condition service group
policy condition icmptype
policy condition icmpcode
policy condition ip-protocol
policy condition ipv6
policy condition nh
policy condition flow-label
policy condition tos
policy condition dscp
policy condition source mac
policy condition destination mac
policy condition source mac group
policy condition destination mac group
policy condition source vlan
policy condition inner source-vlan
policy condition destination vlan
policy condition 802.1p
policy condition inner 802.1p
policy condition source port
policy condition destination port
policy condition source port group
policy condition source port split-group
policy condition destination port group
policy condition vrf
policy condition fragments
policy condition app-mon

page 33-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands

Action commands policy action

policy action disposition
policy action shared
policy action priority
policy action maximum bandwidth
policy action maximum depth
policy action cir
policy action cpu priority
policy action tos
policy action 802.1p
policy action dscp
policy action map
policy action permanent gateway-ip
policy action port-disable
policy action redirect port
policy action redirect linkagg
policy action no-cache
policy action mirror

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-3
 QoS Policy Commands

Types of policies are generally determined by the kind of traffic they classify (policy conditions) and how
the policy is enforced (policy actions). Commands used for particular types of policies are listed here. See
the OmniSwitch AOS Release 8 Network Configuration Guide for more information about creating these
types of policies and information about valid condition/action combinations.

Access Control Lists policy condition

policy action disposition
policy rule
Traffic prioritization/shaping policy action shared
policy action priority
policy action maximum bandwidth
policy rule
802.1p/ToS/DSCP tagging or policy condition tos
mapping policy condition dscp
policy condition 802.1p
policy action tos
policy action 802.1p
policy action dscp
policy action map
policy rule
Network Address Translation policy condition source ip
(NAT) policy condition source ipv6
policy rule
Policy based port mirroring policy action mirror
VLAN Stacking policy condition inner source-vlan
policy condition inner 802.1p

page 33-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy rule

policy rule
Configures a policy rule on the switch. A rule is made up of a condition (for classifying incoming traffic)
and an action (to be applied to outgoing traffic).
policy rule rule_name [enable | disable] [precedence precedence] [condition condition] [action action]
[validity-period name] [save] [log [log-interval seconds]] [count {packets | bytes}] [trap] [default-list]
policy rule rule_name no {validity-period | save | log | trap | default-list}
no policy rule rule_name

Syntax Definitions

rule_name The name of the policy rule, any alphanumeric string.

enable Enables the policy rule.
disable Disables the policy rule.
precedence The precedence value in the range 0–65535. This value determines the
order in which rules are searched for a matching condition. A higher
number indicates higher precedence. Typically the range 30000–65535
is reserved for PolicyView.
condition The condition name that is associated with this rule. Conditions are
configured through the policy condition command.
action The name of the action that is associated with this rule. Actions are
configured through the policy action command.
name The name of a user-defined validity period that is associated with this
rule. Validity periods are configured through the policy validity period
command.
save Marks the policy rule so that it may be captured as part of the switch
configuration.
log Configures the switch to log messages about specific flows coming into
the switch that match this policy rule.
seconds Configures how often to look for packets that match this policy rule
when rule logging is applied (in the range from 0–3600 seconds). A
value of 0 specifies to log as often as possible.
packets Counts the number of packets that match the rule.
bytes Counts the number of bytes that match the rule.
trap Enables or disables traps for the rule.
default-list Adds the rule to the QoS default policy list.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-5
policy rule QoS Policy Commands

Defaults

parameter default
enable | disable enable
precedence 0
log no
seconds 60
packets | bytes packets
trap enable
default-list adds rule to the
default list

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Any rule configured through this command is not active on the switch until the qos apply command is
issued.
• A policy rule configured through the PolicyView application may not be edited in the CLI. You may,
however, create a rule using the CLI with a higher precedence that will override a rule created through
PolicyView.
• Use the no form of the command to remove the rule from the configuration or to remove parameters
from a particular rule. The change will not take effect, however, until the qos apply command is
issued.
• Only one validity period is associated with a policy rule. Each time this command is entered with a
validity period name specified, the existing period name is overwritten with the new one.
• Software and hardware resources are allocated for rules associated with a validity period even if the
validity period is not active. Pre-allocating the resources makes sure the rule can be enforced when the
validity period becomes active.
• The save option marks the policy rule so that the rule will be captured in an ASCII text file (using the
configuration snapshot command), saved to the working directory after the write memory command
or copy running-config working command is entered, or saved after a reboot. Rules are saved by
default. If no save is entered for the rule, the policy rule will not be written to the configuration. The
save option should be disabled only if you want to use a policy rule temporarily.
• The default-list option adds the rule to the default policy list. Rules are added to this list by default
when the rule is created. A rule can belong to multiple policy lists. As a result, the rule remains a
member of the default list even when it is subsequently assigned to additional lists.
• If the rule is going to belong to a QoS policy list for a Universal Network Profile (UNP), use the no
default-list option when creating the rule. Doing so will give the rule precedence over default list rules
when the policy list is applied to UNP device traffic.

page 33-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy rule

• Note that each time a rule is assigned to a policy list, an instance of that rule is created and each
instance is allocated system resources. Use the no default-list option with this command to exclude the
rule from the default policy list.
• If the configuration snapshot command is entered after the policy rule command is configured, the
resulting ASCII file will include the following additional syntax for the policy rule command:
from {cli | ldap | blt}
This syntax indicates how the rule was created. The cli and ldap options may be changed by a user
modifying the ASCII file; however, changing this setting is not recommended. The blt option indi-
cates a built-in rule, this setting is not configurable.
• The log option is useful for determining the source of attacks on the switch firewall.

• If traps are enabled for the rule, a trap is only sent when a port disable action or UserPort shutdown
operation is triggered.

Examples
-> policy rule rule2 condition c2 action a2
-> policy rule rule3 condition c3 action a3 no default-list
-> policy rule rule2 precedence 65535
-> policy rule rule2 validity-period vp01
-> policy rule rule2 no precedence
-> policy rule rule2 no validity-period
-> policy rule rule3 no default-list
-> no policy rule rule2

Release History
Release 8.1.1; command introduced.

Related Commands

policy validity-period Configures a validity period that specifies days, times, and/or months
during which an associated policy rule is in effect.
policy condition Configures condition parameters.
policy action Configures action parameters.
qos apply Applies configured QoS and policy settings to the current configuration.
show policy rule Displays information for policy rules configured on the switch.
show active policy rule Displays only those policy rules that are currently being enforced on the
switch.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-7
policy rule QoS Policy Commands

MIB Objects
alaQoSRuleTable
alaQoSRuleName
alaQoSRuleEnabled
alaQoSRuleSource
alaQoSRulePrecedence
alaQoSRuleCondition
alaQoSRuleAction
alaQoSRuleSave
alaQoSRuleLog
alaQoSRuleCountType
alaQoSRulePacketCount
alaQoSRuleByteCount
alaQosRuleDefaultList
alaQoSAppliedRuleTable
alaQoSAppliedRuleName
alaQoSAppliedRuleEnabled
alaQoSAppliedRuleSource
alaQoSAppliedRulePrecedence
alaQoSAppliedRuleCondition
alaQoSAppliedRuleAction
alaQoSAppliedRuleSave
alaQoSAppliedRuleLog
alaQoSAppliedCountType
alaQoSAppliedPacketCount
alaQoSAppliedByteCount
alaQosAppliedDefaultList

page 33-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy validity-period

policy validity-period
Configures a validity period that specifies the days and times in which a policy rule is in effect.
policy validity-period name [days days] [months months] [hours hh:mm to hh:mm] [interval
mm:dd:yyyy hh:mm to mm:dd:yyyy hh:mm]
policy validity-period name no {hours | interval}
no policy validity-period name

Syntax Definitions

name The name of the validity period (up to 31 alphanumeric characters).

days The day(s) of the week this validity period is active. Enter the actual day
of the week (e.g., monday, tuesday, wednesday, etc.).
months The month(s) in which the validity period is active. Enter the actual
month (e.g., january, february, march, etc.).
hh:mm The time of day, specified in hours and minutes, the validity period
starts and the time of day the validity period ends (e.g., 10:30 to 11:30).
mm:dd:yyyy hh:mm An interval of time in which a rule is in effect. Specify a start and end to
the interval period by entering a beginning date and time followed by an
end date and time (e.g., 11:01:2005 12:01 to 11:02:2005 12:01).

Defaults
By default, no validity period is in effect for a policy rule.

parameter default
days no restriction
months no restriction
hh:mm no specific
time
mm:dd:yyyy hh:mm no interval

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a validity period from the configuration, or to remove
parameters from a particular validity period. Note that at least one parameter must be associated with a
validity period.
• Any combination of days, months, hours, and interval parameters is allowed. The validity period is
only in effect when all specified parameters are true.
• Use the policy rule command to associate a validity period with a rule.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-9
policy validity-period QoS Policy Commands

• Software and hardware resources are allocated for rules associated with a validity period even if the
validity period is not active. Pre-allocating the resources makes sure the rule can be enforced when the
validity period becomes active.
• If the snapshot command is entered after the policy validity-period command is configured, the
resulting ASCII file will include the following additional syntax for the policy validity-period
command:
from {cli | ldap | blt}
This syntax indicates how the service was created. The cli and ldap options may be changed by a user
modifying the ASCII file; however, changing this setting is not recommended. The blt option indicates
a built-in object, this setting is not configurable.

Examples
-> policy validity-period vp01 days tuesday thursday months january february
-> policy validity-period vp01 hours 13:00 to 19:00
-> policy validity-period vp02 interval 01/01/05 12:01 to 02/01/05 11:59
-> policy validity-period vp01 no days thursday
-> no policy-validity period vp02

Release History
Release 8.1.1; command introduced.

Related Commands

policy rule Configures a policy rule on the switch and optionally associates that rule
with a validity period.
show policy validity period Displays information about policy validity periods.

page 33-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy validity-period

MIB Objects
alaQoSValidityPeriodTable
alaQoSValidityPeriodName
alaQoSValidityPeriodSource
alaQoSValidityPeriodDays
alaQoSValidityPeriodDaysStatus
alaQoSValidityPeriodMonths
alaQoSValidityPeriodMonthsStatus
alaQoSValidityPeriodHour
alaQoSValidityPeriodHourStatus
alaQoSValidityPeriodEndHour
alaQoSValidityPeriodInterval
alaQoSValidityPeriodIntervalStatus
alaQoSValidityPeriodEndInterval
alaQoSAppliedValidityPeriodTable
alaQoSAppliedValidityPeriodName
alaQoSAppliedValidityPeriodSource
alaQoSAppliedValidityPeriodDays
alaQoSAppliedValidityPeriodDaysStatus
alaQoSAppliedValidityPeriodMonths
alaQoSAppliedValidityPeriodMonthsStatus
alaQoSAppliedValidityPeriodHour
alaQoSAppliedValidityPeriodHourStatus
alaQoSAppliedValidityPeriodEndHour
alaQoSAppliedValidityPeriodInterval
alaQoSAppliedValidityPeriodIntervalStatus
alaQoSAppliedValidityPeriodEndInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-11
policy list QoS Policy Commands

policy list
Configures a QoS policy list. There are two types of lists available: a Universal Network Profile (UNP)
policy list, and EMP Access Control List (ACL) list, and the default policy list. Rules assigned to a UNP
list are applied to traffic classified into a specific UNP profile. A default policy list is available when the
switch boots up; all policy rules belong to this list unless otherwise specified.
policy list list_name type {unp | empacl | egress} [enable | disable]
no policy list list_name

Syntax Definitions

list_name The name to assign to the policy list. Note that the list name is case
sensitive.
unp Specifies the list type as a Universal Network Profile list.
empacl Specifies the list type as an ACL applied to the EMP port on the switch.
egress Note. This field is not supported in this release.
enable Enables the policy list.
disable Disables the policy list.

Defaults

parameter default
enable | disable enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a policy list from the configuration.

• The default policy list that is available in every switch has no name and is not configurable. All QoS
policy rules are assigned to the default list unless the no default-list option of the policy rule
command is used at the time the rule is created.
• Once a policy list is created, use the policy list rules command to add rules to the list.

• Any policy list configured through this command is not active on the switch until the qos apply
command is issued.
• If the snapshot command is entered after the policy list command is configured, the resulting ASCII
file will include the following additional syntax for the policy list command:
from {cli | ldap | blt}
This syntax indicates how the list was created. The cli and ldap options may be changed by a user
modifying the ASCII file; however, changing this setting is not recommended. The blt option indicates
a built-in object, this setting is not configurable.

page 33-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy list

Examples
-> policy list unp1 type unp
-> policy list unp1 disable
-> policy list unp1 enable
-> no policy list unp1

Release History
Release 8.1.1; command introduced.

Related Commands

policy list rules Assigns QoS policy rules to a QoS policy list.
policy rule Configures a policy rule on the switch and optionally associates that rule
with a validity period.
show policy rule Displays information for policy rules configured on the switch.
show active policy list Displays only those policy lists that are currently being enforced on the
switch.
show policy list Displays information for policy lists configured on the switch.

MIB Objects
alaQoSRuleGroupsTable
alaQoSRuleGroupsName
alaQosRuleGroupsSource
alaQosRuleGroupsType
alaQosRuleGroupsEnabled
alaQosRuleGroupsStatus
alaQosAppliedRuleGroupsTable
alaQosAppliedRuleGroupsName
alaQosAppliedRuleGroupsSource
alaQosAppliedGroupsType
alaQosAppliedGroupsEnabled
alaQosAppliedRuleGroupsStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-13
policy list rules QoS Policy Commands

policy list rules

Assigns existing QoS policy rules to the specified QoS policy list.
policy list list_name rules rule_name [rule_name2...]
policy list list_name no rules rule_name [rule_name2...]

Syntax Definitions

list_name The name of an existing QoS policy list. Note that the list name is case
sensitive.
rule_name The name of an existing QoS policy rule to include in the policy list.
rule_name2 Optional. The name of another QoS policy rule to include in the policy
list. Separate each rule name specified with a space.

Defaults
A default policy list is available when the switch boots up. This list has no name and is not configurable.
All QoS policy rules are assigned to the default list unless the no default-list option of the policy rule
command is used.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a policy rule from an existing list.

• The QoS policy list and rule names specified with this command must already exist in the switch
configuration.
• This command is only used to assign rules to a UNP policy list. Create the rules for this type of list
using the no default-list option of the policy rule command to ensure these rules take precedence over
other default list rules when the UNP policy list is applied to device traffic.
• A rule may belong to a UNP list and the default list at the same time. By default, a rule is assigned to a
default policy list when the rule is created. If the rule is subsequently assigned to another policy list, it
still remains associated with the default list.
• If a rule is a member of multiple policy lists but one or more of these lists are disabled, the rule is still
active in those lists that are enabled.
• If the QoS status of a policy rule is disabled, then the rule is disabled for all lists even if a list to which
the policy rule belongs is enabled.
• Any policy list configured through this command is not active on the switch until the qos apply
command is issued.

page 33-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy list rules

Examples
-> policy list unp1 rules r1 r2 r3
-> policy list unp1 no rules r2

Release History
Release 8.1.1; command introduced.

Related Commands

policy list Configures a QoS policy list.

policy rule Configures a policy rule on the switch and optionally associates that rule
with a validity period.
show policy rule Displays information for policy rules configured on the switch.
show active policy list Displays only those policy lists that are currently being enforced on the
switch.
show policy list Displays information for policy lists configured on the switch.

MIB Objects
alaQoSRuleGroupsTable
alaQoSRuleDefaultList
alaQoSRuleGroupsName
alaQosRuleGroupsSource
alaQosRuleGroupsType
alaQosRuleGroupsEnabled
alaQosRuleGroupsStatus
alaQosAppliedRuleGroupsTable
alaQosAppliedRuleGroupsName
alaQosAppliedRuleGroupsSource
alaQosAppliedGroupsType
alaQosAppliedGroupsEnabled
alaQosAppliedRuleGroupsStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-15
policy network group QoS Policy Commands

policy network group

Configures a network group name and its associated IP addresses. The group may be used as part of a
policy condition. The action associated with any policy using the condition will be applied to all members
of the network group.
policy network group net_group ip_address [mask net_mask] [ip_address2 [mask net_mask2]...]
no policy network group net_group
policy network group net_group no ip_address [mask netmask] [ip_address2 [mask net_mask2]...]

Syntax Definitions

net_group The name of the network group (up to 31 alphanumeric characters).

ip_address An IPv4 address included in the network group. IPv6 addresses are not
supported with network groups.
net_mask The mask for the IPv4 address. If no mask is entered, the IPv4 address is
assumed to be a host address.
ip_address2 Optional. Another IPv4 address to be included in the network group.
Multiple IP addresses may be configured for a network group. Separate
each address/mask combination with a space.
net_mask2 Optional mask for the IPv4 address. If no mask is entered, the natural
mask for the address will be used.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use this command to configure a group of IPv4 addresses to which you want to apply QoS rules.
Rather than create a condition for each IPv4 address, group the addresses together. Use the policy
condition command to associate a condition with the network group.
• Use the no form of the command to remove a network group from the configuration, or to remove an
IP address from a network group.
• If the snapshot command is entered after the policy network group command is configured, the
resulting ASCII file will include the following additional syntax for the policy network group
command:
from {cli | ldap | blt}
This syntax indicates how the network group was created. The cli and ldap options may be changed by
a user modifying the ASCII file; however, changing this setting is not recommended. The blt option
indicates a built-in network group, this setting is not configurable.

page 33-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy network group

Examples
-> policy network group webgroup1 10.10.12.5 10.50.3.1
-> policy network group webgroup1 no 10.10.12.5
-> no policy network group webgroup1

Release History
Release 8.1.1; command introduced.

Related Commands

policy condition Configures a policy condition. A network group may be configured as

part of a policy condition.
qos apply Applies configured QoS and policy settings to the current configuration.
show policy network group Displays information for policy network groups.

MIB Objects
alaQoSNetworkGroupsTable
alaQoSNetworkGroupsName
alaQoSNetworkGroupsSource
alaQoSAppliedNetworkGroupsTable
alaQoSAppliedNetworkGroupsName
alaQoSAppliedNetworkGroupsSource
alaQoSNetworkGroupTable
alaQoSNetworkGroupIpAddr
alaQoSNetworkGroupsIpMask
alaQoSAppliedNetworkGroupTable
alaQoSAppliedNetworkGroupIpAddr
alaQoSAppliedNetworkGroupsIpMask

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-17
policy service group QoS Policy Commands

policy service group

Configures a service group and its associated services. The group may be used as part of a policy
condition. The action associated with any policy using the condition will be applied to all members of the
service group.
policy service group service_group service_name1 [service_name2...]
no policy service group service_group
policy service group service_group no service_name1 [service_name2...]

Syntax Definitions

service_group The name of the service group (up to 31 alphanumeric characters).

service_name1 The service name is configured through the policy service command
and includes information about protocol, source port, and destination
port.
service_name2... Optional. Additional service names may be configured for a service
group. Separate each service name with a space.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use this command to configure a group of services to which you want to apply QoS rules. Rather than
create a condition for each service, group services together. Use the policy condition command to
associate a condition with the service group.
• Use the no form of the command to remove a service group from the configuration, or to remove a
service from a service group.
• To drop packets destined to specific TCP and UDP ports, create port services for the traffic that you
want dropped and add these services to a service group. Then create a condition for this service group
and a source port group, which can then be used in a deny rule. Refer to the OmniSwitch AOS Release
8 Network Configuration Guide for more information about ACL security enhancements.
• If the snapshot command is entered after the policy service group command is configured, the
resulting ASCII file will include the following additional syntax for the policy service group
command:
from {cli | ldap | blt}
This syntax indicates how the service group was created. The cli and ldap options may be changed by a
user modifying the ASCII file; however, changing this setting is not recommended. The blt option indi-
cates a built-in service group, this setting is not configurable.

page 33-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy service group

Examples
-> policy service group servgroup2 telnet ftp
-> policy service group servgroup2 no telnet
-> no policy service group servgroup2

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy service Configures a service that may be used as part of a policy service group.
policy condition Configures a policy condition. A network group may be configured as
part of a policy condition.
show policy service group Displays information for policy service groups.

MIB Objects
alaQoSServiceGroupsTable
alaQoSServiceGroupsName
alaQoSServiceGroupsSource
alaQoSAppliedServiceGroupsTable
alaQoSAppliedServiceGroupsName
alaQoSAppliedServiceGroupsSource
alaQoSServiceGroupTable
alaQoSServiceGroupServiceName
alaQoSAppliedServiceGroupTable
alaQoSAppliedServiceGroupServiceName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-19
policy mac group QoS Policy Commands

policy mac group

Configures a MAC group and its associated MAC addresses. The group may be used as part of a policy
condition. The action associated with any policy using the condition will be applied to all members of the
MAC group.
policy mac group mac_group mac_address [mask mac_mask] [mac_address2 [mask mac_mask2]...]
no policy mac group mac_group
policy mac group mac_group no mac_address [mask mac_mask] [mac_address2 [mask mac_mask2]...]

Syntax Definitions

mac_group The name of the MAC group (up to 31 alphanumeric characters).

mac_address The MAC address associated with the group (for example,
00:20:da:05:f6:23).
mac_mask The mask of the MAC address, used to identify which bytes in the MAC
address are significant when comparing the MAC address in the
received frame with the MAC address in the policy condition. If no
mask is specified, the switch automatically uses ff:ff:ff:ff:ff:ff.
mac_address2 Optional. Additional MAC addresses may be configured for a MAC
group. Separate each address with a space.
mac_mask2 The mask of an additional MAC address, used to identify which bytes in
the MAC address are significant when comparing the MAC address in
the received frame with the MAC address in the policy condition. If no
mask is specified, the switch automatically uses ff:ff:ff:ff:ff:ff.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use this command to configure a group of source or destination MAC addresses to which you want to
apply QoS rules. Rather than create a condition for each MAC address, group MAC addresses together.
Use the policy condition command to associate a condition with the MAC group.
• Use the no form of the command to remove a MAC group from the configuration, or to remove a MAC
address from a MAC group.
• The MAC group name “alaPhones” is a reserved group name used to identify the MAC addresses of IP
phones. See the qos phones command for more information.
• If the snapshot command is entered after the policy map group command is configured, the resulting
ASCII file will include the following additional syntax for the policy map group command:
from {cli | ldap | blt}

page 33-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy mac group

This syntax indicates how the map group was created. The cli and ldap options may be changed by a
user modifying the ASCII file; however, changing this setting is not recommended. The blt option
indicates a built-in object, this setting is not configurable.

Examples
-> policy mac group mac_group1 00:20:da:05:f6:23 00:20:da:05:f6:24
-> no policy mac group mac_group1

Release History
Release 8.1.1; command introduced.

Related Commands

policy condition Configures a policy condition. A MAC group may be configured as part
of a policy condition.
qos apply Applies configured QoS and policy settings to the current configuration.
show policy mac group Displays information about policy MAC groups.

MIB Objects
alaQoSMACGroupsTable
alaQoSMACGroupsName
alaQoSMACGroupsSource
alaQoSAppliedMACGroupsTable
alaQoSAppliedMACGroupsName
alaQoSAppliedMACGroupsSource
alaQoSMACGroupTable
alaQoSMACGroupMacAddr
alaQoSMACGroupMacMask
alaQoSAppliedMACGroupTable
alaQoSAppliedMACGroupMacAddr
alaQoSAppliedMACGroupMacMask

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-21
policy port group QoS Policy Commands

policy port group

Configures a port group and its associated slot and port numbers. A port group may be attached to a policy
condition. The action associated with that policy will be applied to all members of the port group.
policy port group group_name chassis/slot/port[-port] [chassis/slot/port[-port]...]
no policy port group group_name
policy port group group_name no chassis/slot/port[-port] [chassis/slot/port[-port]...]

Syntax Definitions

group_name The name of the port group (up to 31 alphanumeric characters).

chassis/slot/port[-port] The chassis ID, slot, and port (or port range) of the ports to be included
in the group. At least one chassis/slot/port combination must be
specified. Additional combinations may be included in the group; each
combination should be separated by a space.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use this command to configure a group of ports to which you want to apply QoS rules. Rather than
create a condition for each port, group ports together. Use the policy condition command to associate a
condition with the port group.
• Use the no form of the command to remove a port group from the configuration, or to remove a slot/
port from a port group.
• If a range of ports is specified using the syntax slot/port-port (i.e., 2/1-8), a single port within that
range cannot be removed on its own. The entire range must be deleted as it was entered.
• When a port group is used as part of a policy rule and a policy action specifies a maximum bandwidth,
each interface in the port group will be allowed the maximum bandwidth.
• To prevent IP source address spoofing, add ports to the port group called UserPorts. This port group
does not need to be used in a condition or rule to be effected on flows and only applies to routed traffic.
Ports added to the UserPorts group will block spoofed traffic while still allowing normal traffic on the
port. Refer to the OmniSwitch AOS Release 8 Network Configuration Guide for more information
about ACL security enhancements.
• Use the qos user-port command to configure the option to filter or administratively disable a port
when a specific type of traffic (Spoof, RIP, BPDU, OSPF, and/or BGP) is received on a port that is a
member of the pre-defined UserPorts group.

page 33-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy port group

• If the snapshot command is entered after the policy port group command is configured, the resulting
ASCII file will include the following additional syntax for the policy port group command:
from {cli | ldap | blt}
This syntax indicates how the port group was created. The cli and ldap options may be changed by a
user modifying the ASCII file; however, changing this setting is not recommended. The blt option
indicates a built-in object, this setting is not configurable.

Examples
-> policy port group port_group4 3/1/1-2 4/1/3 5/1/4
-> policy port group port_group4 no 3/1/1-2
-> policy port group UserPorts 4/1/1-8 5/1/1-8

Release History
Release 8.1.1; command introduced.

Related Commands

policy condition Configures a policy condition. A port group may be configured as part
of a policy condition.
qos apply Applies configured QoS and policy settings to the current configuration.
policy action maximum Configures a maximum bandwidth value for a policy action.
bandwidth
show policy port group Displays information about policy port groups.

MIB Objects
alaQoSPortGroupsTable
alaQoSPortGroupsName
alaQoSPortGroupsSource
alaQoSAppliedPortGroupsTable
alaQoSAppliedPortGroupsName
alaQoSAppliedPortGroupsSource
alaPortGroupTable
alaQoSPortGroupSlot
alaQoSPortGroupPort
alaQoSPortGroupPortEnd
alaAppliedPortGroupTable
alaQoSAppliedPortGroupSlot
alaQoSAppliedPortGroupPort
alaQoSAppliedPortGroupPortEnd

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-23
policy map group QoS Policy Commands

policy map group

Configures a map group and its associated mappings for 802.1p, Type of Service (ToS), or Differentiated
Services Code Point (DSCP) values. A map group may be referenced in a policy action with the map
keyword.
policy map group map_group {value1:value2...}
no policy map group map_group
policy map group no {value1:value2...}

Syntax Definitions

map_group The name of the map group (up to 31 alphanumeric characters).

value1 The 802.1p, ToS, or DSCP value to be mapped to another value. May be
a value or a range of values (for example, 1-2).
value2... The 802.1p, ToS, or DSCP value to be used in place of value1.
Additional mapping pairs may be included.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a mapping pair or to remove the map group entirely.

• The map group may contain more than one mapping pair.

• If the snapshot command is entered after the policy map group command is configured, the resulting
ASCII file will include the following additional syntax for the policy map group command:
from {cli | ldap | blt}
This syntax indicates how the map group was created. The cli and ldap options may be changed by a
user modifying the ASCII file; however, changing this setting is not recommended. The blt option indi-
cates a built-in object, this setting is not configurable.

Examples
-> policy map group tosGroup 1-4:3 5-6:5 7:6
-> policy map group tosGroup no 7:6
-> no policy map group tosGroup

Release History
Release 8.1.1; command introduced.

page 33-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy map group

Related Commands

policy action map Configures a mapping group for a policy action.

MIB Objects
alaQoSMapGroupsTable
alaQoSMapGroupsName
alaQoSMapGroupsSource
alaQoSAppliedMapGroupsTable
alaQoSAppliedMapGroupsName
alaQoSAppliedMapGroupsSource
alaQoSMapGroupTable
alaQoSMapGroupKey
alaQoSMapGroupKeyEnd
alaQoSMapGroupValue
alaQoSAppliedMapGroupTable
alaQoSAppliedMapGroupKey
alaQoSAppliedMapGroupKeyEnd
alaQoSAppliedMapGroupValue

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-25
policy service QoS Policy Commands

policy service
Configures a service that may be used as part of a policy service group or included as part of a policy
condition. A service is a source and/or destination TCP or UDP port or port range.
This overview section describes the base command. At least one option must be configured with the base
command. Some options may be used in combination; some options are shortcuts for keyword
combinations (see the Usage Guidelines). Options are described as separate commands. See the command
descriptions and usage guidelines for valid combinations.
Use the no form for keywords to remove a parameter from a service.
policy service service_name
[protocol protocol]
[source ip port port[-port]]
[destination ip port port[-port]]
[source tcp port port[-port]]
[destination tcp port port[-port]]
[source udp port port[-port]]
[destination udp port port[-port]]
no policy service service_name

Syntax Definitions

service_name The name of the service (up to 31 alphanumeric characters).

protocol The protocol associated with the service. The range of values is 0–255.
Currently a value of 6 (for TCP) or 17 (for UDP) is supported. This
value must be specified for source ip port or destination ip port; it
cannot be specified for source tcp port, destination tcp port, source
udp port, or destination udp port.
port The well-known port number (or port range) for the desired service. For
example, the port number for Telnet is 23. Specify a range of ports using
a hyphen (for example, 22-23).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a service from the configuration, or to remove parameters
from a particular service. Note that at least one parameter must be associated with a service.

page 33-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy service

• The command options offer alternate ways of configuring TCP or UDP ports for a service. Note that
port types (TCP or UDP) cannot be mixed in the same service. The following table shows how the
keywords are used:

To configure: Use keywords: Notes

TCP or UDP ports for a service protocol The protocol must be specified with
source ip port at least one source or destination
destination ip port port.
TCP ports for a service source tcp port Keywords may be used in
destination tcp port combination.
UDP ports for a service source udp port Keywords may be used in
destination udp port combination.

• If the snapshot command is entered after the policy service command is configured, the resulting
ASCII file will include the following additional syntax for the policy service command:
from {cli | ldap | blt}
This syntax indicates how the service was created. The cli and ldap options may be changed by a user
modifying the ASCII file; however, changing this setting is not recommended. The blt option indi-
cates a built-in object, this setting is not configurable.

Examples
The following two commands show two different ways of configuring the same service:
-> policy service telnet2 protocol 6 destination ip port 23
-> policy service telnet3 destination tcp port 23

Release History
Release 8.1.1; command introduced.

Related Commands

policy map group Configures a policy service group, which is made up of policy services.
policy condition Creates a policy condition.
qos apply Applies configured QoS and policy settings to the current configuration.
show policy service Displays information about policy services configured on the switch.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-27
policy service QoS Policy Commands

MIB Objects
alaQoSServiceTable
alaQoSServiceName
alaQoSServiceSource
alaQoSServiceIpProtocol
alaQoSServiceSourceIpPort
alaQoSServiceSourceIpPortEnd
alaQoSServiceDestinationIpPort
alaQoSServiceDestinationIpPortEnd
alaQoSServiceSourceTcpPort
alaQoSServiceSourceTcpPortEnd
alaQoSServiceDestinationTcpPort
alaQoSServiceDestinationTcpPortEnd
alaQoSServiceSourceUdpPort
alaQoSServiceSourceUdpPortEnd
alaQoSServiceDestinationUdpPort
alaQoSServiceDestinationUdpPortEnd
alaQoSAppliedServiceTable
alaQoSAppliedServiceName
alaQoSAppliedServiceSource
alaQoSAppliedServiceIpProtocol
alaQoSAppliedSourceIpPort
alaQoSAppliedSourceIpPortEnd
alaQoSAppliedServiceDestinationIpPort
alaQoSAppliedServiceDestinationIpPortEnd
alaQoSAppliedSourceTcpPort
alaQoSAppliedSourceTcpPortEnd
alaQoSAppliedServiceDestinationTcpPort
alaQoSAppliedServiceDestinationTcpPortEnd
alaQoSAppliedSourceUdpPort
alaQoSAppliedSourceUdpPortEnd
alaQoSAppliedServiceDestinationUdpPort
alaQoSAppliedServiceDestinationUdpPortEnd

page 33-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy service protocol

policy service protocol

Configures a service with a protocol and IP port or port range that may be used as part of a policy service
group or included as part of a policy condition.
policy service service_name protocol protocol {[source ip-port port[-port]] [destination ip-port port[-
port]]}
no policy service service_name
policy service service_name no {source ip-port | destination ip-port}

Syntax Definitions

service_name The name of the service (up to 31 alphanumeric characters).

protocol The protocol associated with the service. The range of values is 0–255.
Currently a value of 6 (for TCP) or 17 (for UDP) is supported.
port The well-known port number (or port range) for the desired service. For
example, the port number for Telnet is 23. A port range should be
separated by a hyphen (for example, 22-23).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a service from the configuration or to remove parameters
from a particular service. (A protocol value cannot be removed from a service.)
• Shortcut commands for the policy service protocol command include the following: policy service
source tcp-port, policy service destination tcp-port, policy service source udp-port, and policy
service destination udp-port.
• If the snapshot command is entered after the policy service command is configured, the resulting
ASCII file will include the following additional syntax for the policy service command:
from {cli | ldap | blt}
This syntax indicates how the service was created. The cli and ldap options may be changed by a user
modifying the ASCII file; however, changing this setting is not recommended. The blt option indi-
cates a built-in object, this setting is not configurable.

Examples
-> policy service telnet2 protocol 6 destination ip-port 23 source ip-port 22
-> policy service telnet2 no source ip-port

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-29
policy service protocol QoS Policy Commands

Release History
Release 8.1.1; command introduced.

Related Commands

policy service group Configures a policy service group, which is made up of policy services.
policy condition Creates a policy condition.
qos apply Applies configured QoS and policy settings to the current configuration.
show policy service Displays information about policy services configured on the switch.

MIB Objects
alaQoSServiceTable
alaQoSServiceName
alaQoSServiceSource
alaQoSServiceIpProtocol
alaQoSServiceSourceIpPort
alaQoSServiceSourceIpPortEnd
alaQoSServiceDestinationIpPort
alaQoSServiceDestinationIpPortEnd
alaQoSAppliedServiceTable
alaQoSAppliedServiceName
alaQoSAppliedServiceSource
alaQoSAppliedServiceIpProtocol
alaQoSAppliedSourceIpPort
alaQoSAppliedSourceIpPortEnd
alaQoSAppliedServiceDestinationIpPort
alaQoSAppliedServiceDestinationIpPortEnd

page 33-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy service source tcp-port

policy service source tcp-port

Configures a service with a source TCP port or port range that may be used as part of a policy service
group or included as part of a policy condition.
policy service service_name source tcp-port port[-port]
no policy service service_name
policy service service_name no source tcp port

Syntax Definitions

service_name The name of the service (up to 31 alphanumeric characters).

port The well-known port number (or port range) for the desired TCP
service. For example, the port number for Telnet is 23. A port range
should be separated by a hyphen (for example, 22-23).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is a shortcut for the policy service protocol command.

• Use the no form of the command to remove a service from the configuration, or to remove parameters
from a particular service. Note that at least one parameter must be associated with a service.
• Ports associated with a particular service must all be of the same type. (The destination tcp port
keyword may be used with this command; other keywords for the command are not allowed.)
• If the snapshot command is entered after the policy service command is configured, the resulting
ASCII file will include the following additional syntax for the policy service command:
from {cli | ldap | blt}
This syntax indicates how the service was created. The cli and ldap options may be changed by a user
modifying the ASCII file; however, changing this setting is not recommended. The blt option indi-
cates a built-in object, this setting is not configurable.

Examples
-> policy service serv_5 source tcp port 21-22
-> policy service serv_5 no source tcp port

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-31
policy service source tcp-port QoS Policy Commands

Related Commands

policy service group Configures a policy service group, which is made up of policy services.
policy condition Creates a policy condition.
qos apply Applies configured QoS and policy settings to the current configuration.
show policy service Displays information about policy services configured on the switch.

MIB Objects
alaQoSServiceTable
alaQoSServiceName
alaQoSServiceSource
alaQoSServiceSourceTcpPort
alaQoSServiceSourceTcpPortEnd
alaQoSAppliedServiceTable
alaQoSAppliedServiceName
alaQoSAppliedServiceSource
alaQoSAppliedSourceTcpPort
alaQoSAppliedSourceTcpPortEnd

page 33-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy service destination tcp-port

policy service destination tcp-port

Configures a service with a destination TCP port or port range that may be used as part of a policy service
group or included as part of a policy condition.
policy service service_name destination tcp-port port[-port]
no policy service service_name
policy service service_name no destination tcp-port

Syntax Definitions

service_name The name of the service (up to 31 alphanumeric characters).

port The well-known port number (or port range) for the desired TCP
service. For example, the port number for Telnet is 23. A port range
should be separated by a hyphen (for example, 22-23).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a service from the configuration, or to remove parameters
from a particular service.
• This command is a shortcut for the policy service protocol command.

• A policy service may be grouped in a policy group using the policy service group command. A policy
condition may then be associated with the service group.
• If the snapshot command is entered after the policy service command is configured, the resulting
ASCII file will include the following additional syntax for the policy service command:
from {cli | ldap | blt}
This syntax indicates how the service was created. The cli and ldap options may be changed by a user
modifying the ASCII file; however, changing this setting is not recommended. The blt option indi-
cates a built-in object, this setting is not configurable.

Examples
-> policy service service4 destination tcp-port 23
-> policy service service4 no destination tcp-port

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-33
policy service destination tcp-port QoS Policy Commands

Related Commands

policy service group Configures a policy service group, which is made up of policy services.
policy condition Creates a policy condition.
qos apply Applies configured QoS and policy settings to the current configuration.
show policy service Displays information about policy services configured on the switch.

MIB Objects
alaQoSServiceTable
alaQoSServiceName
alaQoSServiceSource
alaQoSServiceDestinationTcpPort
alaQoSServiceDestinationTcpPortEnd
alaQoSAppliedServiceTable
alaQoSAppliedServiceName
alaQoSAppliedServiceSource
alaQoSAppliedServiceDestinationTcpPort
alaQoSAppliedServiceDestinationTcpPortEnd

page 33-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy service source udp-port

policy service source udp-port

Configures a service with a source UDP port or port range that may be used as part of a policy service
group or included as part of a policy condition.
policy service service_name source udp-port port[-port]
no policy service service_name
policy service service_name no source udp-port

Syntax Definitions

service_name The name of the service (up to 31 alphanumeric characters).

port The well-known port number (or port range) for the desired UDP
service. Specify a port range with a hyphen (for example, 22-23).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is a shortcut for the policy service protocol command.

• Use the no form of the command to remove a service from the configuration, or to remove parameters
from a particular service. Note that at least one parameter must be associated with a service.
• Ports associated with a particular service must all be of the same type. (The destination tcp port
keyword may be used with this command; other keywords for the command are not allowed.)
• If the snapshot command is entered after the policy service command is configured, the resulting
ASCII file will include the following additional syntax for the policy service command:
from {cli | ldap | blt}
This syntax indicates how the service was created. The cli and ldap options may be changed by a user
modifying the ASCII file; however, changing this setting is not recommended. The blt option indi-
cates a built-in object, this setting is not configurable.

Examples
-> policy service serv_a source udp-port 1000
-> no policy service serv_a source udp-port

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-35
policy service source udp-port QoS Policy Commands

Related Commands

policy service group Configures a policy service group, which is made up of policy services.
policy condition Creates a policy condition.
qos apply Applies configured QoS and policy settings to the current configuration.
show policy service Displays information about policy services configured on the switch.

MIB Objects
alaQoSServiceTable
alaQoSServiceName
alaQoSServiceSource
alaQoSServiceSourceUdpPort
alaQoSServiceSourceUdpPortEnd
alaQoSAppliedServiceTable
alaQoSAppliedServiceName
alaQoSAppliedServiceSource
alaQoSAppliedSourceUdpPort
alaQoSAppliedSourceUdpPortEnd

page 33-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy service destination udp-port

policy service destination udp-port

Configures a service with a destination UDP port or port range that may be used as part of a policy service
group or included as part of a policy condition.
policy service service_name destination udp-port port[-port]
no policy service service_name
policy service service_name no destination udp-port

Syntax Definitions

service_name The name of the service (up to 31 alphanumeric characters).

port The well-known port number (or port range) for the desired UDP
service. For example, a port number for NETBIOS is 137. A port range
should be separated by a hyphen (for example, 137-138).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is a shortcut for the policy service protocol command.

• A policy service may be grouped in a policy group using the policy service group command. A policy
condition may then be associated with the service group.
• Use the no form of the command to remove a service from the configuration, or to remove parameters
from a particular service.
• If the snapshot command is entered after the policy service command is configured, the resulting
ASCII file will include the following additional syntax for the policy service command:
from {cli | ldap | blt}
This syntax indicates how the service was created. The cli and ldap options may be changed by a user
modifying the ASCII file; however, changing this setting is not recommended. The blt option indi-
cates a built-in object, this setting is not configurable.

Examples
-> policy service service4 destination udp-port 137
-> policy service service4 no destination udp-port

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-37
policy service destination udp-port QoS Policy Commands

Related Commands

policy service group Configures a policy service group, which is made up of policy services.
policy condition Creates a policy condition.
qos apply Applies configured QoS and policy settings to the current configuration.
show policy service Displays information about policy services configured on the switch.

MIB Objects
alaQoSServiceTable
alaQoSServiceName
alaQoSServiceSource
alaQoSServiceDestinationUdpPort
alaQoSServiceDestinationUdpPortEnd
alaQoSAppliedServiceTable
alaQoSAppliedServiceName
alaQoSAppliedServiceSource
alaQoSAppliedServiceDestinationUdpPort
alaQoSAppliedServiceDestinationUdpPortEnd

page 33-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition

policy condition
Creates a QoS policy condition. The condition determines what parameters the switch uses to classify
incoming flows. Condition parameters may be configured when the condition is created; or parameters
may be configured for an existing condition. At least one parameter must be configured for a condition.
This section describes the base command. Optional keywords are listed below and described as separate
commands later in this chapter. (Options may be used in combination but are described separately for ease
in explanation.) Use the no form for keywords to remove a parameter from the condition.
Some condition parameters may not be supported depending on the platform you are using. Also some
condition parameters may not be supported with some action parameters. See the condition/action tables
in the OmniSwitch AOS Release 8 Network Configuration Guide.
policy condition condition_name
[source ip ip_address [mask netmask]]
[source ipv6 {any | ipv6_address [mask netmask]}
[destination ip ip_address [mask netmask]]
[destination ipv6 {any | ipv6_address [mask netmask]}
[multicast ip ip_address [mask netmask]]
[source network group network_group]
[destination network group network_group]
[multicast network group multicast_group]
[source ip port port[-port]]
[destination ip port port[-port]]
[source tcp port port[-port]]
[destination tcp port port[-port]]
[source udp port port[-port]]
[destination udp port port[-port]]
[ethertype etype]
[established]
[tcpflags {any | all} flag [mask flag]
[service service]
[service group service_group]
[icmptype type]
[icmpcode code]
[ip protocol protocol]
[ipv6]
[nh next_header_value]
[flow-label flow_label_value]
[tos tos_value tos_mask]
[dscp {dscp_value[-value} [dscp_mask]]
[source mac mac_address [mask mac_mask]]
[destination mac mac_address [mask mac_mask]]
[source mac group group_name]
[destination mac group mac_group]
[source vlan vlan_id]
[destination vlan vlan_id]
[802.1p 802.1p_value]
[source port chassis/slot/port[-port]]

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-39
policy condition QoS Policy Commands

[source port group group_name]

[source port split-group group_name]
[destination port chassis/slot/port[-port]]
[destination port group group_name]
[vrf {vrf_name | default}]
[fragments]
{app-mon-application-group app_group_name | app-mon-application-name app_name}
no policy condition condition_name

Syntax Definitions

condition_name The name of the condition. Any alphanumeric string.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• A policy condition and a policy action are combined to make a policy rule. See the policy rule
command on page 44-6.
• Use the qos apply command to activate configuration changes.

• If multiple keywords are defined for a single condition, the traffic flow must match all of the
parameters in the condition before the rule is enforced.
• Use the no form of the command to remove a condition from a policy rule.

• At least one parameter must be associated with a condition.

• If the snapshot command is entered after the policy condition command is configured, the resulting
ASCII file will include the following additional syntax for the policy condition command:
from {cli | ldap | blt}
This syntax indicates how the condition was created. The cli and ldap options may be changed by a
user modifying the ASCII file; however, changing this setting is not recommended. The blt option indi-
cates a built-in condition, this option is not configurable.

Examples
-> policy condition cond4 source port 3/1

Release History
Release 8.1.1; command introduced.

page 33-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy action Configures a policy action.
policy rule Configures a policy rule on the switch. A rule is made up of a condition
(for classifying incoming traffic) and an action (to be applied to
outgoing traffic).
show policy condition Displays information about policy conditions configured on the switch.
show policy rule Displays information about pending and applied policy rules.

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionSource
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionSource

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-41
policy condition source ip QoS Policy Commands

policy condition source ip

Configures a source IP address for a policy condition.
policy condition condition_name source ip ip_address [mask netmask]
policy condition condition_name no source ip

Syntax Definitions

condition_name The name of the condition.

ip_address The source IP address of the Layer 3 flow.
netmask The mask for the source IP address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If a mask is not specified, the IP address is assumed to be a host address.

• A source IP address and a source IP network group cannot be specified in the same condition.

• Use the no form of the command to remove a source IP address from a condition; however, at least one
classification parameter must be associated with a condition.

Examples
-> policy condition cond3 source ip 173.201.18.3

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
show policy condition Shows information about a particular policy condition configured on the
switch.

page 33-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition source ip

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionSourceIpAddr
alaQoSConditionSourceIpMask
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionSourceIpAddr
alaQoSAppliedConditionSourceIpMask

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-43
policy condition source ipv6 QoS Policy Commands

policy condition source ipv6

Configures a source IPv6 address for a policy condition.
policy condition condition_name source ipv6 {any | ipv6_address [mask netmask]}
policy condition condition_name no source ipv6

Syntax Definitions

condition_name The name of the condition.

any Any source IPv6 address.
ipv6_address A specific source IPv6 address.
netmask The mask for the source IPv6 address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a source IPv6 address from a condition; however, at least
one classification parameter must be associated with a condition.
• If a mask is not specified, the IPv6 address is assumed to be a host address.

Examples
-> policy condition cond3 source ipv6 ::1234:531F:BCD2:F34A

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
show policy condition Shows information about a particular policy condition configured on the
switch.

page 33-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition source ipv6

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionSourceIpv6Addr
alaQoSConditionSourceIpv6AddrStatus
alaQoSConditionSourceIpv6Mask
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionSourceIpv6Addr
alaQoSAppliedConditionSourceIpv6AddrStatus
alaQoSAppliedConditionSourceIpMask

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-45
policy condition destination ip QoS Policy Commands

policy condition destination ip

Configures a destination IP address for a policy condition.
policy condition condition_name destination ip ip_address [mask netmask]
policy condition condition_name no destination ip

Syntax Definitions

condition_name The name of the condition.

ip_address The destination IP address of the Layer 3 flow.
netmask The mask for the destination IP address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If a mask is not specified, the IP address is assumed to be a host address.

• A destination IP address and a destination IP network group cannot be specified in the same condition.

• Use the no form of the command to remove a destination IP address from a condition; however, at least
one classification parameter must be associated with a condition.

Examples
-> policy condition cond4 destination ip 208.192.21.0 mask 255.255.255.0

Release History
Release 8.1.1; command introduced.

Related Commands

policy condition Creates a policy condition.

qos apply Applies configured QoS and policy settings to the current configuration.
show policy condition Shows information about a particular policy condition configured on the
switch.

page 33-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition destination ip

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionDestinationIpAddr
alaQoSConditionDestinationIpMask
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionDestinationIpAddr
alaQoSAppliedConditionDestinationIpMask

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-47
policy condition destination ipv6 QoS Policy Commands

policy condition destination ipv6

Configures a destination IPv6 address for a policy condition.
policy condition condition_name destination ipv6 {any | ipv6_address [mask netmask]}
policy condition condition_name no destination ipv6

Syntax Definitions

condition_name The name of the condition.

any Any destination IPv6 address.
ipv6_address A specific destination IPv6 address.
netmask The mask for the source IPv6 address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a destination IPv6 address from a condition; however, at
least one classification parameter must be associated with a condition.
• If a mask is not specified, the IPv6 address is assumed to be a host address.

Examples
-> policy condition cond3 destination ipv6 ::1234:531F:BCD2:F34A

Release History
Release 8.1.1; command introduced.

Related Commands

policy condition Applies configured QoS and policy settings to the current configuration.
qos apply Creates a policy condition.
show policy condition Shows information about a particular policy condition configured on the
switch.

page 33-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition destination ipv6

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionDestinationIpv6Addr
alaQoSConditionDestinationIpv6AddrStatus
alaQoSConditionDestinationIpv6Mask
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionDestinationIpv6Addr
alaQoSAppliedConditionDestinationIpv6AddrStatus
alaQoSAppliedConditionDestinationIpMask

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-49
policy condition multicast ip QoS Policy Commands

policy condition multicast ip

Configures a multicast IP address for a policy condition.
policy condition condition_name multicast ip ip_address [mask netmask]
policy condition condition_name no multicast ip

Syntax Definitions

condition_name The name of the condition.

ip_address The multicast IP address.
netmask Optional. The mask for the multicast IP address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If a mask is not specified, the IP address is assumed to be a host address.

• A multicast IP address and a multicast network group cannot be specified in the same condition.

• Use the no form of the command to remove a multicast IP address from a condition; however, at least
one classification parameter must be associated with a condition.

Examples
-> policy condition cond4 multicast ip 224.1.1.1

Release History
Release 8.1.1; command introduced.

Related Commands

policy condition Creates a policy condition.

qos apply Applies configured QoS and policy settings to the current configuration.

page 33-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition multicast ip

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSMulticastIpAddr
alaQoSMulticastIpMask
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedMulticastIpAddr
alaQoSAppliedMulticastIpMask

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-51
policy condition source network group QoS Policy Commands

policy condition source network group

Associates a source network group with a policy condition.
policy condition condition_name source network group network_group
policy condition condition_name no source network group

Syntax Definitions

condition_name The name of the condition.

network_group The name of the source network group. Network groups are configured
through the policy network group command.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a source network group from a condition; however, at least
one classification parameter must be associated with a condition.
• A source IP address and a source IP network group cannot be specified in the same condition.

Examples
-> policy condition cond5 source network group webgroup1

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
policy network group Configures a network group name and its associated IP addresses.
show policy condition Shows information about policy conditions configured on the switch.
show policy network group Displays information about policy network groups.

page 33-52 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition source network group

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionSourceNetworkGroup
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionSourceNetworkGroup

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-53
policy condition destination network group QoS Policy Commands

policy condition destination network group

Associates a destination network group with a policy condition.
policy condition condition_name destination network group network_group
policy condition condition_name no destination network group

Syntax Definitions

condition_name The name of the condition.

network_group The name of the destination network group. Network groups are
configured through the policy network group command.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a destination network group from a condition; however, at
least one classification parameter must be associated with a condition.
• A destination IP address and a destination IP network group cannot be specified in the same condition.

Examples
-> policy condition cond6 destination network group webgroup1

Release History
Release 8.1.1; command introduced.

Related Commands

policy condition Creates a policy condition.

policy network group Configures a network group name and its associated IP addresses.
qos apply Applies configured QoS and policy settings to the current configuration.
show policy condition Shows information about policy conditions configured on the switch.
show policy network group Displays information about policy network groups.

page 33-54 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition destination network group

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionDestinationNetworkGroup
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionDestinationNetworkGroup

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-55
policy condition multicast network group QoS Policy Commands

policy condition multicast network group

Associates a multicast group with a policy condition.
policy condition condition_name multicast network group multicast_group
policy condition condition_name no multicast network group

Syntax Definitions

condition_name The name of the condition.

multicast_group The multicast group name. Multicast groups are configured through the
policy network group command.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a multicast group from a condition; however, at least one
classification parameter must be associated with a condition.
• A multicast address and a multicast network group cannot be specified in the same condition.

Examples
-> policy condition cond3 multicast group video2

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
policy network group Configures a network group name and its associated IP addresses.
show policy condition Shows information about policy conditions configured on the switch.
show policy network group Displays information about policy network groups.

page 33-56 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition multicast network group

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionMulticastNetworkGroup
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionMulticastNetworkGroup

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-57
policy condition source ip-port QoS Policy Commands

policy condition source ip-port

Configures a source IP port number for a policy condition.
policy condition condition_name source ip-port port[-port]
policy condition condition_name no source ip-port

Syntax Definitions

condition_name The name of the condition.

port The TCP or UDP port number of the source address of the Layer 3 flow,
in the range from 0–65535. A range of ports (separated by a hyphen)
may be specified instead of a single port.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a source IP port from a condition; however, at least one
classification parameter must be associated with a condition.
• The protocol (TCP or UDP) must be specified in the condition, either on the same command line or in
a previous command. Use the ip protocol keywords. See the policy condition ip-protocol command.
• The same condition cannot specify a source IP port with a source TCP port, source UDP port, service,
or service group.

Examples
-> policy condition cond1 ip protocol 6 source ip-port 137

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition ip-protocol Configures an IP protocol for a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

page 33-58 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition source ip-port

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionSourceIpPort
alaQoSConditionSourceIpPortEnd
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionSourceIpPort
alaQoSAppliedConditionSourceIpPortEnd

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-59
policy condition destination ip-port QoS Policy Commands

policy condition destination ip-port

Configures a destination IP port number for a policy condition.
policy condition condition_name destination ip-port port[-port]
policy condition condition_name no destination ip-port

Syntax Definitions

condition_name The name of the condition.

port The TCP or UDP port number (or port range) of the destination address
of the Layer 3 flow, in the range from 0–65535. A range of ports
(separated by a hyphen) may be specified instead of a single port.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a destination IP port from a condition; however, at least
one classification parameter must be associated with a condition.
• The protocol (TCP or UDP) must be specified in the same condition, either on the same command line
or in a previous command. Use the ip protocol keywords. See the policy condition ip-protocol
command.
• The same condition cannot specify a destination IP port with a service or service group.

Examples
-> policy condition cond2 ip protocol 6 destination ip-port 137-138

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition ip-protocol Configures an IP protocol for a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

page 33-60 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition destination ip-port

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionDestinationIpPort
alaQoSConditionDestinationIpPortEnd
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionDestinationIpPort
alaQoSAppliedConditionDestinationIpPortEnd

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-61
policy condition source tcp-port QoS Policy Commands

policy condition source tcp-port

Configures a source TCP port number for a policy condition.
policy condition condition_name source tcp-port port[-port]
policy condition condition_name no source tcp-port

Syntax Definitions

condition_name The name of the condition.

port The TCP port number of the source address of the Layer 3 flow, in the
range from 0–65535. A range of ports (separated by a hyphen) may be
specified instead of a single port.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a source TCP port from a condition; however, at least one
classification parameter must be associated with a condition.
• This command is a shortcut for the policy condition source ip-port command, which requires that the
protocol also be specified. Rather than specifying source ip-port and ip protocol, use source tcp-port.
• The same condition cannot specify a source TCP port with a service or service group.

• IP port protocol types cannot be mixed in the same condition; ports must be either TCP or UDP.

• Use this condition in combination with the IPv6 condition (policy condition ipv6) to configure IPv6
policies for Layer 4 information, services, and service groups.

Examples
-> policy condition cond3 source tcp-port 137
-> policy condition cond4 ipv6 source tcp-port 21
-> policy condition cond3 no source tcp-port

Release History
Release 8.1.1; command introduced.

page 33-62 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition source tcp-port

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition ip-protocol Configures an IP protocol for a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionSourceTcpPort
alaQoSConditionSourceTcpPortEnd
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionSourceTcpPort
alaQoSAppliedConditionSourceTcpPortEnd

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-63
policy condition destination tcp-port QoS Policy Commands

policy condition destination tcp-port

Configures a destination TCP port number for a policy condition.
policy condition condition_name destination tcp-port port[-port]
policy condition condition_name no destination tcp-port

Syntax Definitions

condition_name The name of the condition.

port The TCP port number (or port range) of the destination address of the
Layer 3 flow, in the range from 0–65535. A range of ports (separated by
a hyphen) may be specified instead of a single port.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a destination TCP port from a condition; however, at least
one classification parameter must be associated with a condition.
• This command is a shortcut for the policy condition destination ip-port command, which requires
that the protocol also be specified. Rather than specifying destination ip-port and ip protocol, use
destination tcp-port.
• The same condition cannot specify a destination TCP port with a service or service group.

• IP port protocol types cannot be mixed in the same condition; ports must be either TCP or UDP.

• Use this condition in combination with the IPv6 condition (policy condition ipv6) to configure IPv6
policies for Layer 4 information, services, and service groups.

Examples
-> policy condition cond4 destination tcp-port 137-138
-> policy condition cond5 ipv6 destination tcp-port 140
-> policy condition cond4 no destination tcp-port

Release History
Release 8.1.1; command introduced.

page 33-64 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition destination tcp-port

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition ip-protocol Configures an IP protocol for a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionDestinationTcpPort
alaQoSConditionDestinationTcpPortEnd
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionDestinationTcpPort
alaQoSAppliedConditionDestinationTcpPortEnd

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-65
policy condition source udp-port QoS Policy Commands

policy condition source udp-port

Configures a source UDP port number for a policy condition.
policy condition condition_name source udp-port port[-port]
policy condition condition_name no source udp-port

Syntax Definitions

condition_name The name of the condition.

port The UDP port number of the source address of the Layer 3 flow, in the
range from 0–65535. A range of ports (separated by a hyphen) may be
specified instead of a single port.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a source UDP port from a condition; however, at least one
classification parameter must be associated with a condition.
• This command is a shortcut for the policy condition source ip-port command, which requires that the
protocol also be specified. Rather than specifying source ip port, and ip protocol, use source udp-
port.
• The same condition cannot specify a source UDP port with a service or service group.

• IP port protocol types cannot be mixed in the same condition; ports must be either TCP or UDP.

• Use this condition in combination with the IPv6 condition (policy condition ipv6) to configure IPv6
policies for Layer 4 information, services, and service groups.

Examples
-> policy condition cond5 source udp-port 1200-1400
-> policy condition cond6 ipv6 source-udp port 1000
-> policy condition cond5 no source udp-port

Release History
Release 8.1.1; command introduced.

page 33-66 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition source udp-port

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition ip-protocol Configures an IP protocol for a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionSourceUdpPort
alaQoSConditionSourceUdpPortEnd
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionSourceUdpPort
alaQoSAppliedConditionSourceUdpPortEnd

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-67
policy condition destination udp-port QoS Policy Commands

policy condition destination udp-port

Configures a destination UDP port number for a policy condition.
policy condition condition_name destination udp-port port[-port]
policy condition condition_name no destination udp-port

Syntax Definitions

condition_name The name of the condition.

port The UDP port number (or port range) of the destination address of the
Layer 3 flow, in the range from 0–65535. A range of ports (separated by
a hyphen) may be specified instead of a single port.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a destination UDP port from a condition; however, at least
one classification parameter must be associated with a condition.
• This command is a shortcut for the policy condition destination ip-port command, which requires
that the protocol also be specified. Rather than specifying destination ip-port and ip protocol, use
destination udp-port.
• The same condition cannot specify a destination UDP port with a service or service group.

• IP port protocol types cannot be mixed in the same condition; ports must be either TCP or UDP.

• Use this condition in combination with the IPv6 condition (policy condition ipv6) to configure IPv6
policies for Layer 4 information, services, and service groups.

Examples
-> policy condition cond4 destination udp-port 137-138
-> policy condition cond5 ipv6 destination udp-port 140
-> policy condition cond4 no destination udp-port

Release History
Release 8.1.1; command introduced.

page 33-68 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition destination udp-port

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionDestinationTcpPort
alaQoSConditionDestinationTcpPortEnd
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionDestinationTcpPort
alaQoSAppliedConditionDestinationTcpPortEnd

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-69
policy condition ethertype QoS Policy Commands

policy condition ethertype

Configures an ethertype value to use for traffic classification.
policy condition condition_name ethertype etype
policy condition condition_name no ethertype

Syntax Definitions

condition_name The name of the condition.

etype The Ethertype value, in the range 1536–65535 or 0x600–0xffff hex.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an Ethertype value from a condition; however, at least one
classification parameter must be associated with a condition.
• Enter a numeric or equivalent hex value for the etype.

Examples
-> policy condition cond12 ethertype 8137

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

page 33-70 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition ethertype

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionEthertype
alaQoSConditionEthertypeStatus
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionEthertype
alaQoSAppliedConditionEthertypeStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-71
policy condition established QoS Policy Commands

policy condition established

Configures an established TCP connection as a policy condition. A connection is considered established if
the ack or rst flags in the TCP header of the packet are set.
policy condition condition_name established
policy condition condition_name no established

Syntax Definitions

condition_name The name of the condition.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove established from a condition; however, at least one
classification parameter must be associated with a condition.
• When an initial TCP connection packet is received only the syn flag is set. As a result, TCP packets are
only examined if they are not the starting packet.
• Typically this condition is used in combination with source ip, destination ip, source port,
destination port, source TCP port, or destination TCP port conditions.
• Note that even though established can be used with most action parameters, it is mainly intended for
ACL use.

Examples
-> policy condition cond2 source ip 192.168.5.10 established
-> policy condition cond3 destination ip 10.255.11.40

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

page 33-72 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition established

MIB Objects
alaQoSConditionTable
alaQoSConditionTcpEstablished
alaQoSAppliedConditionTable
alaQoSAppliedConditionTcpEstablished

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-73
policy condition tcpflags QoS Policy Commands

policy condition tcpflags

Configures a specific TCP flag value or combination of flag values as a policy condition.
policy condition condition_name tcpflags [any | all] {f | s | r | p | a | u | e | w} mask {f | s | r | p | a | u | e |
w}
policy condition condition_name no tcpflags

Syntax Definitions

condition_name The name of the condition.

any Match on any of the specified TCP flags.
all Match all specified TCP flags.
f|s|r|p|a|u|e|w TCP flag value to match (f=fin, s=syn, r=rst, p=psh, a=ack, u=urg,
e=ecn, and w=cwr). The e and w flags are currently not supported.

Defaults

parameter default
any | all all

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove tcpflags from a condition; however, at least one
classification parameter must be associated with a condition.
• Use the any option to indicate that a match on any one of the specified TCP flags qualifies as a match
for the condition. Use the all option to indicate that a match on all specified TCP flags is required to
qualify as a match for the condition.
• Enter one or more TCP flags after the any or all keyword to indicate that the value of the flag bit must
be set to one to qualify as a match.
• Enter one or more TCP flags after the mask keyword to indicate which TCP flags to match.

• If a TCP flag is specified as part of the mask but does not have a corresponding match value specified
with the any or all options, then zero is assumed as the match value. For example, tcpflags all f s mask
f s a looks for the following bit values to determine a match: f=1, s=1, a=0.
• Typically this condition is used in combination with source ip, destination ip, source port,
destination port, source TCP port, or destination TCP port conditions.
• Note that even though tcpflags can be used with most action parameters, it is mainly intended for ACL
use.

page 33-74 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition tcpflags

Examples
-> policy condition c1 tcpflags all f s mask f s a
-> policy condition c2 tcpflags any a r mask a r

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

MIB Objects
alaQoSConditionTable
alaQoSConditionTcpFlags,
alaQoSConditionTcpFlagsStatus,
alaQoSConditionTcpFlagsVal,
alaQoSConditionTcpFlagsValStatus,
alaQoSConditionTcpFlagsMask,
alaQoSConditionTcpFlagsMaskStatus,
alaQoSAppliedConditionTable
alaQoSAppliedConditionTcpFlags,
alaQoSAppliedConditionTcpFlagsStatus,
alaQoSAppliedConditionTcpFlagsVal,
alaQoSAppliedConditionTcpFlagsValStatus,
alaQoSAppliedConditionTcpFlagsMask,
alaQoSAppliedConditionTcpFlagsMaskStatus,

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-75
policy condition service QoS Policy Commands

policy condition service

Configures a service for a policy condition.
policy condition condition_name service service_name
policy condition condition_name no service

Syntax Definitions

condition_name The name of the condition.

service_name The service name, configured through the policy service command.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a service group from a condition; however, at least one
classification parameter must be associated with a condition.
• A policy condition that specifies a service cannot also specify a service group, IP protocol, source IP
port, or destination IP port.

Examples
-> policy condition cond12 service serv2

Release History
Release 8.1.1; command introduced.

Related Commands

policy service Configures a service that may be used as part of a policy service group.
qos apply Applies configured global QoS and policy settings to the current
configuration (changes will be active and stored in flash).
show policy service Displays information about all particular policy services or a particular
policy service configured on the switch.

MIB Objects
alaQoSConditionTable
alaQoSConditionService
alaQoSAppliedConditionTable
alaQoSAppliedConditionService

page 33-76 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition service group

policy condition service group

Associates a policy service group with a policy condition.
policy condition condition_name service group service_group
policy condition condition_name no service group

Syntax Definitions

condition_name The name of the condition.

service_group The service group name. Service groups are configured through the
policy service group command.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a service group from a condition; however, at least one
classification parameter must be associated with a condition.
• A policy condition that specifies a service group cannot also specify a service, IP protocol, source IP
port, or destination IP port.

Examples
-> policy condition cond12 service group servgroup2

Release History
Release 8.1.1; command introduced.

Related Commands

policy service group Configures a service group and its associated services.
policy condition Creates a policy condition.
qos apply Applies configured global QoS and policy settings to the current
configuration (changes will be active and stored in flash).
show policy condition Shows information about policy conditions configured on the switch.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-77
policy condition service group QoS Policy Commands

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionServiceGroup
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionServiceGroup

page 33-78 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition icmptype

policy condition icmptype

Configures an ICMP type value to use for traffic classification.
policy condition condition_name icmptype type
policy condition condition_name no icmptype

Syntax Definitions

condition_name The name of the condition.

type The ICMP type value, in the range 0–255.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of the command to remove an ICMP type value from a condition; however, at least one
classification parameter must be associated with a condition.

Examples
-> policy condition cond12 icmptype 100

Release History
Release 8.1.1; command introduced.

Related Commands

policy condition icmpcode Configures an ICMP code value for traffic classification.
policy condition Creates a policy condition.
qos apply Applies configured global QoS and policy settings to the current
configuration (changes will be active and stored in flash).
show policy condition Shows information about policy conditions configured on the switch.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-79
policy condition icmptype QoS Policy Commands

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionIcmpType
alaQoSConditionIcmpTypeStatus
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionIcmpType
alaQoSAppliedConditionIcmpTypeStatus

page 33-80 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition icmpcode

policy condition icmpcode

Configures an ICMP code value to use for traffic classification.
policy condition condition_name icmpcode code
policy condition condition_name no icmpcode

Syntax Definitions

condition_name The name of the condition.

code The ICMP code value, in the range 0–255.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of the command to remove an ICMP code value from a condition; however, at least one
classification parameter must be associated with a condition.

Examples
-> policy condition cond12 icmpcode 150

Release History
Release 8.1.1; command introduced.

Related Commands

policy condition icmptype Configures an ICMP type value for traffic classification.
policy condition Creates a policy condition.
qos apply Applies configured global QoS and policy settings to the current
configuration (changes will be active and stored in flash).
show policy condition Shows information about policy conditions configured on the switch.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-81
policy condition icmpcode QoS Policy Commands

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionIcmpCode
alaQoSConditionIcmpCodeStatus
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionIcmpCode
alaQoSAppliedConditionIcmpCodeStatus

page 33-82 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition ip-protocol

policy condition ip-protocol

Configures an IP protocol for a policy condition.
policy condition condition_name ip-protocol protocol
policy condition condition_name no ip-protocol

Syntax Definitions

condition_name The name of the condition.

protocol The protocol associated with the flow. The range is 0–255.

Defaults

parameter default
protocol 6

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a protocol from a condition; however, at least one
classification parameter must be associated with a condition.
• If a source or destination port is specified (through the policy condition source ip-port or policy
condition destination ip-port commands), the protocol must be specified.
• The same condition cannot specify an IP protocol with a service or service group.

Examples
-> policy condition cond4 ip protocol 6

Release History
Release 8.1.1; command introduced.

Related Commands

policy condition source ip-port Configures a source IP port number for a policy condition.
policy condition destination ip- Configures a destination IP port number for a policy condition.
port
qos apply Applies configured global QoS and policy settings to the current
configuration (changes will be active and stored in flash).
show policy condition Shows information about policy conditions configured on the switch.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-83
policy condition ip-protocol QoS Policy Commands

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionIpProtocol
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionIpProtocol

page 33-84 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition ipv6

policy condition ipv6

Configures a policy condition to classify IPv6 traffic.
policy condition condition_name ipv6
policy condition condition_name no ipv6

Syntax Definitions

condition_name The name of the condition.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove IPv6 traffic as a condition; however, at least one
classification parameter must be associated with a condition.
• When the ipv6 keyword is used in a condition, a policy that uses the condition is considered an IPv6
policy. IPv6 policies are effected only on IPv6 traffic. All other IP policies are considered IPv4 policies
and are effected only on IPv4 traffic.
• IPv6 Layer 4 policies are supported and are configured using the ipv6 keyword in a condition that
specifies Layer 4 information, services, or service groups. Note that IPv6 Layer 4 policies only work
with packets that contain a single header.
• The icmptype and icmpcode keywords in an IPv6 policy imply the ICMPv6 protocol, not the ICMPv4
protocol.

Examples
-> policy condition cond4 ipv6
-> policy condition cond5 ipv6 tos 7
-> policy condition cond6 ipv6 source port 1/1
-> policy condition cond7 ipv6 source tcp port 21
-> policy condition cond8 ipv6 source tcp port 0-1024
-> policy condition cond6 no ipv6

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-85
policy condition ipv6 QoS Policy Commands

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
show policy condition Shows information about policy conditions configured on the switch.

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionIpv6Traffic
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionIpv6Traffic

page 33-86 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition nh

policy condition nh
Configures an IPv6 next header value as a policy condition. This value is compared to the next header
value in the IPv6 header.
policy condition condition_name nh next_header_value
policy condition condition_name no nh

Syntax Definitions

condition_name The name of the condition.

next_header_value The next header value (0–255).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of the command to remove the next header value as a condition; however, at least one
classification parameter must be associated with a condition.

Examples
-> policy condition cond4 nh 100
-> policy condition cond4 no nh

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
show policy condition Displays information about policy conditions configured on the switch.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-87
policy condition nh QoS Policy Commands

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionIpv6NH
alaQoSConditionIpv6NHStatus
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionIpv6NH
alaQoSAppliedConditionIpv6NHStatus

page 33-88 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition flow-label

policy condition flow-label

Configures an IPv6 flow label value as a policy condition. This value is compared to the flow label value
in the IPv6 header.
policy condition condition_name flow-label flow_label_value
policy condition condition_name no flow-label

Syntax Definitions

condition_name The name of the condition.

flow_label_value The flow-label value (0–1048575).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of the command to remove the flow label value as a condition; however, at least one
classification parameter must be associated with a condition.

Examples
-> policy condition cond4 flow-label 1500
-> policy condition cond4 no flow-label

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
show policy condition Shows information about policy conditions configured on the switch.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-89
policy condition flow-label QoS Policy Commands

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionIpv6FlowLabel
alaQoSConditionIpv6FlowLabelStatus
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionIpv6FlowLabel
alaQoSAppliedConditionIpv6FlowLabelStatus

page 33-90 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition tos

policy condition tos

Configures the precedence bits in the Type of Service (ToS) byte value for a policy condition.
policy condition condition_name tos tos_value [mask tos_mask]
policy condition conditioning no tos

Syntax Definitions

condition_name The name of the condition.

tos_value The Type of Service bits value included in the IP header. The three most
significant bits of the byte determine the precedence (i.e, priority) of the
frame (0 is the lowest, 7 is the highest).
tos_mask The mask for the ToS bits, in the range 0–7.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a ToS value from a condition; however, at least one
classification parameter must be associated with a condition.
• If a ToS value is specified, a DSCP value may not be specified.

Examples
-> policy condition cond2 tos 7

Release History
Release 8.1.1; command introduced.

Related Commands

policy condition Creates a policy condition.

qos apply Applies configured QoS and policy settings to the current configuration.
show policy condition Shows information about policy conditions configured on the switch.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-91
policy condition tos QoS Policy Commands

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionTos
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionTos

page 33-92 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition dscp

policy condition dscp

Configures the Differentiated Services Code Point (DSCP) for a policy condition. The DSCP value
defines the six most significant bits of the DS byte in the IP header.
policy condition condition_name dscp {dscp_value[-value]} [mask dscp_mask]
policy condition condition_name no dscp

Syntax Definitions

condition_name The name of the condition.

dscp_value[-value] The DiffServ Code Point value, in the range 0–63. Use a hyphen to
specify a range of DSCP values for the condition (for example, 10-20).
dscp_mask The mask for the DiffServ Code Point, in the range 0–63.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a DSCP value from a condition; however, at least one
classification parameter must be associated with a condition.
• If a DSCP value is specified, a ToS value may not be specified.

• When a DSCP policy condition is configured on one of these switches, QoS automatically calculates
the appropriate mask value.

Examples
-> policy condition cond4 dscp 10
-> policy condition cond5 dscp 20-30

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-93
policy condition dscp QoS Policy Commands

Related Commands

policy condition Creates a policy condition.

qos apply Applies configured QoS and policy settings to the current configuration.
show policy condition Shows information about policy conditions configured on the switch.

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionDscp
alaQoSConditionDscpMask
alaQoSConditionDscpEnd
alaQoSConditionDscpStatus
alaQosAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionDscp
alaQoSAppliedConditionDscpMask
alaQoSAppliedConditionDscpEnd
alaQoSAppliedConditionDscpStatus

page 33-94 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition source mac

policy condition source mac

Configures a source MAC address for a policy condition.
policy condition condition_name source mac mac_address [mask mac_mask]
policy condition condition_name no source mac

Syntax Definitions

condition_name The name of the condition.

mac_address The source MAC address in the Layer 2 header of the frame (for
example, 00:20:da:05:f6:23)
mac_mask Optional. The mask for the source MAC address (for example,
ff:ff:ff:ff:ff:ff).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a source MAC address from a condition; however, at least
one classification parameter must be associated with a condition.
• A source MAC address and a source MAC group cannot be specified in the same condition.

Examples
-> policy condition cond2 source mac 00:20:da:05:f6:23

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-95
policy condition source mac QoS Policy Commands

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionSourceMacAddr
alaQoSConditionSourceMacMask
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionSourceMacAddr
alaQoSAppliedConditionSourceMacMask

page 33-96 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition destination mac

policy condition destination mac

Configures a destination MAC address for a policy condition.

Note. Specifying a destination MAC address and mask of all zeros (00:00:00:00:00:00) as a policy
condition can result in the switch dropping all traffic. Only use this type of condition in combination
with other policies that will allow desired traffic and/or if a source or destination slot/port is also part
of the destination MAC condition.

policy condition condition_name destination mac mac_address [mask mac_mask]

policy condition condition_name no destination mac

Syntax Definitions

condition_name The name of the condition.

mac_address The destination MAC address in the Layer 2 header of the frame (for
example, 00:20:da:05:f6:23).
mac_mask Optional. The mask for the destination MAC address (for example,
ff:ff:ff:ff:ff:ff).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a destination MAC address from a condition; however, at
least one classification parameter must be associated with a condition.
• A destination MAC address and a destination MAC group cannot be specified in the same condition.

Examples
-> policy condition cond3 destination mac 00:20:da:05:f6:23

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-97
policy condition destination mac QoS Policy Commands

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionSource
alaQoSConditionDestinationMacAddr
alaQoSConditionDestinationMacMask
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionSource
alaQoSAppliedConditionDestinationMacAddr
alaQoSAppliedConditionDestinationMacMask

page 33-98 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition source mac group

policy condition source mac group

Associates a source MAC group with a policy condition.
policy condition condition_name source mac group group_name
policy condition condition_name no source mac group

Syntax Definitions

condition_name The name of the condition.

group_name The name of the source MAC group, configured through the policy mac
group command.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a source MAC group from a condition; however, at least
one classification parameter must be associated with a condition.
• A source MAC address and a source MAC group cannot be specified in the same condition.

Examples
-> policy condition cond4 source mac group mac_group1

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy mac group Configures a MAC group and its associated MAC addresses.
policy condition Creates a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-99
policy condition source mac group QoS Policy Commands

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionSourceMacGroup
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionSourceMacGroup

page 33-100 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition destination mac group

policy condition destination mac group

Associates a destination MAC group with a policy condition.
policy condition condition_name destination mac group mac_group
policy condition condition_name no destination

Syntax Definitions

condition_name The name of the condition.

mac_group The name of the destination MAC group, configured through the policy
mac group command.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a destination MAC group from a policy condition;
however, at least one classification parameter must be associated with a condition.
• A destination MAC address and a destination MAC group cannot be specified in the same condition.

Examples
-> policy condition cond5 destination mac group mac_group1

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy mac group Configures a MAC group and its associated MAC addresses.
policy condition Creates a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-101
policy condition destination mac group QoS Policy Commands

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionDestinationMacGroup
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionDestinationMacGroup

page 33-102 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition source vlan

policy condition source vlan

Configures a source VLAN for a policy condition.
policy condition condition_name source vlan vlan_id
policy condition condition_name no source vlan

Syntax Definitions

condition_name The name of the condition.

vlan_id The source VLAN ID for the flow.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of the command to remove a source VLAN from a policy condition; however, at least one
classification parameter must be associated with a condition.

Examples
-> policy condition cond5 source vlan 3

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionSourceVlan
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionSourceVlan

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-103
policy condition inner source-vlan QoS Policy Commands

policy condition inner source-vlan

Configures an inner source VLAN ID as a policy condition. This condition applies to double-tagged
VLAN Stacking traffic and is used to classify such traffic based on the inner VLAN ID tag, also known as
the customer VLAN ID.
policy condition condition_name inner source-vlan vlan_id
policy condition condition_name no inner source-vlan

Syntax Definitions

condition_name The name of the condition.

vlan_id The inner source VLAN ID (customer VLAN ID) to match on double-
tagged packets.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove an inner source VLAN from a policy condition; however,
at least one classification parameter must be associated with a condition.
• Policies that use the inner source VLAN condition are referred to as QoS VLAN Stacking policies.
These are separate policies from those configured through the VLAN Stacking Service application.

Examples
-> policy condition cond5 inner source-vlan 3
-> policy condition cond5 no inner source-vlan

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

page 33-104 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition inner source-vlan

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionInnerSourceVlan
alaQoSConditionInnerSourceVlanStatus
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionInnerSourceVlan
alaQoSAppliedConditionInnerSourceVlanStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-105
policy condition destination vlan QoS Policy Commands

policy condition destination vlan

Configures a destination VLAN (multicast only) for a policy condition. Use the no form of the command
to remove a destination VLAN from a condition.
policy condition condition_name destination vlan vlan_id
policy condition condition_name no destination vlan

Syntax Definitions

condition_name The name of the condition.

vlan_id The destination VLAN ID for the flow.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a destination VLAN from a condition; however, at least
one classification parameter must be associated with a condition.
• Note that this condition is supported for multicast only policies.

Examples
-> policy condition cond4 destination vlan 3 multicast ip any

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

page 33-106 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition destination vlan

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionDestinationVlan
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionDestinationVlan

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-107
policy condition 802.1p QoS Policy Commands

policy condition 802.1p

Configures the 802.1p value for a policy condition.
policy condition condition_name 802.1p 802.1p_value
policy condition condition_name no 802.1p

Syntax Definitions

condition_name The name of the condition.

802.1p_value The 802.1p value in the 802.1Q VLAN tag for the flow. Values range
from 0 (lowest priority) to 7 (highest priority).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of the command to remove an 802.1p value for a condition; however, at least one
classification parameter must be associated with a condition.

Examples
-> policy condition cond3 802.1p 7

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSCondition8021p
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedCondition8021p

page 33-108 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition inner 802.1p

policy condition inner 802.1p

Configures an inner (customer) source 802.1p value for a policy condition. This condition applies to
double-tagged VLAN Stacking traffic and is used to classify such traffic based on the inner 802.1p bit
value.
policy condition condition_name inner 802.1p 802.1p_value
policy condition condition_name no inner 802.1p

Syntax Definitions

condition_name The name of the condition.

802.1p_value The inner 802.1p value of the inner 802.1Q VLAN tag (customer
VLAN) to match on double-tagged packets. Values range from 0 (lowest
priority) to 7 (highest priority).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove an 802.1p value for a condition; however, at least one
classification parameter must be associated with a condition.
• Policies that use the inner 802.1p condition are referred to as QoS VLAN Stacking policies. These are
separate policies from those configured through the VLAN Stacking Service application.

Examples
-> policy condition cond3 inner 802.1p 7
-> policy condition cond3 no inner 802.1p

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-109
policy condition inner 802.1p QoS Policy Commands

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionInner8021p
alaQoSConditionInner8021pStatus
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionInner8021p
alaQoSAppliedConditionInner8021pStatus

page 33-110 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition source port

policy condition source port

Configures a source port number for a policy condition.
policy condition condition_name source port chassis/slot/port[-port2]
policy condition condition_name no source port

Syntax Definitions

condition_name The name of the condition.

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of the command to remove a source port from a condition; however, at least one
classification parameter must be associated with a condition.

Examples
-> policy condition cond2 source port 3/1/1
-> policy condition cond3 source port 3/1/2-4

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-111
policy condition source port QoS Policy Commands

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionSourceSlot
alaQoSConditionSourcePort
alaQoSConditionSourcePortEnd
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionSourceSlot
alaQoSAppliedConditionSourcePort
alaQoSAppliedConditionSourcePortEnd

page 33-112 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition destination port

policy condition destination port

Configures a destination port number for a policy condition.
policy condition condition_name destination port chassis/slot/port[-port]
policy condition condition_name no destination port

Syntax Definitions

condition_name The name of the condition.

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a destination port from a condition; however, at least one
classification parameter must be associated with a condition.
• The destination port condition is only applied to bridged traffic, it is not applied to routed traffic.

Examples
-> policy condition cond3 destination port 4/1/2
-> policy condition cond4 destination port 4/1/3-4

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-113
policy condition destination port QoS Policy Commands

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionDestinationSlot
alaQoSConditionDestinationPort
alaQoSConditionDestinationPortEnd
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionDestinationSlot
alaQoSAppliedConditionDestinationPort
alaQoSAppliedConditionDestinationPortEnd

page 33-114 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition source port group

policy condition source port group

Associates a source port group with a policy condition.
policy condition condition_name source port group group_name
policy condition condition_name no source port group

Syntax Definitions

condition_name The name of the condition.

group_name The name of the source port group. Port groups are configured through
the policy port group command.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a source port group from a condition; however, at least one
classification parameter must be associated with a condition.
• When a source port group condition is used in a policy rule to apply rate limiting actions, the rate
limiting values are shared across all the ports that are associated with the specified group name. To
apply rate limiting actions on an individual basis to each port in the group, use the policy condition
source port split-group command.

Examples
-> policy condition cond6 source port group portgr4

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-115
policy condition source port group QoS Policy Commands

Related Commands

policy port group Configures a port group and its associated slot and port numbers.
qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
policy condition source port Associates a source port split-group with a policy condition.
split-group
show policy condition Shows information about policy conditions configured on the switch.

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionSourcePortGroup
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionSourcePortGroup

page 33-116 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition source port split-group

policy condition source port split-group

Associates a source port split-group with a policy condition. A split-group condition is used in policy rules
that are defined to apply rate limiting actions to each individual port within the specified group. In other
words, the rate limiting values are not shared among all members of the port group.
policy condition condition_name source port split-group group_name
policy condition condition_name no source port split-group

Syntax Definitions

condition_name The name of the condition.

group_name The name of the source port group. Port groups are configured through
the policy port group command.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a source port split-group from a condition; however, at
least one classification parameter must be associated with a condition.
• Using a split-group condition in a rate limiting policy rule avoids having to create a separate policy
rule for each individual port. This reduces the amount of configuration and switch resources required to
apply rate limiting actions to individual ports.
• A source port group is the only QoS group that supports the split-group option; other QoS groups (for
example, a destination port group or network group) do not support the split-group option.
• A policy rule containing a source port split-group condition can only belong to the default policy list.
Assigning this type of rule to other QoS policy lists is not allowed.
• Do not use a shared bandwidth policy action (policy action shared) in a policy rule that specifies a
source port split-group condition. This type of action shares metering resources with all other rules that
contain the same shared policy action. Sharing these resources with rules that contain a split-group
condition is not recommended.

Examples
-> policy condition cond7 source port split-group portgr4
-> policy condition cond7 no source port split-group

Release History
Release 8.2.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-117
policy condition source port split-group QoS Policy Commands

Related Commands

policy port group Configures a port group and its associated slot and port numbers.
qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
show policy condition Shows information about policy conditions configured on the switch.
show active policy rule Displays details about applied policy rules that are active (enabled) on
the switch, including per-port statistics.

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionSourcePortGroup
alaQoSConditionSourcePortSplitGroup
alaQoSConditionSourcePortSplitGroupStatus
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionSourcePortGroup
alaQoSAppliedConditionSourcePortSplitGroup
alaQoSAppliedConditionSourcePortSplitGroupStatus

page 33-118 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition destination port group

policy condition destination port group

Associates a destination port group with a policy condition. Use the no form of the command to remove a
destination port group from a condition.
policy condition condition_name destination port group group_name
policy condition condition_name no destination port

Syntax Definitions

condition_name The name of the condition.

group_name The name of the destination port group. Port groups are configured
through the policy port group command.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of the command to remove a destination port group from a condition; however, at least
one classification parameter must be associated with a condition.

Examples
-> policy condition cond6 destination port group portgr4

Release History
Release 8.1.1; command introduced.

Related Commands

policy port group Configures a port group and its associated slot and port numbers.
qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-119
policy condition destination port group QoS Policy Commands

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionDestinationPortGroup
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionDestinationPortGroup

page 33-120 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition vrf

policy condition vrf

Associates a Virtual Routing and Forwarding (VRF) instance with a policy condition.
policy condition condition_name vrf {vrf_name | default}
policy condition condition_name no vrf

Syntax Definitions

condition_name The name of the condition.

vrf_name The name of the VRF instance to which the QoS policy condition
applies.
default Specifies the default VRF instance.

Defaults
By default, QoS policy conditions are not associated with any VRF instance. The policy applies across all
instances.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a VRF instance from a condition; however, at least one
classification parameter must be associated with a condition.
• VRF policies are configured in the default VRF, similar to how all other QoS policies are configured.
If the VRF name specified does not exist, the policy is not allocated any system resources.
• Policies that do not specify a VRF name are considered global policies and are applied across all VRF
instances and VLANs.
• Policies that specify the default VRF apply only to traffic in the default VRF instance.

• Policies that specify a VRF name apply only to traffic in the VRF instance associated with that name.

• The switch network group is supported only in VRF policies that specify the default VRF instance. If
this group is specified in a global policy (no VRF specified) then the policy is applied across all VRF
instances.

Examples
-> policy condition cond6 vrf engr-vrf
-> policy condition cond7 vrf default
-> policy condition cond6 no vrf

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-121
policy condition vrf QoS Policy Commands

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionVrfName
alaQoSConditionVrfNameStatus
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionVrfName
alaQoSAppliedConditionVrfNameStatus

page 33-122 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition fragments

policy condition fragments

Associates TCP packet fragments with a policy condition.
policy condition condition_name fragments
policy condition condition_name no fragments

Syntax Definitions

condition_name The name of the condition.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of the command to remove TCP packet fragments from a condition; however, at least one
classification parameter must be associated with a condition.

Examples
-> policy condition cond6 fragments
-> policy condition cond7 no fragments

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy condition Creates a policy condition.
show policy condition Shows information about policy conditions configured on the switch.

MIB Objects
alaQoSConditionTable
alaQoSConditionAppFpGroup
alaQoSConditionAppFpGroupStatus
alaQoSConditionName
alaQoSConditionFragments
alaQoSAppliedConditionTable
alaQoSAppliedConditionName
alaQoSAppliedConditionFragments

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-123
policy condition app-mon QoS Policy Commands

policy condition app-mon

Associates an application group or application with a policy condition for application enforcement.
policy condition condition_name {app-mon-application-group app_group_name | app-mon-applica-
tion-name app_name}
policy condition condition_name no {app-mon-application-group app_group_name | app-mon-appli-
cation-name app_name}

Syntax Definitions

condition_name The name of the condition.

app_group_name Application group to which the QoS policy condition applies.
app_name Name of the application to which the QoS policy condition applies.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove an application group or an application name from a
condition.
• If the app-mon-application-group option is used, QoS policy condition as ‘application group’ is
created. If the app-mon-application-name option is used, QoS policy condition as ‘application’ is
created.
• While configuring an AppMon enforcement policy rule, multiple condition parameters (for example,
source IP, destination IP, source VLAN and so on) cannot be defined in a single policy condition along
with the application name or group.
• Application name and application group name is a case sensitive string.

Examples
-> policy condition c1 app-mon-application-group apg1
-> policy condition c2 app-mon-application-name whatsapp

Release History
Release 8.2.1; command introduced.

page 33-124 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy condition app-mon

Related Commands

policy condition Creates a policy condition.

show policy condition Displays information about policy conditions configured on the switch.

MIB Objects
alaQoSConditionTable
alaQoSConditionDPIGrpName
alaQosConditionDpiAppGroupStatus
alaQosConditionDpiAppName
alaQosConditionDpiAppNameStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-125
policy action QoS Policy Commands

policy action
Configures or deletes a QoS action. A QoS action describes how traffic that matches a particular QoS
condition should be treated. It may specify a particular set of bandwidth and queue parameters, or it may
simply specify whether the flow is allowed or denied on the switch.
This section describes the base command. Optional keywords are listed below and described as separate
commands later in this chapter. (Options may be used in combination but are described separately for ease
in explanation.) Use the no form for keywords to remove the parameter from the action.
Note that some action parameters may not be supported depending on the platform you are using. Also
some action parameters may not be supported with some conditions. See the conditions in the OmniSwitch
AOS Release 8 Network Configuration Guide.
policy action action_name
[disposition {accept | drop | deny}]
[shared]
[priority priority_value]
[maximum bandwidth bps]
[maximum depth bytes]
[cir bps [cbs bps] [pir bps] [pbs bps] [cpu priority priority] [color-only]
[tos tos_value]
[802.1p 802.1p_value]
[dcsp dcsp_value]
[map {802.1p | tos | dscp} to {802.1p | tos| dscp} using map_group]
[permanent gateway ip ip_address]
[port-disable]
[redirect port chassis/slot/port]
[redirect linkagg link_agg]
[no-cache]
[{ingress | egress | ingress egress | no} mirror chassis/slot/port]
policy no action action_name

Syntax Definitions

action_name A name for the action, any alphanumeric string.

Defaults
By default, no drop algorithm is configured for the action, and any queues created by the action are not
shared.

parameter default
accept | drop | deny accept

Platforms Supported
OmniSwitch 6860, 6860E

page 33-126 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy action

Usage Guidelines
• Any condition parameters that the hardware supports will be used to classify the traffic; any condition
parameters that are not supported by the hardware will not be used to classify traffic, and the event will
be logged in the QoS log.
• Bandwidth parameters may be specified when the action is created or may be specified as separate
commands.
• Use the qos apply command to activate configuration changes.

• Use the no form of the command to remove a QoS action from the configuration.

• If the snapshot command is entered after the policy action command is configured, the resulting
ASCII file will include the following additional syntax for the policy action command:
from {cli | ldap | blt}
This syntax indicates how the action was created. The cli and ldap options may be changed by a user
modifying the ASCII file; however, changing this setting is not recommended. The blt option indi-
cates a built-in action, this setting is not configurable.

Examples
-> policy action action1 accept

Release History
Release 8.1.1; command introduced.

Related Commands

policy condition Configures a condition associated with the action.

qos apply Applies configured QoS and policy settings to the current configuration.
show policy action Displays information about policy actions.

MIB Objects
alaQoSActionTable
alaQoSActionName
alaQoSActionSource
alaQoSAppliedActionTable
alaQoSAppliedActionName
alaQoSAppliedActionSource

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-127
policy action disposition QoS Policy Commands

policy action disposition

Configures a disposition for a policy action.
policy action action_name disposition {accept | drop | deny}
policy action action_name no disposition

Syntax Definitions

action_name The name of the action.

accept Specifies that the switch should accept the flow.
drop Specifies that the switch should silently drop the flow.
deny Specifies that the switch should drop the flow and issue an ICMP
message indicating the flow was dropped for administrative reasons.
Currently this option will provide the same result as drop; that is, the
flow is silently dropped.

Defaults

parameter default
accept | drop | deny accept

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to remove a disposition from an action.

Examples
-> policy action a3 disposition deny
-> policy action a3 no disposition

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy action Creates a policy action.
show policy action Displays information about policy actions.

page 33-128 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy action disposition

MIB Objects
alaQoSActionTable
alaQoSActionName
alaQoSActionDisposition
alaQoSAppliedActionTable
alaQoSAppliedActionName
alaQoSAppliedActionDisposition

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-129
policy action shared QoS Policy Commands

policy action shared

Enables bandwidth sharing among multiple QoS rules that use the same maximum bandwidth action.
policy action action_name shared
policy action action_name no shared

Syntax Definitions

action_name The name of the action.

Defaults
By default, queues created by an action are not shared.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the shared policy action is not specified, then each bandwidth rule will implement a separate
instance of the specified bandwidth allocation.
• Use the no form of the command to disable sharing.

Example
-> policy action action5 maximum bandwidth 10m shared
-> policy action action6 maximum bandwidth 10m shared
-> policy action action5 no shared

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy action maximum Creates a maximum bandwidth policy action.
bandwidth
show policy action Displays information about policy actions.

page 33-130 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy action shared

MIB Objects
alaQoSActionTable
alaQoSActionName
alaQoSActionShared
alaQoSAppliedActionTable
alaQoSAppliedActionName
alaQoSAppliedActionShared

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-131
policy action priority QoS Policy Commands

policy action priority

Configures the priority for queuing a flow to which the QoS action applies.
policy action action_name priority priority_value
policy action action_name no priority

Syntax Definitions

action_name The name of the action.

priority_value The priority value assigned for scheduling traffic on the output port. The
valid range is 0–12.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a priority value from an action.

• The priority value specified with this command is applied as follows:

– Priority 0–7 for ToS/802.1p priority values (CS0–CS7 for DSCP).
– Priority 8–11 for DSCP AF1x–AF4x code point.
– Priority 12 for DSCP EF code point.

Examples
-> policy action action1 priority 1
-> policy action action2 priority 10
-> policy action action1 no priority

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy action Creates a policy action.
show policy action Displays information about policy actions.

page 33-132 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy action priority

MIB Objects
alaQoSActionTable
alaQoSActionName
alaQoSActionPriority
alaQoSActionPriorityStatus
alaQoSAppliedActionTable
alaQoSAppliedActionName
alaQoSAppliedActionPriority
alaQoSAppliedActionPriorityStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-133
policy action maximum bandwidth QoS Policy Commands

policy action maximum bandwidth

Configures a maximum bandwidth value for a policy action.
policy action action_name maximum bandwidth bps[k | m | g | t]
policy action action_name no maximum bandwidth

Syntax Definitions

action_name The name of the action.

bps[k | m | g | t] The maximum amount of bandwidth, in bits-per-second, for all traffic
that ingresses on the port. The value may be entered as an integer (for
example, 10) or with abbreviated units (for example, 10k, 5m, 1g, 1t).

Defaults

parameter default
k|m|g|t k

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a maximum bandwidth value from an action.

• If the maximum bandwidth value is specified as an integer, without an abbreviated unit designation, the
value is applied in kbps by default. For example, if the number 10 is specified, 10K is the maximum
bandwidth value used. However, if 10G is specified, the maximum bandwidth value applied is 10 gbps.
• Use the shared policy action to enable sharing of bandwidth across policy rules that specify the same
maximum bandwidth action.
• Flow based limiting does not take the IFG of 20 bytes into account when calculating bandwidth.

Examples
-> policy action action3 maximum bandwidth 10000
-> policy action action4 maximum bandwidth 10k shared
-> policy action action5 maximum bandwidth 10k shared
-> policy action action4 no maximum bandwidth

Release History
Release 8.1.1; command introduced.

page 33-134 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy action maximum bandwidth

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy action Creates a policy action.
show policy action Displays information about policy actions.

MIB Objects
alaQoSActionTable
alaQoSActionName
alaQoSActionMaximumBandwidth
alaQoSAppliedActionTable
alaQoSAppliedActionName
alaQoSAppliedActionMaximumBandwidth

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-135
policy action maximum depth QoS Policy Commands

policy action maximum depth

Configures the maximum bucket size assigned to this action. The bucket size determines how much the
traffic can burst over the maximum bandwidth rate. When the bucket size is reached, the switch starts to
drop packets.
policy action action_name maximum depth bps[k | m | g | t]
policy action action_name no maximum depth

Syntax Definitions

action_name The name of the action.

bps[k | m | g | t] The maximum bucket size, in bits-per-second. The value may be entered
as an integer (for example, 10) or with abbreviated units (for example,
10k, 5m, 1g).

Defaults

parameter default
k|m|g|t k

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a maximum depth value from a policy action.

• If the maximum depth value is specified as an integer, without an abbreviated unit designation, the
value is applied in kbps by default. For example, if the number 10 is specified, 10K is the maximum
depth value used. However, if 10G is specified, the maximum depth value applied is 10 gbps.
• A maximum depth action is used in combination with a maximum bandwidth action.

Examples
-> policy action action2 maximum depth 100
-> policy action action2 no maximum depth

Release History
Release 8.1.1; command introduced.

page 33-136 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy action maximum depth

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy action Creates a policy action.
show policy action Displays information about policy actions.

MIB Objects
alaQoSActionTable
alaQoSActionName
alaQoSActionMaximumDepth
alaQoSAppliedActionTable
alaQoSAppliedActionName
alaQoSAppliedActionMaximumDepth

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-137
policy action cir QoS Policy Commands

policy action cir

Configures a Tri-Color Marking (TCM) policy action. This type of action includes parameters for
Committed Information Rate (CIR), Committed Burst Size (CBS), Peak Information Rate (PIR), and Peak
Burst Size (PBS). The TCM policier meters and marks packets red, green, or yellow based on the
parameter values of this policy action.
policy action action_name cir bps [cbs bps] [pir bps] [pbs bps] [color-only]
policy action action_name no cir
policy action action_name no pir

Syntax Definitions

action_name The name of the action.

bps[k | m | g | t] The maximum amount of bandwidth, in bits-per-second, for all traffic
that ingresses on the port. The value may be entered as an integer (for
example, 10) or with abbreviated units (for example, 10k, 5m, 1g, 1t).
color-only Disables TCM rate limiting based on the metering results. Packets are
only marked the specific color that applies to the level of packet
conformance.

Defaults

parameter default
cbs pir pbs bps 0
k|m|g|t k
priority 0

By default, this action enables rate limiting based on TCM marking and metering.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the TCM parameter values.

• If the color-only parameter is specified with this command, the TCM action will only mark packet
color; packets are not rate limited based on the metering results. In this case, packets are then subject to
any rate limiting specifications as defined in the queue management configuration for the switch.
• This implementation of TCM supports two rate limiting modes: Single-Rate (srTCM) and Two-Rate
(trTCM). The srTCM mode marks packets based only on the CIR and the two burst sizes: CBS and
PBS. The trTCM mode marks packets based on both the CIR and PIR and their associated CBS and
PBS values.
• There is no explicit CLI command to configure the mode (srTCM or trTCM) in which the TCM meter
operates. Instead, the mode is determined by the CIR and PIR values configured for the policy action.

page 33-138 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy action cir

If the PIR value is greater than the CIR value, trTCM is used. If the PIR value is less than the CIR
value, srTCM is used.
• Configuring CIR and CBS is similar to configuring a maximum bandwidth. Configuring CIR and PIR
is similar to configuring maximum depth.
• The number of packets counted as a result of the counter color mode setting is displayed using the
show active policy rule command. These statistics are only shown for those rules that are configured
with a TCM policy action.

Examples
The following command examples configure srTCM (the default):
-> policy action A3 cir 10M
-> policy action A4 cir 10M cbs 4k
-> policy action A5 cir 10M cbs 4k pir 10M
-> policy action A6 cir 10M cbs 4k pir 10M pbs 4k
-> policy action a7 cir 5M cbs 2k color-only
-> policy action A3 no cir
-> policy action A5 no pir
The following command examples configure trTCM (note that PIR is greater than CIR):
-> policy action A7 cir 10M cbs 4k pir 20M
-> policy action A8 cir 10M cbs 4k pir 20M pbs 40M
-> policy action a9 cir 5M cbs 1M pbs 10M pbs 2M color-only
-> policy action A7 no cir

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy action Creates a policy action.
show policy action Displays information about policy actions.

MIB Objects
alaQoSActionTable
alaQoSActionCIR
alaQoSActionCIRStatus
alaQoSActionCBS
alaQoSActionCBSStatus
alaQoSActionPIR
alaQoSActionPIRStatus
alaQoSActionPBS
alaQoSActionPBSStatus
alaQoSActionColorOnly
alaQoSAppliedActionTable
alaQoSAppliedActionCIR
alaQoSAppliedActionCIRStatus
alaQoSAppliedActionCBS
alaQoSAppliedActionCBSStatus
alaQoSAppliedActionPIR

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-139
policy action cir QoS Policy Commands

alaQoSAppliedActionPIRStatus
alaQoSAppliedActionPBS
alaQoSAppliedActionPBSStatus
alaQoSAppliedColorOnly

page 33-140 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy action cpu priority

policy action cpu priority

Configures a CPU priority policy action.
policy action action_name cpu priority priority
policy action action_name no cpu priority

Syntax Definitions

action_name The name of the action.

priority The CPU queue on which packets destined for the CPU are received.
The valid range is 0–31.

Defaults
By default, the CPU priority is set to zero.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to remove the CPU priority parameter value.

Examples
-> policy action A7 cpu priority 15
-> policy action A8 cpu priority 31
-> policy action A7 no cpu priority

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy action Creates a policy action.
show policy action Displays information about policy actions.

MIB Objects
alaQoSActionTable
alaQoSActionCPUPriority
alaQoSActionCPUPriorityStatus
alaQoSAppliedActionTable
alaQoSAppliedActionCPUPriority
alaQoSAppliedActionCPUPriorityStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-141
policy action tos QoS Policy Commands

policy action tos

Configures a Type of Service (ToS) bits value to be applied to packets in outgoing flows to which the
specified policy applies.
policy action action_name tos tos_value
policy action action_name no tos

Syntax Definitions

action_name The name of the action.

tos_value The three-bit priority value in the IP header that should be set on
outgoing frames in flows that match the specified policy. Values range
from 0 (lowest priority) to 7 (highest priority).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a ToS value from a policy action.

• Note that specifying both ToS and DSCP in the same action is not allowed.

Examples
-> policy action action3 tos 4
-> policy action action3 no tos

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy action Creates a policy action.
show policy action Displays information about policy actions.

page 33-142 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy action tos

MIB Objects
alaQoSActionTable
alaQoSActionName
alaQoSActionTos
alaQoSAppliedActionTable
alaQoSAppliedActionName
alaQoSAppliedActionTos

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-143
policy action 802.1p QoS Policy Commands

policy action 802.1p

Configures a value to be set in the 802.1p bits of the 802.1Q byte of an outgoing frame for traffic that
matches a policy with this action.
policy action action_name 802.1p 802.1p_value
policy action action_name no 802.1p

Syntax Definitions

action_name The name of the action.

802.1p_value The priority value to be set in 802.1Q frames. Values range from 0
(lowest priority) to 7 (highest priority).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove an 802.1p value from a policy action.

• Note that specifying both ToS and DSCP in the same action is not allowed.

Examples
-> policy action action4 802.1p 7
-> policy action action4 no 802.1p

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy action Creates a policy action.
show policy action Displays information about policy actions.

page 33-144 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy action 802.1p

MIB Objects
alaQoSActionTable
alaQoSActionName
alaQoSAction8021p
alaQoSAppliedActionTable
alaQoSAppliedActionName
alaQoSAppliedAction8021p

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-145
policy action dscp QoS Policy Commands

policy action dscp

Configures a Differentiated Services Code Point (DSCP) value to be set in an outgoing flow for traffic that
matches rules with this action.
policy action action_name dscp dscp_value
policy action action_name no dscp

Syntax Definitions

action_name The name of the action.

dscp_value The DSCP value to be set, in the range 0–63.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a DSCP value from a policy action.

• Note that specifying both ToS and DSCP in the same action is not allowed.

Examples
-> policy action action2 dscp 61
-> policy action action2 no dscp

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy action Creates a policy action.
show policy action Displays information about policy actions.

page 33-146 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy action dscp

MIB Objects
alaQoSActionTable
alaQoSActionName
alaQoSActionDscp
alaQoSAppliedActionTable
alaQoSAppliedActionName
alaQoSAppliedActionDscp

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-147
policy action map QoS Policy Commands

policy action map

Configures a mapping group for a policy action.
policy action map {802.1p | tos | dscp} to {802.1p | tos| dscp} using map_group
policy action no map

Syntax Definitions

action_name The name of the action.

802.1p Indicates that an 802.1p value should be mapped.
tos Indicates that a ToS value should be mapped.
dscp Indicates that a DSCP value should be mapped.
map_group The name of the map group, configured through the policy map group
command.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When remapping is configured with this command and a flow matches a policy with this remapping
action, and the 802.1p, ToS, or DSCP setting in the incoming flow is specified by the map group, the
value will be remapped in the outgoing flow according to the map group.
• If the 802.1p, ToS, or DSCP setting in the incoming flow is not a value specified in the map group, the
switch will do one of two things:
If the remap from and remap to types are the same (802.1p to 802.1p, ToS to ToS, or DSCP to DSCP),
the values in the outgoing flow will be unchanged. If the remap from and remap to types are not the
same (for example: 802.1p to ToS), the switch will determine the outgoing 802.1p and ToS based on
whether or not the port is trusted or untrusted).
• Use the no form of the command to delete the map group from the configuration.

Examples
-> policy action a1 map 802.1p to 802.1p using mapGroup2
-> policy action a2 map 802.1p to tos using mapGroup3

Release History
Release 8.1.1; command introduced.

page 33-148 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy action map

Related Commands

policy map group Configures a map group and its associated mappings for 802.1p, Type of
Service (ToS), or Differentiated Services Code Point (DSCP) values.
qos apply Applies configured QoS and policy settings to the current configuration.
policy action Creates a policy action.
show policy action Displays information about policy actions.
show policy map group Displays information about all pending and applied policy map groups
or a particular map group.

MIB Objects
alaQoSActionTable
alaQoSActionMapFrom
alaQoSActionMapTo
alaQoSActionMapGroup
alaQoSAppliedActionTable
alaQoSAppliedActionMapFrom
alaQoSAppliedActionMapTo
alaQoSAppliedActionMapGroup

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-149
policy action permanent gateway-ip QoS Policy Commands

policy action permanent gateway-ip

Used for Policy Based Routing (PBR). Routed flows to which this action is applied will be directed to the
IP address specified in the action regardless of whether or not a route already exists in the switch routing
table.
policy action action_name permanent gateway-ip ip_address
policy action action_name no permanent gateway-ip

Syntax Definitions

action_name The name of the action.

ip_address The destination IP address to which packets will be routed.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a gateway IP address from a policy action.

• If the gateway goes down, the traffic to be routed over the gateway will be dropped.

Examples
-> policy action pbr2 permanent gateway-ip 10.10.2.1
-> policy action pbr2 no permanent gateway-ip

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy action Creates a policy action.
show policy action Displays information about policy actions.

page 33-150 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy action permanent gateway-ip

MIB Objects
alaQoSActionTable
alaQoSActionName
alaQoSActionPermanentGatewayIpAddr
alaQoSAppliedActionTable
alaQoSAppliedActionName
alaQoSAppliedActionPermanentGatewayIpAddr

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-151
policy action port-disable QoS Policy Commands

policy action port-disable

Administratively disables the source port of the traffic to which this action is applied.
policy action action_name port-disable
policy action action_name no port-disable

Syntax Definitions

action_name The name of the action.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove port-disable from the policy action.

• An SNMP trap is sent when a port is administratively disabled through a port disable action or a
UserPorts shutdown function.
• To enable a port disabled by this action, use the interfaces or clear violation command to
administratively enable the port, or physically disconnect and reconnect the port cable.

Examples
-> policy action pd01 port-disable
-> policy action pb02 no port-disable

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy action Creates a policy action.
show policy action Displays information about policy actions.
interfaces Administratively enables or disables a port.
interfaces wait-to-restore Administratively clears the violation that disabled the port or link
aggregate and restores the port to enabled status.

page 33-152 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy action port-disable

MIB Objects
alaQoSActionTable
alaQoSActionName
alaQoSActionPortdisable
alaQoSAppliedActionTable
alaQoSAppliedActionName
alaQoSAppliedActionPortdisable

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-153
policy action redirect port QoS Policy Commands

policy action redirect port

Redirects all traffic (flooded, bridged, routed, and multicast) matching a redirect policy to the specified
port instead of the port to which the traffic was destined.
policy action action_name redirect port chassis/slot/port
policy action action_name no redirect port

Syntax Definitions

action_name The name of the action.

chassis/slot/port The chassis ID, slot, and port number (3/1/1) for a specific port.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove redirect port from the policy action.

• When redirecting routed traffic from VLAN A to VLAN B, the redirect port must belong to VLAN B
(tagged or default VLAN).
• Routed packets (from VLAN A to VLAN B) are not modified after they are redirected; the source and
MAC address remain the same. In addition, if the redirect port is tagged, the redirected packets will
have a tag from the ingress VLAN A.
• If a route exists for the redirected flow, then redirected packets are the final post-routing packets.

• If a route does not exist for the redirected flow, the flow is not redirected to the specified port or link
aggregate and is “blackholed”. As soon as a route is available, the flow is then redirected as specified
in the policy.
• In most cases, a redirected flow will not trigger an update to the routing and ARP tables. If necessary,
create a static route for the flow or assign the redirect port to the ingress VLAN (VLAN A) to send
packets to the redirect port until a route is available.
• When redirecting bridged traffic on VLAN A, the redirect port must belong to VLAN A (tagged or
default VLAN).

Examples
-> policy action rp01 redirect port 1/1/12
-> policy action rp01 no redirect port

Release History
Release 8.1.1; command introduced.

page 33-154 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy action redirect port

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy action Creates a policy action.
show policy action Displays information about policy actions.

MIB Objects
alaQoSActionTable
alaQoSActionName
alaQoSActionRedirectSlot
alaQoSActionRedirectPort
alaQoSAppliedActionTable
alaQoSAppliedActionName
alaQoSAppliedActionRedirectSlot
alaQoSAppliedActionRedirectPort

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-155
policy action redirect linkagg QoS Policy Commands

policy action redirect linkagg

Redirects all traffic (flooded, bridged, routed, and multicast) matching a redirect policy to the specified
link aggregate ID instead of the link aggregate to which the traffic was destined.
policy action action_name redirect linkagg link_agg
policy action action_name no redirect linkagg

Syntax Definitions

action_name The name of the action.

link_agg The link aggregate ID number (0–32) to assign to the specified VLAN.
See Chapter 12, “Link Aggregation Commands.”

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove redirect linkagg from the policy action.

• When redirecting routed traffic from VLAN A to VLAN B, the redirect link aggregate ID must belong
to VLAN B (tagged or default VLAN).
• Routed packets (from VLAN A to VLAN B) are not modified after they are redirected; the source and
MAC address remain the same. In addition, if the redirect link aggregate ID is tagged, the redirected
packets will have a tag from the ingress VLAN A.
• If a route exists for the redirected flow, then redirected packets are the final post-routing packets.

• If a route does not exist for the redirected flow, the flow is not redirected to the specified link aggregate
ID and is “blackholed”. As soon as a route is available, the flow is then redirected as specified in the
policy.
• In most cases, a redirected flow will not trigger an update to the routing and ARP tables. If necessary,
create a static route for the flow or assign the redirect port or link aggregate ID to the ingress VLAN
(VLAN A) to send packets to the redirect port until a route is available.
• When redirecting bridged traffic on VLAN A, the redirect port or link aggregate ID must belong to
VLAN A (tagged or default VLAN).

Examples
-> policy action rp01 redirect linkagg 10
-> policy action rp01 no redirect linkagg

page 33-156 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy action redirect linkagg

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy action Creates a policy action.
show policy action Displays information about policy actions.

MIB Objects
alaQoSActionTable
alaQoSActionName
alaQoSActionRedirectAgg
alaQoSAppliedActionTable
alaQoSAppliedActionName
alaQoSAppliedActionRedirectAgg

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-157
policy action no-cache QoS Policy Commands

policy action no-cache

Disables logging of rule entries to the hardware cache.
policy action action_name no-cache
policy action action_name no no-cache

Syntax Definitions

action_name The name of the action.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove no cache from the policy action.

• Recommended for use when applied to traffic going to the switch.

Examples
-> policy action nc01 no-cache
-> policy action nc01 no no-cache

Release History
Release 8.1.1; command introduced.

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy action Creates a policy action.
show policy action Displays information about policy actions.

MIB Objects
alaQoSActionTable
alaQoSActionName
alaQoSActionNocache
alaQoSAppliedActionTable
alaQoSAppliedActionName
alaQoSAppliedActionNocache

page 33-158 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands policy action mirror

policy action mirror

Mirrors ingress, egress, or both ingress and egress packets that match a mirroring policy to the specified
port.
policy action action_name [ingress | egress | ingress egress] mirror chassis/slot/port
policy action action_name no mirror chassis/slot/port

Syntax Definitions

action_name The name of the action.

ingress Mirrors ingress packets.
egress Mirrors egress packets.
ingress egress Mirrors ingress and egress packets.
chassis/slot/port The chassis ID, slot, and port number (3/1/1) for a specific port.

Defaults

parameter default
ingress | egress | ingress egress ingress

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove mirror from the policy action.

• Use this command to configure a mirror-to-port (MTP) action that is used for policy based mirroring.

• Only one MTP session is supported at any given time. As a result, all mirroring policies should specify
the same MTP port.
• Policy based mirroring and the port based mirroring feature can run simultaneously on the same
switch.

Examples
-> policy action a1 mirror 1/1/7 (default ingress)
-> policy action a1 ingress mirror 1/1/7
-> policy action a1 egress mirror 1/1/7
-> policy action a1 ingress egress mirror 1/1/7
-> policy action a1 no mirror

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-159
policy action mirror QoS Policy Commands

Related Commands

qos apply Applies configured QoS and policy settings to the current configuration.
policy action Creates a policy action.
show policy action Displays information about policy actions.

MIB Objects
alaQoSActionTable
alaQoSActionName
alaQoSActionMirrorSlot
alaQosActionMirrorPort
alaQosActionMirrorMode
alaQosActionMirrorModeStatus

page 33-160 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands show policy network group

show policy network group

Displays information about pending and applied policy network groups.
show [applied] policy network group [network_group]

Syntax Definitions

applied Indicates that only network groups that have been applied should be
displayed.
network_group The name of the policy network group for which you want to display
information; or a wildcard sequence of characters for displaying
information about network groups with similar names. Use an asterisk
(*) to indicate a wildcard character.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Information for all policy network groups displays unless network_group is specified.

Examples
-> show policy network group
Group Name : netg1
State = new,
Entries = 198.206.10.1

-> show policy network group

Group Name : group1
Entries = 203.185.129.0 mask 255.255.255.0,
203.185.131.192 mask 255.255.255.192,
203.185.132.0 mask 255.255.252.0,
204.226.0.0 mask 255.255.0.0

output definitions
Group Name The name of the port group, configured through the policy network
group command.
State This field appears if the group was created or modified but not yet
applied to the QoS configuration. When the qos apply command is
issued, this field no longer displays.
Entries The IP addresses associated with the network group.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-161
show policy network group QoS Policy Commands

Related Commands

policy network group Configures policy network groups.

MIB Objects
alaQoSNetworkGroupsTable
alaNetworkGroupsName
alaNetworkGroupsSource
alaNetworkGroupTable
alaNetworkGroupIpAddr
alaQoSNetworkGroupIpMask

page 33-162 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands show policy service

show policy service

Displays information about pending and applied policy services.
show [applied] policy service [service_name]

Syntax Definitions

applied Indicates that only services that have been applied should be displayed.
service_name The name of the service for which you want to display information; or a
wildcard sequence of characters for displaying information about
services with similar names. Use an asterisk (*) to indicate a wildcard
character.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Information about all policy services is displayed unless service_name is specified.

Examples
-> show policy service
Service name : ps1
State = new,
Protocol = 6,
Source IP port = 4,
Destination IP port = 5

output definitions
Service Name The name of the port group, configured through the policy service
command.
State This field appears if the service was created or modified but not yet
applied to the QoS configuration. When the qos apply command is
issued, this field no longer displays.
Protocol The IP protocol associated with the service.
Source IP port A source port associated with the service.
Destination IP port A destination port associated with the service.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-163
show policy service QoS Policy Commands

Related Commands

policy service Configures a service that may be used as part of a policy service group.

MIB Objects
alaQoSServiceTable
alaQoSServiceName
alaQoSServiceSource
alaQoSServiceIpProtocol
alaQoSServiceSourceIpPort
alaQoSServiceDestinationIpPort
alaQoSAppliedServiceTable
alaQoSAppliedServiceName
alaQoSAppliedServiceSource
alaQoSAppliedServiceIpProtocol
alaQoSAppliedSourceIpPort
alaQoSAppliedServiceDestinationIpPort

page 33-164 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands show policy service group

show policy service group

Displays information about pending and applied policy service groups.
show [applied] policy service group [service_group]

Syntax Definitions

applied Indicates that only service groups that have been applied should be
displayed.
service_group The name of the service group for which you want to display
information; or a wildcard sequence of characters for displaying
information about service groups with similar names. Use an asterisk (*)
to indicate a wildcard character.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Information for all policy service groups displays unless service_group is specified.

Examples
-> show policy service group
Group Name : mgmt
State = new,
Entries = ftp,
http,
https,
snmp,
ssh,
telnet

output definitions
Group Name The name of the port group, configured through the policy service
group command.
State This field appears if the group was created or modified but not yet
applied to the QoS configuration. When the qos apply command is
issued, this field no longer displays.
Entries The services associated with the group. Services are configured through
the policy service command.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-165
show policy service group QoS Policy Commands

Related Commands

policy service group Configures a service group and its associated services. A service group
may be attached to a policy condition.

MIB Objects
alaQoSServiceGroupsTable
alaQoSServiceGroupsName
alaQoSServiceGroupsSource
alaQoSAppliedServiceGroupsTable
alaQoSAppliedServiceGroupsName
alaQoSAppliedServiceGroupsSource
alaQoSServiceGroupTable
alaQoSServiceGroupServiceName
alaQoSAppliedServiceGroupTable
alaQoSAppliedServiceGroupServiceName

page 33-166 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands show policy mac group

show policy mac group

Displays information about pending and applied MAC groups.
show [applied] policy mac group [mac_group]

Syntax Definitions

applied Indicates that only MAC groups that have been applied should be
displayed.
mac_group The name of the MAC group for which you want to display information;
or a wildcard sequence of characters for displaying information about
MAC groups with similar names. Use an asterisk (*) to indicate a
wildcard character.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Information for all policy MAC groups displays unless mac_group is specified.

Examples
-> show policy mac group
Group Name : mg1
State = new,
Entries = 00:02:9A:44:5E:10 mask 00:00:00:FF:FF:FF,
00:11:01:00:00:01 mask 00:00:00:FF:FF:FF
00:02:9A:44:5E:20

output definitions
Group Name The name of the port group, configured through the policy mac group
command.
State This field appears if the group was created or modified but not yet
applied to the QoS configuration. When the qos apply command is
issued, this field no longer displays.
Entries The MAC addresses associated with the group.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-167
show policy mac group QoS Policy Commands

Related Commands

policy mac group Configures policy MAC groups.

MIB Objects
alaQoSMACGroupsTable
alaQoSMACGroupsName
alaQoSMACGroupsSource
alaQoSAppliedMACGroupsTable
alaQoSAppliedMACGroupsName
alaQoSAppliedMACGroupsSource
alaQoSMACGroupTable
alaQoSMACGroupMacAddr
alaQoSMACGroupMacMask
alaQoSAppliedMACGroupTable
alaQoSAppliedMACGroupMacAddr
alaQoSAppliedMACGroupMacMask

page 33-168 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands show policy port group

show policy port group

Displays information about pending and applied policy port groups.
show [applied] policy port group [group_name]

Syntax Definitions

applied Indicates that only policy port groups that have been applied should be
displayed.
mac_group The name of the policy port group for which you want to display
information; or a wildcard sequence of characters for displaying
information about port groups with similar names. Use an asterisk (*) to
indicate a wildcard character.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Information for all policy port groups displays unless group_name is specified.

Examples
-> show policy port group
Group Name : pg1
State = new,
Entries = 1/2,
1/3,
1/4,
3/11

output definitions
Group Name The name of the port group, configured through the policy port group
command or built-in port groups automatically set up by the switch
(Slot01, Slot02, Slot03, etc.).
State This field appears if the group was created or modified but not yet
applied to the QoS configuration. When the qos apply command is
issued, this field no longer displays.
Entries The slot/port combinations associated with the port group.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-169
show policy port group QoS Policy Commands

Related Commands

policy port group Configures a port group and its associated slot and port numbers.

MIB Objects
alaQoSPortGroupsTable
alaQoSPortGroupsName
alaQoSPortGroupsSource
alaQoSAppliedPortGroupsTable
alaQoSAppliedPortGroupsName
alaQoSAppliedPortGroupsSource
alaPortGroupTable
alaQoSPortGroupSlot
alaQoSPortGroupPort
alaAppliedPortGroupTable
alaQoSAppliedPortGroupSlot
alaQoSAppliedPortGroupPort

page 33-170 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands show policy map group

show policy map group

Displays information about pending and applied policy map groups.
show [applied] policy map group [group_name]

Syntax Definitions

applied Indicates that only map groups that have been applied should be
displayed.
group_name The name of the policy map group for which you want to display
information; or a wildcard sequence of characters for displaying
information about map groups with similar names. Use an asterisk (*) to
indicate a wildcard character.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Information for all policy map groups displays unless group_name is specified.

Examples
-> show policy map group
Group Name : m1
State = new,
Entries = 0:0,
1:9,
2:18,
3:27,
4:36,
5:45,
6:54,
7:63

output definitions
Group Name The name of the map group, configured through the policy map group
command.
State This field appears if the group was created or modified but not yet
applied to the QoS configuration. When the qos apply command is
issued, this field no longer displays.
Entries The slot/port combinations associated with the port group.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-171
show policy map group QoS Policy Commands

Related Commands

policy mac group Configures a map group and its associated mappings for 802.1p, Type of
Service (ToS), or Differentiated Services Code Point (DSCP) values.

MIB Objects
alaQoSMapGroupsTable
alaQoSMapGroupsName
alaQoSMapGroupsSource
alaQoSAppliedMapGroupsTable
alaQoSAppliedMapGroupsName
alaQoSAppliedMapGroupsSource
alaQoSMapGroupTable
alaQoSMapGroupKey
alaQoSMapGroupKeyEnd
alaQoSMapGroupValue
alaQoSAppliedMapGroupTable
alaQoSAppliedMapGroupKey
alaQoSAppliedMapGroupKeyEnd
alaQoSAppliedMapGroupValue

page 33-172 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands show policy action

show policy action

Displays information about pending and applied policy actions configured on the switch.
show [applied] policy action [action_name]

Syntax Definitions

applied Indicates that only actions that have been applied should be displayed.
action_name The name of the action for which you want to display information; or a
wildcard sequence of characters for displaying information about
actions with similar names. Use an asterisk (*) to indicate a wildcard
character.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Information for all policy actions displays unless action_name is specified.

Examples
-> show policy action
Action name : a1
Commited Information Rate = 10.0M,
Commited Burst size = 5.00M,
Peak Information Rate = 20.0M,
Peak Burst size = 5.00M

Action name : a2
State = new,
Disposition = deny

Action name : a3
State = new,
Priority = 7,

-> show applied policy action

Action name : a1
Commited Information Rate = 10.0M,
Commited Burst size = 5.00M,
Peak Information Rate = 20.0M,
Peak Burst size = 5.00M

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-173
show policy action QoS Policy Commands

output definitions
Action Name The name of the action, configured through the policy action
command.
State This field appears if the action was created or modified but not yet
applied to the QoS configuration. When the qos apply command is
issued, this field no longer displays.
Policy Action Parameters Displays the configured policy action parameters.

Related Commands

policy action Creates a policy action. A QoS action is a particular set of bandwidth
and queue parameters that may be applied to a flow matching particular
QoS conditions.

MIB Objects
alaQoSActionTable
alaQoSActionName
alaQoSActionSource
alaQoSActionDisposition
alaQoSActionShared
alaQoSActionMinimumBandwidth
alaQoSActionMaximumBandwidth
alaQosActionMaximumDepth
alaQoSAppliedActionTable
alaQoSAppliedActionName
alaQoSAppliedActionSource
alaQoSAppliedActionDisposition
alaQoSAppliedActionShared
alaQoSAppliedActionMinimumBandwidth
alaQoSAppliedActionMaximumBandwidth
alaQoSAppliedActionMaximumDepth

page 33-174 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands show policy condition

show policy condition

Displays information about pending and applied policy conditions.
show [applied] policy condition [condition_name]

Syntax Definitions

applied Displays only conditions that have been applied.

condition_name The name of the condition for which you want to display information; or
a wildcard sequence of characters for displaying information about
conditions with similar names. Use an asterisk (*) to indicate a wildcard
character.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Information for all policy conditions displays unless condition_name is specified.

Examples
-> show policy condition
Condition name : c1
Source VLAN = 1001

Condition name : c2
State = new,
Source IP = 10.2.2.1,
Destination UDP port = 17

-> show applied policy condition

Condition name : app-mon1
App-Mon Application Group Name = grp1

Condition name : app-mon2

Source chassis = 1/1/11

Condition name : user-traffic1

Source chassis = 1/1/1

Condition name : user-traffic2

Source chassis = 2/1/1

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-175
show policy condition QoS Policy Commands

output definitions
Condition Name The name of the condition, configured through the policy condition
command.
State This field appears if the condition was created or modified but not yet
applied to the QoS configuration. When the qos apply command is
issued, this field no longer displays.
App-Mon Application Group Name of the application group to which the QoS policy condition
Name applies.

Release History
Release 8.1.1; command introduced.

Related Commands

policy condition Creates a policy condition. The condition determines what parameters
the switch uses to classify incoming flows.

MIB Objects
alaQoSConditionTable
alaQoSConditionName
alaQoSConditionSource
alaQoSConditionSourceSlot
alaQoSConditionSourcePort
alaQoSConditionSourcePortGroup
alaQoSConditionDestinationSlot
alaQoSConditionDestinationPort
alaQoSConditionDestinationPortGroup
alaQoSConditionSourceInterfaceType
alaQoSConditionDestinationInterfaceType
alaQoSConditionSourceMacAddr
alaQoSConditionSourceMacMask
alaQoSConditionSourceMacGroup
alaQoSConditionDestinationMacAddr
alaQoSConditionDestinationMacMask
alaQoSConditionDestinationMacGroup
alaQoSConditionSourceVlan
alaQoSConditionDestinationVlan
alaQoSCondition8021p
alaQoSConditionSourceIpAddr
alaQoSConditionSourceIpMask
alaQoSConditionSourceNetworkGroup
alaQoSConditionDestinationIpAddr
alaQoSConditionDestinationIpMask
alaQoSConditionDestinationNetworkGroup
alaQoSConditionMulticastIpAddr
alaQoSConditionMulticastIpMask
alaQoSConditionMulticastNetworkGroup
alaQoSConditionTos
alaQoSConditionDscp
alaQoSConditionTcpFlags
alaQoSConditionIpProtocol
alaQoSConditionSourceIpPort
alaQoSConditionDestinationIpPort

page 33-176 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands show policy condition

alaQoSConditionService
alaQoSConditionServiceGroup

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-177
show active policy rule QoS Policy Commands

show active policy rule

Displays details about applied policy rules that are active (enabled) on the switch, including per-port
statistics.
show active [multicast] policy rule [rule_name] [extended]

Syntax Definitions

multicast Displays active rules that apply to multicast traffic.

rule_name The name of the rule for which you want to display information; or a
wild card sequence of characters for displaying information about rules
with similar names. Use an asterisk (*) to indicate a wild card character.
extended Displays statistics for individual ports when the policy rule contains a
source port split-group condition.

Defaults
By default, information is displayed for all active rules.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the show policy rule command to display inactive as well as active policy rules.

• Information for all rules is displayed unless a rule_name is specified.

• Information for all rule types is displayed unless a keyword (bridged, routed, multicast) is specified.

• Applied rules may or may not be active on the switch. Applied rules are inactive if they have been
administratively disabled with the disable option of the policy rule command.
• When a source port split-group condition is used in a rate limiting policy rule, the rule is split into sub-
rules. One sub-rule is created for each member port of the split-group. Each sub-rule is assigned a
unique split rule ID. Use this command with the extended keyword option to display sub-rule details
and statistics for a policy rule that contains a split-group policy condition.

Examples
-> show active policy rule
Rule name : r1
Condition name = c1,
Action name = a1,
Packets = 4166772,
Bytes = 266665728

output definitions
Rule name The name of the policy rule, configured through the policy rule
command.
Condition name The name of the condition configured for this rule.

page 33-178 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands show active policy rule

output definitions (continued)

Action name The name of the action configured for this rule.
Packets The number of packets that match this rule.
Bytes The number of bytes that match this rule.

-> show active policy rule extended

Rule name : r1
Split Rule Id : 1,
Port = 1/1/2,
Packets = 31864846,
Bytes = 16314794432,
Green Packets = 33136,
Yellow Packets = 0,
Red Packets = 31831710,
Green Bytes = 16965632,
Yellow Bytes = 0,
Red Bytes = 16297828800
Rule name : r1
Split Rule Id : 2,
Port = 1/1/3,
Packets = 31864846,
Bytes = 16314794432,
Green Packets = 33136,
Yellow Packets = 0,
Red Packets = 31831710,
Green Bytes = 16965632,
Yellow Bytes = 0,
Red Bytes = 16297828800

output definitions
Rule name The name of the policy rule, configured through the policy rule
command.
Split Rule Id The ID number for the sub-rule. A rate limiting policy rule is split into
sub-rules when the rule contains a source port split-group condition.
Packets The number of packets that match this rule.
Bytes The number of bytes that match this rule.
Green Packets The number of packets marked green that match this rule.
Yellow Packets The number of packets marked yellow that match this rule.
Red Packets The number of packets marked red that match this rule.
Green Bytes The number of bytes marked green that match this rule.
Yellow Bytes The number of bytes marked yellow that match this rule.
Red Bytes The number of bytes marked red that match this rule.

Release History
Release 8.1.1; command introduced.
Release 8.2.1; extended parameter and related fields added.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-179
show active policy rule QoS Policy Commands

Related Commands

policy rule Configures a policy rule on the switch. A rule is made up of a condition
(for classifying incoming traffic) and an action (to be applied to
outgoing traffic).
policy condition source port Configures a source port split-group policy condition that is used in rate
split-group limiting policy rules.

MIB Objects
alaQoSRuleTable
alaQoSRuleName
alaQoSRuleEnabled
alaQoSRuleSource
alaQoSRulePrecedence
alaQoSRuleActive
alaQoSRuleReflexive
alaQosRuleLog
alaQosRuleTrapEvents
alaQosRuleSave
alaQoSRuleCondition
alaQoSRuleAction
alaQoSExtendedRuleTable
alaQoSRuleName,
alaQoSExtendedRuleSplitRuleID
alaQoSExtendedRuleChassis
alaQoSExtendedRuleSlot
alaQoSExtendedRulePort
alaQoSExtendedRulePacketCount
alaQoSExtendedRuleByteCount
alaQoSExtendedRuleGreenPacketCount
alaQoSExtendedRuleYellowPacketCount
alaQoSExtendedRuleRedPacketCount
alaQoSExtendedRuleGreenByteCount
alaQoSExtendedRuleYellowByteCount
alaQoSExtendedRuleRedByteCount

page 33-180 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands show policy rule

show policy rule

Displays information about pending and applied policy rules.
show [applied] [bridged | routed | multicast] policy rule [rule_name]

Syntax Definitions

applied Indicates that only policy rules that have been applied should be
displayed.
bridged Displays active rules that apply to bridged traffic.
routed Displays active rules that apply to routed traffic.
multicast Displays active rules that apply to multicast traffic.
rule_name The name of the rule for which you want to display information; or a
wildcard sequence of characters for displaying information about rules
with similar names. Use an asterisk (*) to indicate a wildcard character.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Information for all rules is displayed unless rule_name is specified.

• Information for all rule types is displayed unless a keyword (bridged, routed, multicast) is specified.

• Use the show active policy rule command to display only active rules that are currently being
enforced on the switch.

Examples
-> show policy rule
Rule name : r1
Condition name = c1,
Action name = a1

Rule name : r2
State = new,
Condition name = c2,
Action name = a1

Rule name : r3
State = new,
Condition name = c2,
Action name = a2

-> show applied policy rule

Rule name : r1

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-181
show policy rule QoS Policy Commands

Condition name = c1,

Action name = a1

output definitions
Rule name The name of the policy rule, configured through the policy rule
command.
State This field appears if the rule was created or modified but not yet
applied to the QoS configuration. When the qos apply command is
issued, this field no longer displays.
Condition name The name of the condition configured for this rule.
Action name The name of the action configured for this rule.

Release History
Release 8.1.1; command introduced.

Related Commands

policy rule Configures a policy rule on the switch. A rule is made up of a condition
(for classifying incoming traffic) and an action (to be applied to
outgoing traffic).

MIB Objects
alaQoSRuleTable
alaQoSRuleName
alaQoSRuleEnabled
alaQoSRuleSource
alaQoSRulePrecedence
alaQoSRuleActive
alaQoSRuleReflexive
alaQosRuleLog
alaQosRuleTrapEvents
alaQosRuleSave
alaQoSRuleCondition
alaQoSRuleAction

page 33-182 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands show policy validity period

show policy validity period

Displays information about policy validity periods.
show policy validity period [name]

Syntax Definitions

name The name of the validity period.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Information for all validity periods is displayed unless name is specified.

• Use the show policy rule command to display the validity period that is associated with a policy rule.

Examples
-> show policy validity-period
Validity period name = tuesday
State = new,
Days = tuesday

Validity period name = february

Months = february

-> show applied policy validity-period

Validity period name = february
Months = february

output definitions
Validity period name The name of the policy validity period, configured through the policy
validity period command.
State This field appears if the validity period was created or modified but not
yet applied to the QoS configuration. When the qos apply command is
issued, this field no longer displays.
Days The days of the week the validity period is active, configured through
the policy validity period command. If this field does not appear, then
the validity period is not restricted to specific days.
Months The months during which the validity period is active, configured
through the policy validity period command. If this field does not
appear, then the validity period is not restricted to specific months.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-183
show policy validity period QoS Policy Commands

output definitions
Hours The time of day the validity period begins and ends, configured through
the policy validity period command. If this field does not appear, then
the validity period is not restricted to a specific time.
Interval The date and time a validity period interval begins and ends, configured
through the policy validity period command. If this field does not
appear, then the validity period is not restricted to a specific date and
time interval.

Release History
Release 8.1.1; command introduced.

Related Commands

policy validity-period Configures a validity period that specifies days, times, and/or months
during which an associated policy rule is in effect.

MIB Objects
alaQoSValidityPeriodTable
alaQoSValidityPeriodName
alaQoSValidityPeriodSource
alaQoSValidityPeriodDays
alaQoSValidityPeriodDaysStatus
alaQoSValidityPeriodMonths
alaQoSValidityPeriodMonthsStatus
alaQoSValidityPeriodHour
alaQoSValidityPeriodHourStatus
alaQoSValidityPeriodEndHour
alaQoSValidityPeriodInterval
alaQoSValidityPeriodIntervalStatus
alaQoSValidityPeriodEndInterval
alaQoSAppliedValidityPeriodTable
alaQoSAppliedValidityPeriodName
alaQoSAppliedValidityPeriodSource
alaQoSAppliedValidityPeriodDays
alaQoSAppliedValidityPeriodDaysStatus
alaQoSAppliedValidityPeriodMonths
alaQoSAppliedValidityPeriodMonthsStatus
alaQoSAppliedValidityPeriodHour
alaQoSAppliedValidityPeriodHourStatus
alaQoSAppliedValidityPeriodEndHour
alaQoSAppliedValidityPeriodInterval
alaQoSAppliedValidityPeriodIntervalStatus
alaQoSAppliedValidityPeriodEndInterval

page 33-184 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands show active policy list

show active policy list

Displays information about applied policy lists that are active (enabled) on the switch.
show active policy list [list_name]

Syntax Definitions

list_name The name of the list for which you want to display information; or a
wildcard sequence of characters for displaying information about lists
with similar names. Use an asterisk (*) to indicate a wildcard character.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Information for all active rules is displayed unless a list_name is specified.

• Use the show policy list command to display inactive as well as active policy lists.

• Applied lists may or may not be active on the switch. Applied lists are inactive if they have been
administratively disabled with the disable option in the policy list command.
• The display may include any of the following characters:

character definition
+ Indicates that the policy list has been modified or has been
created since the last qos apply.
- Indicates the policy list is pending deletion.
# Indicates that the policy list differs between the pending/
applied lists.

Examples
-> show active policy list
Group Name From Type Enabled Entries

list1 cli unp Yes r1

r2

+list2 cli unp Yes r3

egress_list1 cli egress Yes r1

r2
r3

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-185
show active policy list QoS Policy Commands

output definitions
Group Name The name of the policy list. Configured through the policy list
command. A plus sign (+) preceding a policy list name indicates that
the list was modified or created since the last qos apply.
From Where the list originated.
Type The type of rule (unp or egress). Configured through the policy list
command. Note that the default policy list is not shown. Use the show
policy rule command to display rules that are members of the default
policy list.
Enabled Whether or not the rule is enabled. Configured through the policy list
command.
Entries The QoS policy rules that are grouped together in this policy list.
Configured through the policy list command.

Release History
Release 8.1.1; command introduced.

Related Commands

show policy list Displays information about pending and applied policy lists.
show policy rule Displays information about pending and applied policy rules

MIB Objects
alaQoSRuleGroupsTable
alaQoSRuleDefaultList
alaQoSRuleGroupsName
alaQosRuleGroupsSource
alaQosRuleGroupsType
alaQosRuleGroupsEnabled
alaQosRuleGroupsStatus
alaQosAppliedRuleGroupsTable
alaQosAppliedRuleGroupsName
alaQosAppliedRuleGroupsSource
alaQosAppliedGroupsType
alaQosAppliedGroupsEnabled
alaQosAppliedRuleGroupsStatus

page 33-186 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
QoS Policy Commands show policy list

show policy list

Displays information about pending and applied policy lists.
show [applied] policy list [list_name]

Syntax Definitions

applied Displays only those policy lists that have been applied to the switch
configuration.
list_name The name of the list for which you want to display information; or a
wildcard sequence of characters for displaying information about lists
with similar names. Use an asterisk (*) to indicate a wildcard character.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Information for all rules is displayed unless a list_name is specified.

• Use the show active policy list command to display only active policy lists that are currently enforced
on the switch.
• The display may include any of the following characters:

character definition
+ Indicates that the policy list has been modified or has been
created since the last qos apply.
- Indicates the policy list is pending deletion.
# Indicates that the policy list differs between the pending/
applied lists.

Examples
-> show policy list
Group Name From Type Enabled Entries
list1 cli unp Yes r1
r2

+list2 cli unp Yes r3

egress_list1 cli egress No r1

r2
r3

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 33-187
show policy list QoS Policy Commands

-> show applied policy list

Group Name From Type Enabled Entries
list1 cli unp Yes r1
r2

egress_list1 cli egress No r1

r2
r3

output definitions
Group Name The name of the policy list. Configured through the policy list
command. A plus sign (+) preceding a policy list name indicates that
the list was modified or created since the last qos apply.
From Where the list originated.
Type The type of rule (unp or egress). Configured through the policy list
command. Note that the default policy list is not shown. Use the show
policy rule command to display rules that are members of the default
policy list.
Enabled Whether or not the rule is enabled. Configured through the policy list
command.
Entries The QoS policy rules that are grouped together in this policy list.
Configured through the policy list command.

Release History
Release 8.1.1; command introduced.

Related Commands

show active policy list Displays only those policy lists that are currently being enforced on the
switch.
show policy rule Displays information about pending and applied policy rules

MIB Objects
alaQoSRuleGroupsTable
alaQoSRuleDefaultList
alaQoSRuleGroupsName
alaQosRuleGroupsSource
alaQosRuleGroupsType
alaQosRuleGroupsEnabled
alaQosRuleGroupsStatus
alaQosAppliedRuleGroupsTable
alaQosAppliedRuleGroupsName
alaQosAppliedRuleGroupsSource
alaQosAppliedGroupsType
alaQosAppliedGroupsEnabled
alaQosAppliedRuleGroupsStatus

page 33-188 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 34 Policy Server
Commands

This chapter describes CLI commands used for managing policies downloaded to the switch from an
attached LDAP server. Policy rules can be created on an attached server through the PolicyView GUI
application. Policy rules can also be created on the switch directly through CLI or SNMP commands. This
chapter describes commands related to managing LDAP policies only. See Chapter 32, “QoS Commands,”
for information about commands for creating and managing policies directly on the switch.
The policy commands are based on RFC 2251 and RFC 3060.
MIB information for policy server commands is as follows:
Filename: alcatelIND1policy.mib
Module: ALCATEL-IND1-POLICY-MIB
The policy server commands are summarized here:

policy server load

policy server flush
policy server
show policy server
show policy server long
show policy server statistics
show policy server rules
show policy server events

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 34-1
policy server load Policy Server Commands

policy server load

Downloads policies from a LDAP server. These policies are created through the PolicyView management
application.
policy server load

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Policies are downloaded to the switch from the directory server with the highest preference setting; this
server must be enabled and operational (able to bind).

Examples
-> policy server load

Release History
Release 8.1.1; command introduced.

Related Commands

policy server flush Removes all cached LDAP policy data from the switch.

MIB Objects
serverPolicyDecision

page 34-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Policy Server Commands policy server flush

policy server flush

Removes all cached LDAP policy data from the switch.
policy server flush

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use this command to remove LDAP policies. Policies configured through the CLI or SNMP are not
removed.

Examples
-> policy server flush

Release History
Release 8.1.1; command introduced.

Related Commands

policy server load Downloads policies from a LDAP server. These policies are created
through the PolicyView management application.

MIB Objects
serverPolicyDecision

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 34-3
policy server Policy Server Commands

policy server
Configures operational parameters for an LDAP-enabled directory server on which policies are stored.
policy server ip_address [port port_number] [admin-state {enable | disable}] [preference preference]
[user user_name password password] [searchbase search_string] [ssl | no ssl]
no policy server ip_address [port port_number]

Syntax Definitions

ip_address The IP address of the LDAP-enabled directory server.

port_number The TCP/IP port number used by the switch to connect to the directory
server.
enable Enables the specified policy server to download rules to the switch.The
policy servers are up by default.
disable Prevents the specified policy server from downloading rules to the
switch.
preference Determines which directory server is used for policy downloads when
multiple servers are configured. The range is 0–255. The server with the
highest value is used as the policy server. If that server becomes unavail-
able, the server with the next highest preference value is used for policy
downloads.
user_name The user name for accessing the database entries on the directory server.
When spaces are used in the user name, quotation marks must be
included: (e.g. “Directory Manager”).
password The password associated with the user name. The password must match
the password defined on the directory server.
search_string The root of the directory required for searching the policy information.
Typically, the search_string includes o=organization and c=country. For
example, o=company and c=country.
ssl Enables a Secure Socket Layer between the switch and the policy server.
no ssl Disables a Secure Socket Layer between the switch and the policy
server.

page 34-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Policy Server Commands policy server

Defaults

parameter default
admin up
port_number 389 (SSL disabled)
636 (SSL enabled)
preference 0
ssl | no ssl no ssl

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If you change the port number, another entry is added to the policy server table; the existing port number
is not changed. To remove a port number, use the no form of this command with the relevant policy server
IP address and the port number you want to remove.

Examples
-> policy server 222.22.22.2 port 345 user dirmgr password secret88 searchbase
ou=qos,o=company,c=country

Release History
Release 8.1.1; command introduced.

Related Commands

show policy server Displays information about policies downloaded from an LDAP server.

MIB Objects
directoryServerTable
directoryServerAddress
directoryServerPort
directoryServerAdminStatus
directoryServerPreference
directoryServerUserId
directoryServerAuthenticationType
directoryServerPassword
directoryServerSearchbase
directoryServerEnableSSL

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 34-5
show policy server Policy Server Commands

show policy server

Displays information about servers from which policies can be downloaded to the switch.
show policy server

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays basic information about policy servers. Use the show policy server long
command to display more details about the servers.

Examples
-> show policy server

Server IP Address port enabled status primary

------+--------------+-----+---------+--------+--------
1 208.19.33.112 389 Yes Up X
2 208.19.33.66 400 No Down -

output definitions
Server The index number corresponding to the LDAP server.
IP Address The IP address of the LDAP server.
port The TCP/IP port number used by the switch to connect to the policy
server.
enabled Whether or not the policy server is enabled.
status The state of the policy server, Unkn, Up or Down.
primary Indicates whether the server is the primary server; this server can be
used for the next download of policies; only one server is a primary
server.

Release History
Release 8.1.1; command introduced.

page 34-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Policy Server Commands show policy server

Related Commands

policy server Configures operational parameters for an LDAP-enabled directory

server on which policies are stored.

MIB Objects
directoryServerTable
directoryServerAddress
directoryServerPort
directoryServerAdminState

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 34-7
show policy server long Policy Server Commands

show policy server long

Displays more detailed information about an LDAP policy server.
show policy server long

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays detailed information about policy servers. Use the show policy server command
to display basic information about policy servers.

Examples
-> show policy server long
LDAP server 0
IP address : 155.132.44.98,
TCP port : 16652,
Enabled : Yes,
Operational status : Unkn,
Preference : 99,
Authentication : password,
SSL : Disabled,
login DN : cn=Directory Manager,
searchbase : ou:4.1, cn=policyRoot, o=company.fr
Last load time : 09/13/01 16:38:18
LDAP server 1
IP address : 155.132.48.27,,
TCP port : 21890,
Enabled : Yes,
Operational status : Unkn,
Preference : 50,
Authentication : password,
SSL : Disabled,
login DN : cn=Directory Manager,
searchbase : o=company.fr
Last load time : 00/00/00 00:00:00

output definitions
IP address The IP address of the policy server.
TCP port The TCP/IP port number used by the switch to connect to the policy
server.

page 34-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Policy Server Commands show policy server long

output definitions (continued)

Enabled Displays whether the policy server is enabled through the PolicyView
application.
Operational status The state of the policy server, Up or Down.
Preference Determines which directory server is used for policy downloads when
multiple servers are configured. The range is 0–255. The server with
the highest value is used as the policy server. If that server becomes
unavailable, the server with the next highest preference value is used
for policy downloads.
Authentication Displays password if a user name and password was specified for the
server through the policy server command. Displays anonymous if a
user name and password are not configured.
login DN The directory user name.
searchbase The searchbase name, which is the root of the directory that can be
searched for policy download information.
Last load time The date and time that policies were last downloaded. Values of zero
indicate that no policies have been downloaded.

Release History
Release 8.1.1; command introduced.

MIB Objects
directoryServerTable
directoryServerAddress
directoryServerPort
directoryServerPreference
directoryServerAuthenticationType
directoryServerSearchbase
directoryServerUserId
directoryServerPassword
directoryServerCacheChange
directoryServerLastChange
directoryServerAdminStatus
directoryServerOperStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 34-9
show policy server statistics Policy Server Commands

show policy server statistics

Displays statistics about policy directory servers.
show policy server statistics

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays statistics about server downloads. For information about server parameters, use
the show policy server command.

Examples
-> show policy server statistics
Server IP Address port accesses delta successes delta errors delta
------+--------------+-------+---------+-------+----------+-----+-------+------
1 155.132.44.98 16652 793 793 295 295 0 0
2 155.132.48.27 21890 0 0 0 0 0 0

output definitions
Server The index number corresponding to the server.
IP Address The IP address of the LDAP server.
port The TCP/IP port number used by the switch to connect to the policy
server.
accesses The number of times the server was polled by the switch to download
policies.
delta The change in the number of accesses since the last time the policy
server was accessed.
successes The number of times the server was polled by the switch to download
policies and the policies were successfully downloaded.
delta The change in the number of successful policy downloads since the last
time the policy server was accessed.
errors The number of errors returned by the server.
delta The change in the number of errors returned by the server since the last
time the policy server was accessed.

page 34-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Policy Server Commands show policy server statistics

Release History
Release 8.1.1; command introduced.

Related Commands

policy server Configures operational parameters for an LDAP-enabled directory

server on which policies are stored.

MIB Objects
policyStatsTable
policyStatsAddress
policyStatsServerPort
policyStatsAccessCount
policyStatsSuccessAccessCount
policyStatsNotFoundCount

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 34-11
show policy server rules Policy Server Commands

show policy server rules

Displays the names of policies originating from a directory server, that have been downloaded to the
switch.
show policy server rules

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays information about policies created on directory servers only. Chapter 32, “QoS
Commands,” for information about configuring and displaying policies directly on the switch.

Examples
-> show policy server rules
Num name prio scope status
---+-------------------+-------+-------------+------------
1 QoSRule1 0 Provisioned Active
2 QoSrule2 0 Provisioned Active
Fields are defined here:

output definitions
Num An index number corresponding to the policy rule.
name The name of the policy rule; only rules configured through PolicyView
are displayed in this table.
prio The priority or preference of the rule. Indicates the order in which rules
can be checked to match to the incoming traffic. If two or more rules
apply to the traffic, the rule with the highest preference is applied. Pref-
erence is determined when the rule is created.
scope The type of rule. Provisioned is the only type valid for the current
release.
status The status of the rule: Active indicates that the rule is available in the
QoS software on the switch and is available to be applied to the traffic;
notInService means the rule can be pushed to the QoS software in the
future but is not available yet (typically because of a variable validity
period); notReady indicates that the rule can never be pushed to the
QoS software because its validity period has expired or because it has
been disabled through SNMP.

page 34-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Policy Server Commands show policy server rules

Release History
Release 8.1.1; command introduced.

Related Commands

policy server load Downloads policies from a LDAP server. These policies are created
through the PolicyView management application.

MIB Objects
policyRuleNamesTable
policyRuleNamesIndex
policyRuleNamesName
policyRuleOperStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 34-13
show policy server events Policy Server Commands

show policy server events

Displays any events related to a directory server on which policies are stored.
show policy server events

Syntax Definitions

N/A

Defaults
The display is limited to 50 events.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The Policy Manager initialization event is always the first event logged.

Examples
-> show policy server events
Event Time event description
-----------------+-----------------------------------------------
09/13/01 16:38:15 Policy manager log init
09/13/01 16:38:17 LDAP server 155.132.44.98/16652 defined
09/13/01 16:38:17 LDAP server 155.132.44.98/21890 defined
09/13/01 16:38:18 PDP optimization: PVP day-of-week all 1
09/13/01 16:38:18 PDP optimization: PVP Month all 1
09/13/01 16:38:18 PDP optimization: PVP Month all 1
09/13/01 16:38:18 PDP optimization: PVP Month all 1
09/13/01 16:38:18 PDP optimization: PVP Month all 1
09/13/01 16:38:18 IP address and mask make bad address change on desination IP
address 155.132.44.98:155.132.44.101
:
output definitions
Event Time The date and time the policy event occurred.
event description A description of the event.

Release History
Release 8.1.1; command introduced.

page 34-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Policy Server Commands show policy server events

Related Commands

policy server Configures operational parameters for an LDAP-enabled directory

server on which policies are stored.

MIB Objects
policyEventTable
policyEventCode
policyEventDetailString
policyEventIndex
policyEventTime

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 34-15
show policy server events Policy Server Commands

page 34-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 35 AAA Commands

This chapter includes descriptions for authentication, authorization, and accounting (AAA) commands.
The commands are used for configuring the type of authentication as well as the AAA servers and the
local user database on the switch.
• Authenticated switch access—Authenticates user sessions into the switch to manage the switch. User
information is stored on a RADIUS, TACACS+, or LDAP server or information may be stored locally
in the switch user database.
• Access Guardian device authentication—Provides authentication and accounting functions to provide
port-based network access control. The OmniSwitch serves as the authenticator for 802.1X, MAC, and
Captive Portal device authentication sessions.
• Local user database—User information may be configured for authenticated switch access. For
functional management access, users may be allowed to access specific command families or domains.
MIB information for the AAA commands is as follows:
Filename: alcatelIND1AAA.mib
Module: ALCATEL-IND1-AAA-MIB
A summary of the available commands is listed here:

Authentication servers aaa radius-server

aaa tacacs+-server
aaa ldap-server
aaa test-radius-server
show aaa server
Authenticated switch access system fips admin-state
aaa authentication
aaa authentication default
aaa accounting session
aaa accounting command
show aaa authentication
show aaa accounting
show system fips

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-1
 AAA Commands

Port-based Network Access aaa device-authentication

Control (Access Guardian) aaa accounting
aaa accounting radius calling-station-id
aaa 802.1x re-authentication
aaa interim-interval
aaa session-timeout
aaa inactivity-logout
aaa radius nas-port-id
aaa radius nas-identifier
aaa radius mac-format
aaa profile
show aaa device-authentication
show aaa accounting
show aaa config
show aaa radius config
show aaa profile
Local User Database and user
Partitioned Management password
user password-size min
user password-expiration
show user
show aaa priv hexa
Password Policy user password-policy cannot-contain-username
user password-policy min-uppercase
user password-policy min-lowercase
user password-policy min-digit
user password-policy min-nonalpha
user password-history
user password-size min
user password-min-age
user password-expiration
show user
show user password-policy
User Lockout Settings user lockout-window
user lockout-threshold
user lockout-duration
user lockout unlock
show user
show user lockout-setting

page 35-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa radius-server

aaa radius-server
Configures a RADIUS server for authenticated switch access and device authentication.
aaa radius-server server {host {hostname | ip_address} [hostname2 | ip_address2]} {key secret | hash-
key hash_secret} [retransmit retries] [timeout seconds] [auth-port auth_port] [acct-port acct_port]
[vrf-name vrf_name]
no aaa radius-server server

Syntax Definitions

server The name of the RADIUS server.

hostname The host name (DNS name) of the primary RADIUS server. The host
name or IP address is required when creating a server.
ip_address The IP address of the primary RADIUS server. An IP address or host
name is required when creating a server.
hostname2 The host name (DNS name) of an optional backup RADIUS server.
ip_address2 The IP address of an optional backup RADIUS server.
secret A shared secret (key) known only to the switch and the server; this value
is not sent over the network. Can specify any text or hexadecimal string
but MUST match the secret configured on the server. The secret is case-
sensitive. Required when creating a server.
hash_secret A shared secret that the switch saves with a hashing algorithm.
retries The number of retries the switch makes to authenticate a user before try-
ing the backup server (hostname2 or ip_address2).
seconds The timeout for server replies to authentication requests.
auth_port The UDP destination port for authentication requests.
acct_port The UDP destination port for accounting requests.
vrf_name The name of the VRF to be used to access the server.

Defaults

parameter default
retries 3
seconds 2
auth_port 1812
acct_port 1813
vrf_name default

Platforms Supported
OmniSwitch 6860, 6860E

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-3
aaa radius-server AAA Commands

Usage Guidelines
• Use the no form of the command to remove a RADIUS server from the configuration. Only one server
can be deleted at a time.
• A host name (or IP address) and a secret (key or hash-key) are required when configuring a server.

• The server and the backup servers must all be RADIUS servers.

• RADIUS server can be configured on any VRF instance or the default VRF instance. However, all the
RADIUS servers must reside on the same VRF instance.

Examples
-> aaa radius-server pubs2 host 10.10.2.1 key wwwtoe timeout 5
-> no aaa radius-server pubs2

-> aaa radius-server radsrv1 host rad1_ipaddr key rad1_secret vrf-name rad_vrf

Release History
Release 8.1.1; command was introduced.

Related Commands

show aaa server Displays the AAA server configuration for the switch.
aaa authentication Configures the interface for authenticated switch access and
specifies the servers to be used.
aaa accounting session Specifies the accounting servers to be used for authenticated
switch access.
aaa device-authentication Enables or disables the switch for MAC, 802.1X, or Captive Portal
authentication and specifies the servers to be used.

MIB Objects
aaaServerTable
aaasProtocol
aaasHostName
aaasIpAddress
aaasHostName2
aaasIpAddress2
aaasRadKey
aaasRadKeyHash
aaasRetries
aaasTimout
aaasRadAuthPort
aaasRadAcctPort
aaasVrfName

page 35-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa tacacs+-server

aaa tacacs+-server
Configures a TACACS+ server for authenticated switch access.
aaa tacacs+-server server {host {hostname | ip_address} [hostname2 | ip_address2]} {key secret | hash-
key hash_secret} [timeout seconds] [port port] [vrf-name vrf_name]
no aaa tacacs+-server server

Syntax Definitions

server The name of the TACACS+ server.

hostname The host name (DNS name) of the primary TACACS+ server. The host
name or IP address is required when creating a server.
ip_address The IP address of the primary TACACS+ server. An IP address or host
name is required when creating a server.
hostname2 The host name (DNS name) of an optional backup TACACS+ server.
ip_address2 The IP address of an optional backup TACACS+ server.
secret The shared secret known to the switch and the server, but which is not
sent over the network. Can be any text or hexadecimal string but MUST
match the secret configured on the server. The secret is case-sensitive.
required when creating a server.
hash_secret A shared secret that the switch saves with a hashing algorithm.
seconds The timeout for server replies to authentication requests.
port The port number for the primary TACACS+ server.
vrf_name The name of the VRF to be used to access the server.

Defaults

parameter default
seconds 2
port 49
vrf_name default

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a TACACS+ server from the configuration. Only one
server may be deleted at a time.
• A host name (or IP address) and a secret are required when configuring a server.

• The server and the backup server must both be TACACS+ servers.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-5
aaa tacacs+-server AAA Commands

• A TACACS+ server can be configured on any VRF instance or the default VRF instance. However, all
the TACACS+ servers must reside on the same VRF instance.

Examples
-> aaa tacacs+-server tpub host 10.10.2.2 key otna timeout 10
-> no aaa tacacs+-server tpub
-> aaa tacacs+-server tacsrv1 host tac1_ipaddr key tac1_secret vrf-name tac_vrf

Release History
Release 8.1.1; command was introduced.

Related Commands

show aaa server Displays the AAA server configuration for the switch.
aaa authentication Configures the interface for authenticated switch access and
specifies the servers to be used.
aaa accounting session Specifies the accounting servers to be used for authenticated
switch access.
aaa device-authentication Configures which authentication servers to use for MAC, 802.1X,
or Captive Portal device authentication.

MIB Objects
aaaServerTable
aaasName
aaasProtocol
aaasHostName
aaasIpAddress
aaasHostName2
aaasIpAddress2
aaasTacacsKey
aaasTacacsKeyHas
aaasTimout
aaasTacacsPort
aaasVrfName

page 35-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa ldap-server

aaa ldap-server
Configures an LDAP server for authenticated switch access.
aaa ldap-server server_name {host {hostname | ip_address} [hostname2 | ip_address2]} {dn dn_name}
{password super_password | hash-key hash_password} {base search_base} [retransmit retries] [time-
out seconds] [ssl | no ssl] [port port] [vrf-name vrf_name]
no aaa ldap-server server-name

Syntax Definitions

server_name The name of the LDAP server.

hostname The host name (DNS) of the primary LDAP server. The host name or IP
address is required when creating a new server.
ip_address The IP address of the primary LDAP server.
hostname2 The host name (DNS) of the backup LDAP server.
ip_address2 The IP address of a backup host for the LDAP server.
dn_name The super-user or administrative distinguished name in a format that is
recognized by the LDAP-enabled directory servers. For example,
cn=manager. Must be different from the search-base name and must be
in a format supported by the server. Required when creating a new
server.
super_password The super-user password recognized by the LDAP-enabled directory
servers. The password may be clear text or hexadecimal format.
Required when creating a new server.
hash_password A super-user password that the switch saves with a hashing algorithm.
search_base The search base recognized by the LDAP-enabled directory servers. For
example, o=company or c=country. Must be different from the
dn_name. Required when creating a new server.
retries The number of retries the switch makes to the LDAP server to authenti-
cate a user before trying the backup server.
seconds The timeout in seconds for server replies to authentication requests from
the switch.
ssl Enables a secure switch layer (SSL) between the switch and the LDAP
server.
no ssl Disables a secure switch layer (SSL) between the switch and the LDAP
server.
port The port number for the primary LDAP server and any backup server.
Must match the port number configured on the server.
vrf_name The name of the VRF to be used to access the server.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-7
aaa ldap-server AAA Commands

Defaults
Defaults for optional parameters are as follows:

parameter default
port 389 (SSL disabled)
636 (SSL enabled)
retries 3
seconds 2
ssl | no ssl no ssl
vrf_name default

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove an LDAP server from the configuration. Only one server
may be removed at a time.
• The dn_name must be different from the search_base name.

• The port number configured on the switch must match the port number configured for the server.

• LDAP server can be configured on any VRF instance or the default VRF instance. However, all the
LDAP servers must reside on the same VRF instance.

Examples
-> aaa ldap-server topanga5 host 10.10.3.4 dn cn=manager password tpub base c=us
retransmit 4
-> aaa ldap-server omnivista host 1.2.3.4 dn "cn=DirMgr, o=alcatel.com" password
somepass base "ou=People, o=alcatel.com" vrf-name ldap_vrf
-> no aaa ldap-server topanga5

Release History
Release 8.1.1; command was introduced.

Related Commands

show aaa server Displays the AAA server configuration for the switch.
aaa authentication Configures the interface for authenticated switch access and
specifies the servers to be used.
aaa accounting session Specifies the accounting servers to be used for authenticated
switch access.
aaa device-authentication Configures which authentication servers to use for MAC, 802.1X,
or Captive Portal device authentication.

page 35-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa ldap-server

MIB Objects
aaaServerTable
aaasProtocol
aaasHostName
aaasIpAddress
aaasHostName2
aaasIpAddress2
aaasLdapPort
aaasLdapDn
aaasLdapPasswd
aaasLdapPasswdHash
aaasLdapSearchBase
aaasLdapServType
aaasRetries
aaasTimeout
aaasLdapEnableSsl
aaasVrfName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-9
aaa test-radius-server AAA Commands

aaa test-radius-server
RADIUS test tool allows the user to test the RADIUS server reachability from the OmniSwitch. Use this
command to start the authentication or accounting test for the specified user name and password.
aaa test-radius-server server-name type {authentication user user-name password password [method
{md5 | pap}] | accounting user user-name}

Syntax Definitions

server_name RADIUS server name for which test has been configured.
authentication | accounting Type of test to run.
user-name User name configured on the server.
password Password for the given user name.
md5|pap Authentication method for the test.

Defaults
By default, MD5 is used as the authentication method.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• RADIUS server must be configured on the switch to test the tool.

• The switch must have the following RADIUS server configuration before starting the test tool:
RADIUS server name, acct-port, auth-port, secret key, retransmit count, and timeout. See the aaa
radius-server command for more information on RADIUS server configuration.
• Supports multiple sessions (console, telnet, SSH) to test multiple RADIUS servers.

• The CLI of the user session (console, telnet, SSH) goes in the blocking state when the test is started. In
the blocking state, no other command (CLI) is accepted. The blocking state of the CLI prompt of the
switch can be terminated by pressing any key.
• Two IP addresses are configurable for a RADIUS server. When the test starts, the requests are sent to
the first address. When all the requests to the first address time out, then the requests are sent to the
second address.

Examples
-> aaa test-radius-server rad1 type authentication user admin password switch
method MD5
-> aaa test-radius-server rad2 type authentication user admin password switch
method pap
-> aaa test-radius-server rad1 type accounting user admin

page 35-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa test-radius-server

Release History
Release 8.1.1; command introduced.

Related Commands

aaa authentication servers for authenticated switch access.

show aaa server Displays information about AAA servers configured for the switch.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-11
system fips admin-state AAA Commands

system fips admin-state

Enable or disable the FIPS mode on the switch.
system fips admin-state {enable | disable}

Syntax Definitions

enable | disable Enables or disable FIPS mode.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• FIPS mode is disabled by default.

• Enabling or disabling FIPS mode takes effect only after a switch reboot. The FIPS mode configuration
is persistent across reboots.
• When FIPS mode is disabled, all other existing cryptographic algorithms will be supported.

• A FIPS supported client is required to access the switch in FIPS enabled mode. For example, Absolute
Telnet.
• Other unsecured management interfaces, such as Telnet or FTP, have to be manually disabled after
FIPS mode is enabled to achieve a completely secure device.

Examples
-> system fips admin-state enable
-> system fips admin-state disable

Release History
Release 8.1.1; command introduced.

Related Commands

show system fips Show the Configured and Running status of the FIPS mode on the
Switch.

MIB Objects
systemFipsAdminState

page 35-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa authentication

aaa authentication
Configures the interface for authenticated switch access and specifies the server(s) to be used. This type of
authentication gives users access to manage the switch.
aaa authentication {console | telnet | ftp | http | snmp | ssh | default} server1 [server2...] [local]
no aaa authentication [console | telnet | ftp | http | snmp | ssh | default]

Syntax Definitions

console Configures authenticated switch access through the console port.

telnet Configures authenticated switch access for any port used for Telnet.
ftp Configures authenticated switch access for any port used for FTP.
http Configures authenticated switch access for any port used for Web-based
management.
snmp Configures authenticated switch access for any port used for SNMP.
ssh Configures authenticated switch access for any port used for Secure
Shell.
default Configures authenticated switch access for any port using any service
(telnet, ftp, etc.). Note that SNMP access is enabled only if an LDAP or
local server is specified with the command.
server1 The name of the authentication server used for authenticated switch
access. At least one server is required. The server may be a RADIUS,
TACACS+, LDAP, or the local user database. RADIUS, TACACS+,
and LDAP server names are set up through the aaa radius-server, aaa
tacacs+-server, and aaa ldap-server commands.
server2... The names of backup servers for authenticated switch access. Up to 3
backups may be specified (including local). These backups are only
used if server1 becomes unavailable. They are polled in the order they
are listed in this command. The first available server becomes the
authentication server.
local Specifies that the local user database will be a backup for the authentica-
tion servers. If you want to use the local user database as the only
authentication server, specify local for server1.

Defaults
• At switch startup, authenticated switch access is available through console port via the local database.
Authentication for other management interfaces (Telnet, FTP, etc.) is disabled.
• The default user on the switch is admin, and switch is the password.

Platforms Supported
OmniSwitch 6860, 6860E

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-13
aaa authentication AAA Commands

Usage Guidelines
• The server type may be RADIUS, TACACS+, LDAP, or the local user database. Up to 4 servers may
be configured for an interface type; at least one is required. Each server name should be separated by a
space.
• The switch uses only the first available server in the list to check for user information. For example, if
server1 is not available, the switch will poll server2. If user information is not found on the first
available server, the authentication request will fail.
• RADIUS, TACACS+, and LDAP servers may each have an additional backup specified through the
aaa radius-server, aaa tacacs+-server, and aaa ldap-server commands.
• If the local switch database will be used as the only authentication server, specify local for server1. If
local is specified as a backup server, it should be entered last in the list of servers. The local user
database is always available if the switch is up.
• Only LDAP or the local database may be used for authenticated SNMP management.

• If Secure Shell (ssh) is enabled, Telnet and FTP should be disabled.

Examples
-> aaa authentication telnet pubs1
-> no aaa authentication telnet
-> aaa authentication default pubs2 pubs3

Release History
Release 8.1.1; command was introduced.

Related Commands

aaa radius-server Configures or modifies a RADIUS server for authenticated switch

access.
aaa ldap-server Configures or modifies an LDAP server for authenticated switch access.
user Configures user information for the local database on the switch.
show aaa server Displays the AAA authentication server configuration.

MIB Objects
aaaAuthSATable
aaatsInterface
aaasName
aaatsName1
aaatsName2
aaatsName3
aaatsName4

page 35-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa authentication default

aaa authentication default

Sets the authenticated switch access type to the default server setting.
aaa authentication {console | telnet | ftp | http | snmp | ssh} default

Syntax Definitions

console Configures the default authenticated switch access server setting for the
console port.
telnet Configures the default authenticated switch access server setting for Tel-
net.
ftp Configures the default authenticated switch access server setting for
FTP.
http Configures the default authenticated switch access server setting for
Web-based management.
snmp Configures the default authenticated switch access server setting for any
port used for SNMP.
ssh Configures the default authenticated switch access server setting for any
port used for Secure Shell.

Defaults
By default, the default authenticated switch access server setting does not include any servers.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the aaa authentication command to set the default servers.

Examples
-> aaa authentication telnet default
-> aaa authentication default default

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-15
aaa authentication default AAA Commands

Related Commands

aaa radius-server Configures or modifies a RADIUS server for authenticated switch

access.
aaa tacacs+-server Configures or modifies an LDAP server for authenticated switch access.
user Configures user information for the local database on the switch.
show aaa server Displays the AAA authentication server configuration.

MIB Objects
aaaAuthSATable
aaatsName1
aaatsName2
aaatsName3
aaatsName4

page 35-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa accounting session

aaa accounting session

Configures an accounting server or servers for authenticated switch access sessions. Accounting servers
keep track of network resources (time, packets, bytes, etc.) and user activity.
aaa accounting session server1 [server2...] [local]
no accounting session

Syntax Definitions

server1 The name of the RADIUS, TACACS+, or LDAP server used for
accounting of authenticated switch sessions. At least one server is
required. RADIUS, TACACS+, and LDAP server names are set up
through the aaa radius-server, aaa tacacs+-server, and aaa ldap-
server commands.
server2... The names of backup servers. Up to 3 backups may be specified (includ-
ing local); each server name should be separated by a space. These
backups are only used if server1 becomes unavailable. They are polled
in the order they are listed in this command. The first available server
becomes the accounting server.
local Local accounting is done through the Switching Logging feature on the
switch.

Defaults
Accounting is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to disable accounting for authenticated switch access.

• Up to 4 accounting servers (total) may be specified. At least one server is required. Each server name
should be separated by a space.
• The servers may be RADIUS, TACACS+, LDAP servers, and/or the local Switch Logging facility.

• If local is specified as server1, the switch will only use the local Switching Logging facility for
accounting.
• If local is specified as a backup, it should be entered last in the list of servers. The Switch Logging
facility is always available if the switch is up.
• The switch uses only the first available server in the list for accounting. For example, if server1 is not
available, the switch will use server2.
• RADIUS, TACACS+, and LDAP servers may each have an additional backup specified through the
aaa radius-server, aaa tacacs+-server, and aaa ldap-server commands.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-17
aaa accounting session AAA Commands

Examples
-> aaa accounting session ldap1 radius2 local
-> no aaa accounting session

Release History
Release 8.1.1; command was introduced.

Related Commands

show aaa accounting Displays the AAA accounting server configuration.

MIB Objects
aaaAcctsaTable
aaacsName1
aaacsName2
aaacsName3
aaacsName4

page 35-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa accounting command

aaa accounting command

Enables or disables command accounting with the specified TACACS+ server. Accounting servers keep
track of network resources (time, packets, bytes, etc.) and user activity.
aaa accounting command server1 [server2...] [local]
no accounting command

Syntax Definitions

server1 The name of the TACACS+ server used for command accounting. At
least one server is required. TACACS+ server names are set up through
the aaa tacacs+-server commands.
server2... The names of TACACS+ backup servers. Up to 3 backups may be spec-
ified; each server name should be separated by a space. These backups
are only used if server1 becomes unavailable. They are polled in the
order they are listed in this command. The first available server becomes
the accounting server.
local Local accounting is done through the Switching Logging feature on the
switch.

Defaults
Accounting is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to disable command accounting.

• Up to 4 accounting servers (total) may be specified. At least one server is required. Each server name
should be separated by a space.
• Command accounting is supported only with TACACS+ servers.

• The switch uses only the first available server in the list for accounting. For example, if server1 is not
available, the switch will use server2.
• TACACS+ server may each have an additional backup specified through the aaa tacacs+-server
command.

Examples
-> aaa accounting command tacacs1 tacacs2 tacacs3
-> no aaa accounting command

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-19
aaa accounting command AAA Commands

Related Commands

show aaa accounting Displays the AAA accounting server configuration.

MIB Objects
aaaAcctCmdTable
aaacmdSrvName1
aaacmdSrvName2
aaacmdSrvName3
aaacmdSrvName4

page 35-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa device-authentication

aaa device-authentication
Configures the switch to use RADIUS servers for 802.1X, MAC, or Captive Portal authentication.
aaa device-authentication {802.1x | mac | captive-portal} server1 [server2] [server3] [server4]
no device-authentication {802.1x | mac | captive-portal}

Syntax Definitions

802.1x Use the specified RADIUS server to authenticate 802.1X users.

mac Use the specified RADIUS server for MAC authentication.
captive-portal Use the specified RADIUS server for Captive Portal authentication.
server1 The name of the RADIUS authentication server to use for the specified
type of authentication. (Note that only RADIUS servers are supported
for these types of authentication.) At least one server is required.
RADIUS server names are configured through the aaa radius-server
command.
server2...server4 The names of backup servers used for authentication. Up to 3 backups
may be specified; include a space between each server name. These
backups are only used if server1 becomes unavailable. They are polled
in the order they are listed in this command. The first available server
becomes the authentication server.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a RADIUS server assignment for a specific authentication
type.
• Up to 4 RADIUS servers (total) may be specified for each type of authentication. At least one server is
required. Each server name should be separated by a space.
• The switch uses only the first available server in the list to check for user information. For example, if
server1 is not available, the switch will poll server2. If user information is not found on the first
available server, the authentication request will fail.
• RADIUS servers may each have an additional backup specified through the aaa radius-server
command.
• Configuring the RADIUS servers to use for 802.1X, MAC, and Captive Portal authentication is
required to support authentication and classification of devices connected to Universal Network Profile
(UNP) ports.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-21
aaa device-authentication AAA Commands

Examples
-> aaa device-authentication mac rad1 rad2
-> aaa device-authentication 802.1x serv1 serv2 serv3 serv4
-> aaa device-authentication captive-portal rad3 rad4
-> no aaa device-authentication mac
-> no aaa device-authentication 802.1x
-> no aaa device-authentication captive-portal

Release History
Release 8.1.1; command was introduced.

Related Commands

aaa radius-server Configures or modifies a RADIUS server for authenticated switch

access or device authentication.
show aaa device-authentication Displays a list of RADIUS servers assigned to provide 802.1X, MAC,
or Captive Portal authentication.

MIB Objects
aaaAuthDATable
aaadaInterface
aaadaName1
aaadaName2
aaadaName3
aaadaName4

page 35-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa accounting

aaa accounting
Configures RADIUS server accounting or local Switch Logging (syslog) accounting for 802.1X, MAC,
and Captive Portal authenticated device sessions. Accounting servers keep track of network resources
(time, packets, bytes, etc.) and user activity.
aaa accounting {802.1x | mac | captive-portal} {server1 [server2...] | syslog ip_address [port udp_port]}
no accounting {802.1x | mac | captive-portal}

Syntax Definitions

802.1x Enables the specified RADIUS or syslog server to log accounting of

802.1X authenticated sessions.
mac Enables the specified RADIUS or syslog server to log accounting for
MAC authenticated sessions.
captive-portal Enables the specified RADIUS or syslog server to log accounting for
Captive Portal authenticated sessions.
server1 The name of the RADIUS server used for accounting of authenticated
switch sessions. At least one server is required. RADIUS server names
are configured through the aaa radius-server command.
server2... The names of backup servers. Up to 3 backups may be specified; each
server name should be separated by a space. These backups are only
used if server1 becomes unavailable. They are polled in the order they
are listed in this command. The first available server becomes the
accounting server.
ip_address The IP network address for syslog accounting.
udp_port The UDP port number for syslog accounting.

Defaults
By default, no RADIUS server or syslog accounting is configured for the switch.

parameter default
udp_port 514

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to disable accounting for device authentication sessions.

• Up to 4 RADIUS accounting servers (total) may be specified. At least one server is required. Each
server name should be separated by a space.
• The switch uses only the first available server in the list for accounting. For example, if server1 is not
available, the switch will use server2.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-23
aaa accounting AAA Commands

• Accounting with the local syslog facility is not allowed if RADIUS accounting is already configured.
In other words, configure either RADIUS or syslog accounting.
• RADIUS servers may each have an additional backup specified through the aaa radius-server
command.

Examples
-> aaa accounting 802.1x rad1
-> aaa accounting 802.1x rad1 rad2 rad3 rad4
-> aaa accounting 802.1x syslog 10.135.67.99 port 8000
-> no aaa accounting 802.1x

-> aaa accounting mac rad1

-> aaa accounting mac rad1 rad2
-> aaa accounting mac syslog 10.135.67.99 port 8000
-> no aaa accounting mac

-> aaa accounting captive-portal rad1

-> aaa accounting captive-portal rad1 rad2 rad3
-> aaa accounting captive-portal syslog 10.135.67.99 port 8000
-> no aaa accounting captive-portal

Release History
Release 8.1.1; command was introduced.

Related Commands

show aaa accounting Displays the accounting server configuration for the switch.

MIB Objects
aaaAcctDATable
aaacdInterface
aaacdName1
aaacdName2
aaacdName3
aaacdName4
aaacdSyslogIPAddrType
aaacdSyslogIPAddr
aaacdSyslogUdpPort

page 35-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa accounting radius calling-station-id

aaa accounting radius calling-station-id

Configures the RADIUS Calling-Station-Id attribute for the specified accounting session type.
aaa accounting {802.1x | mac | captive-portal} radius calling-station-id {mac-address | ip-address}

Syntax Definitions

802.1x Configures the attribute for 802.1X accounting sessions.

mac Configures the attribute for MAC accounting sessions.
captive-portal Configures the attribute for Captive Portal accounting sessions.
mac-address Sets the Calling Station ID to the MAC address of the user.
ip-address Sets the Calling Station ID to the IP address of the user.

Defaults
By default, the RADIUS Calling -Station-Id attribute is set to the MAC address of the user.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Configuring the Calling-Station-ID attribute is not allowed if the accounting server configuration is set
to use local Switch Logging (syslog) for the specified accounting session type (802.1x, MAC, or
Captive Portal).
• The Calling Station ID attribute is defined in a RADIUS Accounting-Request message that is sent to
the RADIUS accounting server.

Examples
-> aaa accounting 802.1x radius calling-station-id ip-address
-> no aaa accounting 802.1x radius calling-station-id ip-address
-> aaa accounting 802.1x radius calling-station-id mac-address

-> aaa accounting mac radius calling-station-id ip-address

-> no aaa accounting mac radius calling-station-id ip-address
-> aaa accounting mac radius calling-station-id mac-address

-> aaa accounting captive-portal radius calling-station-id ip-address

-> no aaa accounting onex radius calling-station-id ip-address
-> aaa accounting captive-portal radius calling-station-id mac-address

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-25
aaa accounting radius calling-station-id AAA Commands

Related Commands

show aaa accounting Displays the AAA accounting configuration.

MIB Objects
aaaAcctDATable
aaacdInterface
aaacdCallngStationId

page 35-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa 802.1x re-authentication

aaa 802.1x re-authentication

Enables or disables the automatic re-authentication of authenticated 802.1X users.
aaa 802.1x re-authentication {enable | disable} [interval seconds] [trust-radius {enable | disable}]

Syntax Definitions

enable Enables re-authentication of 802.1X users.

disable Disables re-authentication of 802.1X users.
seconds The amount of time the switch waits before triggering re-authentication
of 802.1X users. The valid range is 600–7200 seconds.
trust-radius enable Directs the switch to use the Session-Timeout attribute value for the re-
authentication time interval. This attribute is returned from the RADIUS
server in an Accept-Accept message.
trust-radius disable Directs the switch to use the locally configured re-authentication time
interval value.

Defaults
By default, 802.1X re-authentication is disabled for the switch.

parameter default
seconds 3600
trust-radius enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The re-authentication time interval is triggered when 802.1X re-authentication is enabled.

• When the trust RADIUS option is enabled, the Session-Timeout attribute value received from the
RADIUS server overrides the locally configured value for the switch.
• When the re-authentication time interval is changed, the new value does not apply to existing
authenticated 802.1X users until the user is flushed out or when the user is authenticated again. Any
new 802.1X users are re-authenticated based on the current time interval setting.

Examples
-> aaa 802.1x re-authentication enable
-> aaa 802.1x re-authentication enable interval 7200
-> aaa 802.1x re-authentication enable trust-radius enable
-> aaa 802.1x re-authentication enable interval 7200 trust-radius enable
-> aaa 802.1x re-authentication enable interval 7200 trust-radius disable
-> aaa 802.1x re-authentication disable

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-27
aaa 802.1x re-authentication AAA Commands

Release History
Release 8.1.1; command was introduced.

Related Commands

show aaa config Displays the global AAA parameter configuration for 802.1X sessions.

MIB Objects
alaAaaAuthConfig
alaAaaOnexReAuthStatus
alaAaaOnexReAuthIntrvl
alaAaaOnexReAuthTrustRadStatus

page 35-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa interim-interval

aaa interim-interval
Configures the amount of time between each interim accounting update for any given session.
aaa {802.1x | mac | captive-portal} interim-interval seconds [trust-radius {enable | disable}]

Syntax Definitions

802.1x Configures the interim interval value for 802.1X accounting sessions.
mac Configures the interim interval value for MAC accounting sessions.
captive-portal Configures the interim interval value for Captive Portal accounting ses-
sions.
seconds The amount of time between each interim accounting update. The valid
range is 60–1200 seconds.
trust-radius enable Directs the switch to use the Acct-Interim-Interval attribute value for the
interim time interval. This attribute is returned from the RADIUS server
in an Accept-Accept message.
trust-radius disable Directs the switch to use the locally configured interim time interval
value.

Defaults
By default, the accounting interim interval value is set to 600 seconds.

parameter default
trust-radius enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When the trust RADIUS option is enabled, the accounting interim interval value received from the
RADIUS server overrides the locally configured value for the switch.
• When the accounting interim interval is changed, the new value does not apply to existing
authenticated users until the user is flushed out or when the user is authenticated again.

Examples
-> aaa 802.1x interim-interval 1200
-> aaa 802.1x interim-interval 1200 trust-radius enable
-> aaa 802.1x interim-interval 1200 trust-radius disable

-> aaa mac interim-interval 1200

-> aaa mac interim-interval 1200 trust-radius enable
-> aaa mac interim-interval 1200 trust-radius disable

-> aaa captive-portal interim-interval 1200

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-29
aaa interim-interval AAA Commands

-> aaa captive-portal interim-interval 1200 trust-radius enable

-> aaa captive-portal interim-interval 1200 trust-radius disable

Release History
Release 8.1.1; command was introduced.

Related Commands

show aaa config Displays the global AAA parameter configuration for device authentica-
tion and accounting sessions.

MIB Objects
alaAaaAuthConfig
alaAaaOnexIntrmIntrvl
alaAaaOnexIntmIntvlTrstRadSts
alaAaaMacIntrmIntrvl
alaAaaMacIntmIntvlTrstRadStatus
alaAaaCpIntrmIntrvl
alaAaaCpIntmIntvlTrstRadStatus

page 35-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa session-timeout

aaa session-timeout
Configures whether or not an authenticated user is automatically logged out of the network based on a
session timeout value.
aaa {mac | captive-portal} session-timeout {enable | disable} [interval seconds] [trust-radius {enable |
disable}]

Syntax Definitions

mac Configures the session timeout parameter for authenticated MAC users.
captive-portal Configures the session timeout parameter for authenticated Captive Por-
tal users.
enable Enables the session timeout timer for authenticated user sessions.
disable Disables the session timeout timer for authenticated user sessions.
seconds The session timeout value. The valid range is 12000–86400 seconds.
trust-radius enable Directs the switch to use the Session-Timeout attribute returned from
the RADIUS server in an Accept-Accept message.
trust-radius disable Directs the switch to use the locally configured timeout interval value.

Defaults
By default, the session timer is disabled for the switch.

parameter default
seconds 43200 seconds
(12 hours)
trust-radius enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The session timeout parameter is configurable only for MAC and Captive Portal authentication
sessions.
• The timeout interval is triggered when the session timeout parameter is enabled for the switch.

• When the trust RADIUS option is enabled, the timeout interval value received from the RADIUS
server overrides the locally configured value for the switch.
• When the session timeout interval is changed, the new value does not apply to existing authenticated
users until the user is flushed out or when the user is authenticated again.
• When the session timeout value is reached, the authenticated users are logged out and the MAC
address for each logged out user device is flushed.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-31
aaa session-timeout AAA Commands

Examples
-> aaa mac session-timeout enable interval 13000
-> aaa mac session-timeout enable interval 14000 trust-radius enable
-> aaa mac session-timeout disable

-> aaa captive-portal session-timeout enable interval 13000

-> aaa captive-portal session-timeout enable interval 14000 trust-radius enable
-> aaa captive-portal session-timeout disable

Release History
Release 8.1.1; command was introduced.

Related Commands

show aaa config Displays the global AAA parameter configuration for device authentica-
tion and accounting sessions.

MIB Objects
alaAaaAuthConfig
alaAaaMacSessTimeoutStatus
alaAaaMacSessTimeoutIntrvl
alaAaaMacSesTimeoutTrstRadStatus
alaAaaCpSessTimeoutStatus
alaAaaCpSessTimeoutIntrvl
alaAaaCpSsTmotTrstRadStatus

page 35-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa inactivity-logout

aaa inactivity-logout
Configures whether or not an authenticated user is automatically logged out of the network after a specific
period of inactivity.
aaa {mac | captive-portal} inactivity-logout {enable | disable} [interval seconds]

Syntax Definitions

mac Configures the inactivity logout timer for authenticated MAC users.
captive-portal Configures the inactivity logout timer for authenticated Captive Portal
users.
enable Enables the inactivity logout timer for the specified authentication type.
disable Disables the inactivity logout timer for the specified authentication type.
seconds The inactivity logout time. The valid range is 60–1200 seconds.

Defaults
By default, the inactivity logout timer is disabled for the switch.

parameter default
seconds MAC address aging time

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The inactivity logout timer is configurable only for MAC and Captive Portal authentication sessions.

• The timer is triggered when the inactivity logout parameter is enabled for the switch.

• Make sure the configured inactivity logout time is set to a value greater than the MAC address aging
time for the switch.
• If a specific time is configured for the inactivity logout timer, the user is not logged out of the network
if the MAC address aging time expires before the configured timer value.
• When the inactivity logout time is changed, the new value does not apply to existing authenticated
users until the user is flushed out or when the user is authenticated again.

Examples
-> aaa mac inactivity-logout enable
-> aaa mac inactivity-logout enable interval 600
-> aaa mac inactivity-logout disable

-> aaa captive-portal inactivity-logout enable

-> aaa captive-portal inactivity-logout enable interval 600
-> aaa captive-portal inactivity-logout disable

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-33
aaa inactivity-logout AAA Commands

Release History
Release 8.1.1; command was introduced.

Related Commands

show aaa config Displays the global AAA parameter configuration for device authentica-
tion and accounting sessions.

MIB Objects
alaAaaAuthConfig
alaAaaMacInActLogoutStatus
alaAaaMacInActLogoutIntrvl
alaAaaCpInActLogoutStatus
alaAaaCpInActLogoutIntrvl

page 35-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa radius nas-port-id

aaa radius nas-port-id

Configures the RADIUS client NAS-Port attribute for authentication and accounting sessions.
aaa radius nas-port-id {user-string string | default}

Syntax Definitions

string A text string (up to 31 characters) used to define a NAS-Port identifier

for the NAS-Port attribute.
default Sets the NAS-Port attribute value to the chassis/slot/port of the user.

Defaults
By default, the NAS-Port attribute is set to the user port (chassis/slot/port).

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The NAS-Port attribute value specified with this command is used in Account-Request messages and in
Accounting-Request messages.

Examples
-> aaa radius nas-port-id default
-> aaa radius nas-port-id user-string nasport

Release History
Release 8.1.1; command was introduced.

Related Commands

show aaa radius config Displays the global RADIUS client attribute configuration.

MIB Objects
alaAaaClientAttrGroup
alaAaaRadNasPortId

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-35
aaa radius nas-identifier AAA Commands

aaa radius nas-identifier

Configures the RADIUS client NAS-Identifier attribute for authentication and accounting sessions.
aaa radius nas-identifier {user-string string | default}

Syntax Definitions

string A text string (up to 31 characters) used to identify the switch (RADIUS
client) in the NAS-Identifier attribute.
default Sets the NAS-Identifier attribute to the system name of the switch.

Defaults
By default, the NAS-Identifier attribute is set to the system name of the switch.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The NAS-Identifier attribute value specified with this command is used in both Account-Request and
Accounting-Request messages.

Examples
-> aaa radius nas-identifier default
-> aaa radius nas-identifier user-string os6860

Release History
Release 8.1.1; command was introduced.

Related Commands

show aaa radius config Displays the global RADIUS client attribute configuration.

MIB Objects
alaAaaClientAttrGroup
alaAaaRadNasIdentifier

page 35-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa radius mac-format

aaa radius mac-format

Configures the MAC address format to use in the specified RADIUS client attributes.
aaa radius mac-format {username | password | calling-station-id | called-station-id} delimiter {char |
none} case {uppercase | lowercase}

Syntax Definitions

username Configures the MAC address format for the User-Name attribute.
password Configures the MAC address format for the User-Password attribute.
calling-station-id Configures the MAC address format for the Calling-Station-Id attribute.
called-station-id Configures the MAC address format for the Called-Station-Id attribute.
char The delimiter character to use to separate the octets within a MAC
address. The valid characters are a space (“ “), a hyphen (“-”), or a colon
(“:”). For example, “e8 e7 32 a4 63 23”, “e8-e7-32-a4-63-23”, or
“e8:e7:32:a4:63:23”.
none No delimiter is used in the MAC address format.
uppercase Uses uppercase characters in the MAC address format.
lowercase Uses lowercase characters in the MAC address format.

Defaults
By default, no delimiter is used and the MAC address characters are in uppercase.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The MAC address format configured for the User-Name and User-Password attributes is only applied
for MAC authentication and accounting, where these attributes are set to the MAC address of the user.
The configured format is not applied for 802.1X or Captive Portal authentication and accounting.
• The MAC address format configured for the Called-Station-Id and Calling-Station-Id attributes is
applied for MAC, 802.1X, and Captive Portal authentication and accounting sessions when these
attributes are set to a MAC address value.
• The Called-Station-Id attribute is set to the base MAC address of the switch.

• The Calling-Station-ID attribute is configurable and can be set to the MAC address or IP address of the
user.

Examples
-> aaa radius mac-format username delimiter none case lowercase
-> aaa radius mac-format username delimiter ":" case lowercase

-> aaa radius mac-format password delimiter none case lowercase

-> aaa radius mac-format password delimiter ":" case lowercase

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-37
aaa radius mac-format AAA Commands

-> aaa radius mac-format calling-station-id delimiter none case lowercase

-> aaa radius mac-format calling-station-id delimiter ":" case lowercase

-> aaa radius mac-format called-station-id delimiter none case lowercase

-> aaa radius mac-format called-station-id delimiter ":" case lowercase

Release History
Release 8.1.1; command was introduced.

Related Commands

aaa accounting radius calling- Sets the Calling-Station-Id attribute to the MAC address or IP address of
station-id the user for accounting sessions.
show aaa radius config Displays the global RADIUS client attribute configuration.

MIB Objects
alaAaaRadiusClientGlobalAttr
alaAaaRadiusUserNameDelimiter
alaAaaRadiusUserNameCase
alaAaaRadiusPasswordDelimiter
alaAaaRadiusPasswordCase
alaAaaRadCallnStnIdDelim
alaAaaRadiusCallingStationIdCase
alaAaaRadCalldStnIdDelim
alaAaaRadiusCalledStationIdCase

page 35-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa profile

aaa profile
Configures an AAA profile that is used to define and apply specific AAA parameter values to Universal
Network Profile (UNP) Edge ports, link aggregates, or an Access Guardian Captive Portal profile. This
section describes the base command (aaa profile profile_name) along with the other command keywords
that are used to configure AAA parameter values that are applied when the profile is assigned to a UNP
port or link aggregate.
aaa profile profile_name
[device-authentication {802.1x | mac | captive-portal} server1 [server2] [server3] [server4]]
[accounting {802.1x | mac | captive-portal} {server1 [server2...] | syslog ip_address
[port udp_port]}]
[accounting {802.1x | mac | captive-portal} radius calling-station-id {mac-address | ip-address}]
[802.1x re-authentication {enable | disable} [interval seconds] [trust-radius {enable | disable}]]
[{802.1x | mac | captive-portal} interim-interval seconds [trust-radius {enable | disable}]]
[{mac | captive-portal} session-timeout {enable | disable} [interval seconds] [trust-radius
{enable | disable}]]
[{mac | captive-portal} inactivity-logout {enable | disable} [interval seconds]]
[radius nas-port-id {user-string string | default}]
[radius nas-identifier {user-string string | default}]
[radius mac-format {username | password | calling-station-id | called-station-id} delimiter
{char | none} case {uppercase | lowercase}]
no aaa profile profile_name

Syntax Definitions

profile_name The name to associate with the AAA configuration profile.

Defaults
The AAA profile parameters are set to the same default values that are set when the explicit AAA
command is used to configure the parameter value. See the show aaa profile command output example in
the “Examples” section of this command page to determine default values for AAA profile parameters.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the AAA profile from the switch configuration.

• Creating the template name with the base command (aaa profile profile_name) is required before
attempting to configure profile parameter values.
• When an AAA profile is assigned to a UNP Edge port, the parameter values defined in the profile will
override any existing global AAA configuration for users authenticating on that port.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-39
aaa profile AAA Commands

• When an AAA profile is assigned to a Captive Portal profile, the parameters values defined in the AAA
profile will override any existing global AAA configuration for users authenticated through the Captive
Portal profile configuration.
• For more information about specific AAA parameter values, refer to the following explicit AAA
configuration commands for each profile parameter option:

AAA Profile Parameter Explicit Port Configuration Command

[device-authentication {802.1x | mac | captive-por- aaa device-authentication
tal} server1 [server2] [server3] [server4]]
[accounting {802.1x | mac | captive-portal} {server1 aaa accounting
[server2...] | syslog ip_address [port udp_port]}]
[accounting {802.1x | mac | captive-portal} radius aaa accounting radius calling-station-id
calling-station-id {mac-address | ip-address}]
[802.1x re-authentication {enable | disable} [inter- aaa 802.1x re-authentication
val seconds] [trust-radius {enable | disable}]]
[{802.1x | mac | captive-portal} interim-interval aaa interim-interval
seconds [trust-radius {enable | disable}]]
[{mac | captive-portal} session-timeout {enable | aaa session-timeout
disable} [interval seconds] [trust-radius {enable |
disable}]]
[{mac | captive-portal} inactivity-logout {enable | aaa inactivity-logout
disable} [interval seconds]]
[radius nas-port-id {user-string string | default}] aaa radius nas-port-id
[radius nas-identifier {user-string string | default}] aaa radius nas-identifier
[radius mac-format {username | password | calling- aaa radius mac-format
station-id | called-station-id} delimiter {char | none}
case {uppercase | lowercase}]

Examples
-> aaa profile prof1
-> no aaa profile prof1

-> aaa profile ap-1 device-authentication mac rad1 rad2

-> aaa profile ap-1 device-authentication 802.1x serv1 serv2 serv3 serv4
-> aaa profile ap-2 device-authentication captive-portal rad3 rad4
-> no aaa profile ap-2 device-authentication captive-portal

-> aaa profile ap-1 accounting 802.1x rad1 rad2 rad3

-> aaa profile ap-1 accounting mac rad1 rad2
-> aaa profile ap-1 accounting captive-portal syslog 10.135.67.99 port 8000
-> no aaa profile ap-1 accounting captive-portal

-> aaa profile ap-1 mac inactivity-logout enable

-> aaa profile ap-1 mac inactivity-logout enable interval 600
-> aaa profile ap-1 mac inactivity-logout disable

-> aaa profile ap-1 captive-portal inactivity-logout enable

-> aaa profile ap-1 captive-portal inactivity-logout enable interval 600
-> aaa profile ap-1 captive-portal inactivity-logout disable

page 35-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands aaa profile

The following show aaa profile command output example shows the default values applied when the
AAA profile is created:

-> show aaa profile ap-2

AAA profile name = ap-2

Authentication type = mac
Session Timeout:
Status = disable,
Interval (sec) = 43200,
Trust Radius = disable

Inactivity Timeout:
Status = disable,
Interval (sec) = 600

Accounting Interim:
Interval (sec) = 600,
Trust Radius = disable

Authentication type = 802.1x

Re-Authentication Timeout:
Status = disable,
Interval (sec) = 3600,
Trust Radius = disable

Accounting Interim:
Interval (sec) = 600,
Trust Radius = disable

Authentication type = captive-portal

Session Timeout:
Status = disable,
Interval (sec) = 43200,
Trust Radius = disable

Inactivity Timeout:
Status = disable,
Interval (sec) = 600

Accounting Interim:
Interval (sec) = 600,
Trust Radius = disable

RADIUS client attributes:

NAS port id = default,
NAS identifier = default,
MAC format delimiter:
Username = none, UserNameCase = uppercase,
Password = none, PasswordCase = uppercase,
calling station id = none, ClgStaIdCase = uppercase,
called station id = none, CldStaIdCase = uppercase

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-41
aaa profile AAA Commands

Related Commands

unp aaa-profile Assigns an AAA profile to a UNP Edge port.

captive-portal-profile Assigns an AAA profile to a Captive Portal profile.
show aaa profile Displays the AAA profile configuration.

MIB Objects
alaAaaProfTable
alaAaaProfOnexReAuthSts
alaAaaProfOnexReAuthIntrvl
alaAaaProfOnexReAuthTrstRadSts
alaAaaProfOnexIntrmIntrvl
alaAaaProfOnexIntmItvlTstRadSts
alaAaaProfMacIntrmIntrvl
alaAaaProfMacIntmItvlTrstRadSts
alaAaaProfMacSessTimeoutSts
alaAaaProfMacSessTimeoutIntrvl
alaAaaProfMacSessTmoutTrstRadSts
alaAaaProfMacInActLogoutSts
alaAaaProfMacInActLogoutIntrvl
alaAaaProfCpSessTimeoutSts
alaAaaProfCpSessTimeoutIntrvl
alaAaaProfCpSessTmotTrstRadSts
alaAaaProfCpInActLogoutSts
alaAaaProfCpInActLogoutIntrvl
alaAaaProfCpIntrmIntrvl
alaAaaProfCpItrmIntlTrstRadSts
alaAaaProfRadNasPortId
alaAaaProfRadNasIdentifier
alaAaaProfRadUserNameDelim
alaAaaProfRadPasswrdDelim
alaAaaProfRadCallnStnIdDelim
alaAaaProfRadCalldStnIdDelim
alaAaaProfRadUserNameCase
alaAaaProfRadPasswordCase
alaAaaProfRadCallnStnIdCase
alaAaaProfRadCalldStnIdCase

page 35-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands user

user
Configures or modifies user entries in the local user database. Use the no form of the command to remove
the user from the local database.
user username [password password] [expiration {day | date}] [read-only | read-write [families... |
domains...| all | none]] [no snmp | no auth | sha | md5 | sha+des | md5+des | sha+aes] [console-only
{enable | disable}]
no user username

Syntax Definitions

username The name of the user. Used for logging into the switch. Required to cre-
ate a new user entry or for modifying a user. Maximum 63 characters.
password The user’s password in clear text or hexadecimal (corresponding to
encrypted form). Required to create a new user entry. Maximum 47
characters.
day The number of days before this user’s current password expires. The
range is 1 to 150 days.
date The date (in the format mm/dd/yyyy hh:mm) that the user’s current pass-
word will expire.
read-only Specifies that the user will have read-only access to the switch.
read-write Specifies that the user will have read-write access to the switch.
families Determines the command families available to the user on the switch.
Each command family should be separated by a space. Command fami-
lies are subsets of domains.
domains Determines the command domains available to the user on the switch.
Each domain should be separated by a space.
all Specifies that all command families and domains are available to the
user.
none Specifies that no command families or domains are available to the user.
no snmp Denies the specified user SNMP access to the switch.
no auth Specifies that the user has SNMP access without any required SNMP
authentication and encryption protocol.
sha Specifies that the SHA authentication algorithm should be used for
authenticating SNMP PDU for the user.
md5 Specifies that the MD5 authentication algorithm should be used for
authenticating SNMP PDU for the user.
sha+des Specifies that the SHA authentication algorithm and DES encryption
standard should be used for authenticating and encrypting SNMP PDU
for the user.
md5+des Specifies that the MD5 authentication algorithm and the DES encryp-
tion standard should be used for authenticating and encrypting SNMP
PDU for the user.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-43
user AAA Commands

sha+aes Specifies that the SHA authentication algorithm and the AES encryption
standard should be used for authenticating and encrypting SNMP PDU
for the user.
console-only enable Enables console only access for the user admin.
console-only disable Disables console only access for the user admin.

Defaults
By default, if a user is created without indicating the read and write privileges and SNMP access, the user
will be given privileges based on the default user account. The default user account may be modified.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• At least one user with SHA/MD5 authentication and/or DES encryption must be configured on the
switch for SNMPv3 communication with OmniVista.
• Note that the exclamation point (!) is not a valid password character. In addition, specifying an asterisk
(*) as one or more characters in a password is allowed as long as every character is not an asterisk. For
example, password **123456** is allowed; password ******** is not allowed.
• A password expiration for the user’s current password may be configured with the expiration option.
However, if the password is changed, or the global password expiration setting is configured with the
user password-expiration command, the user’s password expiration will be configured with the
global expiration setting.
• When modifying a user’s SNMP access, the user password must be re-entered (or a new one
configured). This is required because the hash algorithm used to save the password in the switch
depends on the SNMP authentication level.
• At initial startup, the default user on the switch is admin with a password of switch. The switch will
not recreate this user at any successive startup as long as there exists at least one user defined with
write access to all commands. (Note that if password expiration is configured for the admin user, or
configured globally through the user password-expiration command, when the admin user’s
password expires, the admin user will have access only through the console port.)
• New users or updated user settings are saved automatically.

Examples
-> user techpubs password writer_pass read-only config
-> no user techpubs

Release History
Release 8.1.1; command was introduced.

page 35-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands user

Related Commands

password Configures the password for the current user.

show user Displays information about users configured in the local database on the
switch.

MIB Objects
aaaUserTable
aaauPassword
aaauReadRight
aaauWriteRight
aaauSnmpLevel
aaauSnmpAuthKey
aaauPasswordExpirationDate

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-45
password AAA Commands

password
Configures the password for the current user.
password

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The password command does not require a password in-line; instead, after the command is entered, the
system displays a prompt for the password. Enter any alphanumeric string. (The string displays on the
screen as asterisks.) The system displays a prompt to verify the new password.
• The password may be up to 47 characters. The default minimum password length is 8 characters.

• A new password cannot be identical to the current password; it cannot be identical to any of the three
passwords that preceded the current password.
• Note that the exclamation point (!) is not a valid password character. In addition, specifying an asterisk
(*) as one or more characters in a password is allowed as long as every character is not an asterisk. For
example, password **123456** is allowed; password ******** is not allowed.
• Password settings are automatically saved to the switch configuration.

• Passwords with non-alphanumeric characters should be enclosed in single quotes.

• If the snapshot command is used to capture the switch configuration, the text of the password is not
displayed in the file. Instead an authentication key is included in the file.

Examples
-> password
enter old password: ********
enter new password: *********
reenter new password: *********
->

Release History
Release 8.1.1; command was introduced.

page 35-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands password

Related Commands

user Configures entries in the local user database. May be used by a system
administrator to change any user’s password in addition to configuring
user privileges.

MIB Objects
aaaUserTable
aaauPassword
aaauOldPassword

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-47
user password-size min AAA Commands

user password-size min

Configures the minimum number of characters required when configuring a user password.
user password-size min size

Syntax Definitions

size The number of characters required when configuring a user password

through the password command or when setting up a user password
through the user command. The range is 1 to 14 characters.

Defaults

parameter default
size 6

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> user password-size min 9

Release History
Release 8.1.1; command was introduced.

Related Commands

user Configures entries in the local user database. May be used by a system
administrator to change any user’s password in addition to configuring
user privileges.
show user password-policy Displays the global password policy configuration for the switch.

MIB Objects
aaaAsaConfig
aaaAsaPasswordSizeMin

page 35-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands user password-expiration

user password-expiration
Configures an expiration date for all user passwords stored locally on the switch or disables password
expiration.
user password-expiration {day | disable}

Syntax Definitions

day The number of days before locally configured user passwords will
expire. The range is 1 to 150 days.
disable Disables password expiration for users configured locally on the switch.

Defaults

parameter default
day | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The user password-expiration command sets a default password expiration for users configured
locally on the switch.
• Password expiration may be configured on a per-user basis through the user command; the user setting
overrides the user password-expiration setting until the user password is changed or the user
password-expiration command is entered again.

Examples
-> user password-expiration 2
-> user password-expiration disable

Release History
Release 8.1.1; command was introduced.

Related Commands

user Configures entries in the local user database. May be used by a system
administrator to change any user’s password in addition to configuring
user privileges.
show user password-policy Displays the global password policy configuration for the switch.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-49
user password-expiration AAA Commands

MIB Objects
aaaAsaConfig
aaaAsaDefaultPasswordExpirationInDays

page 35-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands user password-policy cannot-contain-username

user password-policy cannot-contain-username

Specifies whether or not a user can configure a password that contains the username for the account.
user password-policy cannot-contain-username {enable | disable}

Syntax Definitions

enable Does not allow the password to contain the username.

disable Allows the password to contain the username.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The status of this function is specified as part of a global password policy that is applied to all
passwords when they are created or modified.
• When this function is enabled, a check is done at the time the password is created or modified to ensure
that the username is not specified as part of the password text.

Examples
-> user password-policy cannot-contain-username enable
-> user password-policy cannot-contain-username disable

Release History
Release 8.1.1; command was introduced.

Related Commands

show user password-policy Displays the global password policy configuration for the switch.

MIB Objects
aaaAsaConfig
aaaAsaPasswordContainUserName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-51
user password-policy min-uppercase AAA Commands

user password-policy min-uppercase

Configures the minimum number of uppercase English characters required for a valid password.
user password-policy min-uppercase number

Syntax Definitions

number The minimum number of uppercase characters. The range is 0 to 7.

Defaults

parameter default
number 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Specify 0 with this command to disable the minimum uppercase character requirement.

• The minimum number of uppercase characters is specified as part of a global password policy that is
applied to all passwords when they are created or modified.

Examples
-> user password-policy min-uppercase 2
-> user password-policy min-uppercase 0

Release History
Release 8.1.1; command was introduced.

Related Commands

show user password-policy Displays the global password policy configuration for the switch.

MIB Objects
aaaAsaConfig
aaaAsaPasswordMinUpperCase

page 35-52 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands user password-policy min-lowercase

user password-policy min-lowercase

Configures the minimum number of lowercase English characters required for a valid password.
user password-policy min-uppercase number

Syntax Definitions

number The minimum number of lowercase characters. The range is 0 to 7.

Defaults

parameter default
number 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Specify 0 with this command to disable the minimum lowercase character requirement.

• The minimum number of lowercase characters is specified as part of a global password policy that is
applied to all passwords when they are created or modified.

Examples
-> user password-policy min-lowercase 2
-> user password-policy min-lowercase 0

Release History
Release 8.1.1; command was introduced.

Related Commands

show user password-policy Displays the global password policy configuration for the switch.

MIB Objects
aaaAsaConfig
aaaAsaPasswordMinLowerCase

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-53
user password-policy min-digit AAA Commands

user password-policy min-digit

Configures the minimum number of base-10 digits required for a valid password.
user password-policy min-digit number

Syntax Definitions

number The minimum number of digits. The range is 0 to 7.

Defaults

parameter default
number 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Specify 0 with this command to disable the minimum number of digits requirement.

• The minimum number of digits requirement is specified as part of a global password policy that is
applied to all passwords when they are created or modified.

Examples
-> user password-policy min-digit 2
-> user password-policy min-digit 0

Release History
Release 8.1.1; command was introduced.

Related Commands

show user password-policy Displays the global password policy configuration for the switch.

MIB Objects
aaaAsaConfig
aaaAsaPasswordMinDigit

page 35-54 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands user password-policy min-nonalpha

user password-policy min-nonalpha

Configures the minimum number of non-alphanumeric characters (symbols) required for a valid password.
user password-policy min-nonalpha number

Syntax Definitions

number The minimum number of non-alphanumeric characters. The valid range

is 0–7.

Defaults

parameter default
number 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Specify 0 with this command to disable the minimum non-alphanumeric character requirement.

• The minimum number of non-alphanumeric characters is specified as part of a global password policy
that is applied to all passwords when they are created or modified.
• Passwords with non-alphanumeric characters should be enclosed in single quotes.

Examples
-> user password-policy min-nonalpha 2
-> user password-policy min-nonalpha 0

Release History
Release 8.1.1; command was introduced.

Related Commands

show user password-policy Displays the global password policy configuration for the switch.

MIB Objects
aaaAsaConfig
aaaAsaPasswordMinNonAlpha

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-55
user password-history AAA Commands

user password-history
Configures the maximum number of old passwords to retain in the password history.
user password-history number

Syntax Definitions

number The maximum number of old passwords to retain.

The range is 0 to 24.

Defaults

parameter default
number 4

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Specify 0 with this command to disable the password history function.

• The user is prevented from specifying any passwords that are recorded in the password history and fall
within the range configured through this command.
• The password history value is specified as part of a global password policy that is applied to all
passwords when they are created or modified.

Examples
-> user password-history 2
-> user password-history 0

Release History
Release 8.1.1; command was introduced.

Related Commands

show user password-policy Displays the global password policy configuration for the switch.

MIB Objects
aaaAsaConfig
aaaAsaPasswordHistory

page 35-56 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands user password-min-age

user password-min-age
Configures the minimum number of days during which a user is prevented from changing a password.
user password-min-age days

Syntax Definitions

days The number of days to use as the minimum age of the password. The
range is 0 to 150.

Defaults

parameter default
days 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Specify 0 with this command to disable the minimum number of days requirement.

• Configure the minimum age of a password with a value that is less than the value configured for the
password expiration.
• The password minimum age value is specified as part of a global password policy that is applied to all
passwords when they are created or modified.

Examples
-> user password-min-age 7
-> user password-min-age 0

Release History
Release 8.1.1; command was introduced.

Related Commands

show user password-policy Displays the global password policy configuration for the switch.

MIB Objects
aaaAsaConfig
aaaAsaPasswordMinAge

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-57
user lockout-window AAA Commands

user lockout-window
Configures a moving period of time (observation window) during which failed login attempts are counted
to determine if the number of failed attempts has exceeded the number of allowed attempts. The number of
failed login attempts is decremented by the number of failed attempts that age beyond the observation
window time period.
user lockout-window minutes

Syntax Definitions

minutes The number of minutes the observation window remains active. The
range is 0 to 99999.

Defaults

parameter default
minutes 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is only available to the admin user because the admin user account is the only account
protected from any type of lockout attempt.
• Specify 0 with this command to disable the observation window function. This means that failed login
attempts will never age out; the number of failed attempts is never decremented.
• Do not configure an observation window time period that is greater than the lockout duration time
period.
• If the number of failed login attempts exceeds the number of failed attempts allowed before the
observation window time expires, then the user account is locked out of the switch.
• The observation window time period is a global lockout setting that is applied to all passwords
configured on the switch.
• Lockout settings are saved automatically.

Examples
-> user lockout-window 500
-> user lockout-window 0

Release History
Release 8.1.1; command was introduced.

page 35-58 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands user lockout-window

Related Commands

user lockout-duration Configures the amount of time a user account remains locked out of the
switch.
user lockout-threshold Configures the number of failed password attempts allowed before the
user account is locked out of the switch.
user lockout unlock Manually locks or unlocks a user account on the switch.
show user lockout-setting Displays the global user lockout settings for the switch.

MIB Objects
aaaAsaConfig
aaaAsaLockoutWindow

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-59
user lockout-threshold AAA Commands

user lockout-threshold
Configures the number of failed password login attempts allowed during a certain period of time
(observation window). If the number of failed attempts exceeds the lockout threshold number before the
observation window period expires, the user account is locked out.
user lockout-threshold number

Syntax Definitions

number The number of failed login attempts allowed. The range is 0 to 999.

Defaults

parameter default
number 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is only available to the admin user because the admin user account is the only account
protected from any type of lockout attempt.
• If the lockout threshold is set to zero (the default), there is no limit to the number of failed login
attempts allowed.
• A user account remains locked out for the length of the lockout duration time period; at the end of this
time, the account is automatically unlocked.
• If the lockout duration time period is set to zero, only the admin user or a user with read/write AAA
privileges can unlock a locked user account. An account is unlocked by changing the user account
password or with the user lockout unlock command.
• The lockout threshold time period is a global lockout setting that is applied to all passwords configured
on the switch.
• Lockout settings are saved automatically; that is, these settings do not require the issu slot, reload slot,
or configuration snapshot command to save user settings over a reboot.

Examples
-> user lockout-threshold 3
-> user lockout-threshold 0

Release History
Release 8.1.1; command was introduced.

page 35-60 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands user lockout-threshold

Related Commands

user lockout-window Configures a window of time during which failed login attempts are
counted to determine if the number of failed attempts has exceeded the
number of allowed attempts.
user lockout-duration Configures the length of time a user account remains locked out of the
switch.
user lockout unlock Manually locks or unlocks a user account on the switch.
show user lockout-setting Displays the global user lockout settings for the switch.

MIB Objects
aaaAsaConfig
aaaAsaLockoutThreshold

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-61
user lockout-duration AAA Commands

user lockout-duration
Configures the length of time a user account remains locked out of the switch. At the end of this time
period, the user account is automatically unlocked.
user lockout-duration minutes

Syntax Definitions

minutes The number of minutes the user account remains locked out. The range
is 0 to 99999.

Defaults

parameter default
minutes 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is only available to the admin user because the admin user account is the only account
protected from any type of lockout attempt.
• Note that if the lockout duration time period is set to zero (the default), then locked user accounts are
never automatically unlocked.
• Only the admin user or a user with read/write AAA privileges can unlock a locked user account when
the lockout duration time is set to zero. An account is unlocked by changing the user password or with
the user lockout unlock command.
• Do not configure a lockout duration time period that is less than the amount of time configured for the
observation window.
• The lockout duration time period is a global lockout setting that is applied to all passwords configured
on the switch.
• Lockout settings are saved automatically; that is, these settings do not require the issu slot, reload slot,
or configuration snapshot command to save user settings over a reboot.

Examples
-> user lockout-duration 60
-> user lockout-duration 0

Release History
Release 8.1.1; command was introduced.

page 35-62 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands user lockout-duration

Related Commands

user lockout-window Configures a window of time during which failed login attempts are
counted to determine if the number of failed attempts has exceeded the
number of allowed attempts.
user lockout-threshold Configures the number of failed password attempts allowed before the
user account is locked out of the switch.
user lockout unlock Manually locks or unlocks a user account on the switch.
show user lockout-setting Displays the global user lockout settings for the switch.

MIB Objects
aaaAsaConfig
aaaAsaLockoutDuration

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-63
user lockout unlock AAA Commands

user lockout unlock

Manually locks or unlocks a user account on the switch.
user username {lockout | unlock}

Syntax Definitions

username The username of the account to lock or unlock.

lockout Locks the user account out of the switch.
unlock Unlocks a locked user account.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is only available to the admin user or a user with read/write AAA privileges.

• The admin user account is protected from any type of lockout attempt.

• User lockouts and unlocks are saved automatically.

Examples
-> user j_smith lockout
-> user j_smith unlock

Release History
Release 8.1.1; command was introduced.

Related Commands

show user Displays information about all users or a particular user configured in
the local user database on the switch.
show user lockout-setting Displays the global user lockout settings for the switch.

MIB Objects
aaaUserTable
aaauPasswordLockoutEnable

page 35-64 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands show aaa server

show aaa server

Displays information about a particular AAA server or AAA servers.
show aaa server [server_name]

Syntax Definitions

server_name The server name, which is defined through the aaa radius-server, aaa
tacacs+-server, or aaa ldap-server commands.

Defaults
By default, the configuration for all servers is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enter the name of a server with this command to display information about a specific server.

• RADIUS, TACACS+, and LDAP parameters are configured through the aaa radius-server, aaa
tacacs+-server, and aaa ldap-server commands.

Examples
-> show aaa server
Server name = rad1
Server type = RADIUS,
IP Address 1 = 10.10.2.1,
IP Address 2 = 10.10.3.5,
Retry number = 3,
Timeout (in sec) = 2,
Authentication port = 1645,
Accounting port = 1646
VRF = default
Server name = ldap2
Server type = LDAP,
Host name 1 = ors40535,
Port = 389,
Domain name = manager,
Search base = c=us,
Retry number = 3,
Timeout (in sec) = 2,
SSL enable = TRUE
VRF = default
Server name = Tpub1
Server type = TACACS+,
IP Address 1 = 10.10.5.1,
Port = 49,
Timeout (in sec) = 2,
Encryption enabled = no
VRF = default

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-65
show aaa server AAA Commands

-> show aaa server ldap2

Server name = ldap2
Server type = LDAP,
Host name 1 = ors40535,
Port = 389,
Domain name = manager,
Search base = c=us,
Retry number = 3,
Timeout (in sec) = 2,
SSL enable = TRUE
VRF = default

output definitions
Server name The name of the server. A RADIUS, TACACS+ or LDAP server name
is defined through the aaa radius-server, aaa tacacs+-server, and aaa
ldap-server commands respectively.
Server type The type of server (LDAP, TACACS+, or RADIUS).
Host name The name of the primary LDAP, TACACS+, or RADIUS host.
IP address The IP address of the server.
Retry number The number of retries the switch makes to authenticate a user before
trying the backup server.
Timeout The timeout for server replies to authentication requests.
Port The port number for the primary LDAP or TACACS+ server.
Encryption enabled The status of the encryption.
Domain name The super-user or administrative distinguished name in the format rec-
ognized by the LDAP-enabled directory servers.
Search base The search base recognized by the LDAP-enabled directory servers.
Authentication port The UDP destination port for authentication requests.
Accounting port The UDP destination port for accounting requests.
SSL enable Whether or not a secure switch layer (SSL) is enabled between the
switch and the LDAP server.
VRF Name of the VRF associated with the server.

Release History
Release 8.1.1; command was introduced.

page 35-66 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands show aaa server

Related Commands

aaa radius-server Configures or modifies a RADIUS server for authenticated switch

access.
aaa ldap-server Configures or modifies an LDAP server for authenticated switch access.
aaa tacacs+-server Configures or modifies an TACACS+ server for authenticated switch
access.

MIB Objects
aaaServerTable
aaasName
aaasHostName
aaasIpAddress
aaasHostName2
aaasIpAddress2
aaasRadKey
aaasRetries
aaasTimout
aaasRadAuthPort
aaasRadAcctPort
aaasProtocol
aaasTacacsKey
aaasTacacsPort
aaasLdapPort
aaasLdapDn
aaasLdapPasswd
aaasLdapSearchBase
aaasLdapServType
aaasLdapEnableSsl
aaasVRFName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-67
show aaa authentication AAA Commands

show aaa authentication

Displays information about the current authenticated switch session.
show aaa authentication

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the show aaa authentication command to display authentication information about switch
management services (Telnet, FTP, console port, Secure Shell, etc.).

Examples
-> show aaa authentication
Service type = Default
1rst authentication server = RadiusServer
2nd authentication server = local
Service type = Console
1rst authentication server = local
Service type = Telnet
Authentication = Use Default,
1rst authentication server = RadiusServer
2nd authentication server = local
Service type = FTP
Authentication = Use Default,
1rst authentication server = RadiusServer
2nd authentication server = local
Service type = Http
Authentication = Use Default,
1rst authentication server = RadiusServer
2nd authentication server = local
Service type = Snmp
Authentication = Use Default,
1rst authentication server = RadiusServer
2nd authentication server = local
Service type = Ssh
Authentication = Use Default,
1rst authentication server = TacacsServer
2nd authentication server = local

page 35-68 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands show aaa authentication

output definitions
Authentication Displays denied if the management interface is disabled. Displays Use
Default if the management interface is configured to use the default
configuration.
1st authentication server The first server to be polled for authentication information.
2nd authentication server The next server to be polled for authentication information.

Release History
Release 8.1.1; command was introduced.

Related Commands

aaa authentication Configures the interface for authenticated switch access and specifies
the server(s) to be used.

MIB Objects
aaaAuthSATable
aaatsName1
aaatsName2
aaatsName3
aaatsName4

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-69
show aaa device-authentication AAA Commands

show aaa device-authentication

Displays a list of RADIUS servers assigned to provide 802.1X, MAC, or Captive Portal authentication.
show aaa device-authentication [802.1x | mac | captive-portal]

Syntax Definitions

802.1x Displays the servers used for 802.1X authentication.

mac Displays the servers used for MAC authentication.
captive-portal Uses the servers used for Captive Portal authentication.

Defaults
By default, all assigned servers are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the optional 802.1x, mac, or captive-portal parameters to display the servers assigned to provide the
specified type of authentication.

Examples
-> show aaa device-authentication
Authentication type = mac
Authentication Server:
1st authentication server = cppm,
2nd authentication server = rad1
3rd authentication server = rad2,
4th authentication server = rad3

Authentication type = 802.1x

Authentication Server:
1st authentication server = cppm,
2nd authentication server = rad1

Authentication type = captive-portal

Authentication Server:
1st authentication server = cppm,
2nd authentication server = rad1

output definitions
Authentication type The type of authentication the server is assigned to provide (802.1x,
mac, or captive-portal)
1st authentication server The first server to be polled for authentication information. Any backup
servers are also displayed on subsequent lines.

page 35-70 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands show aaa device-authentication

Release History
Release 8.1.1; command was introduced.

Related Commands

aaa device-authentication Configures the RADIUS server to use for 802.1X, MAC, or Captive
Portal authentication.

MIB Objects
aaaAuthDATable
aaadaInterface
aaadaName1
aaadaName2
aaadaName3
aaadaName4

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-71
show aaa accounting AAA Commands

show aaa accounting

Displays information about accounting servers configured for authenticated switch access and device
authentication sessions. Accounting servers keep track of network resources (time, packets, bytes, etc.)
and user activity.
show aaa accounting [802.1x | mac | captive-portal]

Syntax Definitions

802.1x Displays the RADIUS or syslog server used to log accounting for
802.1X authenticated sessions.
mac Displays the RADIUS or syslog server used to log accounting for MAC
authenticated sessions.
captive-portal Displays the RADIUS or syslog server to log accounting for Captive
Portal authenticated sessions.

Defaults
By default, the accounting server configuration is displayed for TACACS+ commands and management
sessions (Telnet, FTP, console port, HTTP, or SNMP).

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the 802.1x, mac, or captive-portal parameters to display the accounting server configuration for a
specific type of device authentication.
• If no parameters are entered with this command, the accounting server configuration for authentication
sessions and TACACS+ commands is displayed.

Examples
-> show aaa accounting mac
Accounting type = mac
Accounting Server:
1st Accnt Server = rad1,
2nd Accnt Server = rad2

-> show aaa accounting 802.1x

Accounting type = 802.1x
Syslog Accnt Server:
IP Address = 135.254.163.110,
UDP port = 514

-> show aaa accounting captive-portal

Accounting type = captive-portal
Syslog Accnt Server:
IP Address = 135.254.163.110,
UDP port = 514

page 35-72 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands show aaa accounting

-> show aaa accounting

Session (telnet, ftp, ...)
1st accounting server = rad1
Command accounting server
1st accounting server = server1

Release History
Release 8.1.1; command was introduced.

Related Commands

aaa accounting session Configures an accounting server for authenticated switch access ses-
sions.
aaa accounting command Enables or disables the TACACS+ server for command accounting
aaa accounting Configures RADIUS server accounting or local Switch Logging (syslog)
accounting for device authentication sessions.

MIB Objects
aaaAcctDATable
aaacdInterface
aaacdName1
aaacdName2
aaacdName3
aaacdName4
aaacdSyslogIPAddrType
aaacdSyslogIPAddr
aaacdSyslogUdpPort
aaacdRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-73
show aaa config AAA Commands

show aaa config

Displays the AAA parameter configuration for 802.1X, MAC, and Captive Portal sessions.
show aaa {802.1x | mac | captive-portal} config

Syntax Definitions

802.1x Displays the parameter configuration for 802.1X authenticated sessions.

mac Displays the parameter configuration for MAC authenticated sessions.
captive-portal Displays the parameter configuration for Captive Portal authenticated
sessions.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the 802.1x, mac, or captive-portal parameters to display the parameter configuration for a specific
type of device authentication.

Examples
-> show aaa 802.1x config
Authentication type = 802.1x
Re-Authentication Timeout:
Status = enable,
Interval (sec) = 3600,
Trust Radius = disable

Accounting Interim:
Interval (sec) = 600,
Trust Radius = disable

-> show aaa mac config

Authentication type = mac
Session Timeout:
Status = disable,
Interval (sec) = 43200,
Trust Radius = disable

Inactivity Timeout:
Status = disable,
Interval (sec) = 600

Accounting Interim:
Interval (sec) = 600,
Trust Radius = disable

page 35-74 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands show aaa config

-> show aaa captive-portal config

Authentication type = captive-portal
Session Timeout:
Status = disable,
Interval (sec) = 43200,
Trust Radius = disable

Inactivity Timeout:
Status = disable,
Interval (sec) = 600

Accounting Interim:
Interval (sec) = 600,
Trust Radius = disable

output definitions
Authentication type The type of authentication (802.1x, mac, or captive-portal).
Session Timeout The parameter values for the AAA session timeout parameter. Does not
apply to 802.1X authentication. Configured through the aaa session-
timeout command.
Inactivity Logout The parameter values for the AAA inactivity logout parameter. Does
not apply to 802.1X authentication. Configured through the aaa inac-
tivity-logout command.
Accounting Interim The parameter values for the AAA accounting interim parameter. Con-
figured through the aaa interim-interval command.
Re-authentication Timeout The parameter values for the AAA 802.1X re-authentication timeout
parameter. Does not apply to MAC or Captive Portal authentication.
Configured through the aaa 802.1x re-authentication command.

Release History
Release 8.1.1; command was introduced.

Related Commands

show aaa device- Displays the device authentication server configuration.

authentication
show aaa accounting Displays the accounting server configuration.
show aaa profile Displays the AAA parameter profile configuration.

MIB Objects
alaAaaAuthConfig
alaAaa8021XReAuthStatus
alaAaa8021XReAuthIntrvl
alaAaa8021XReAuthTrustRadStatus
alaAaa8021XIntrmIntrvl
alaAaa8021XIntmIntvlTrstRadStus
alaAaaMacIntrmIntrvl
alaAaaMacIntmIntvlTrstRadStatus
alaAaaMacSessTimeoutStatus
alaAaaMacSessTimeoutIntrvl

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-75
show aaa config AAA Commands

alaAaaMacSesTimeoutTrstRadStatus
alaAaaMacInActLogoutStatus
alaAaaMacInActLogoutIntrvl
alaAaaCpIntrmIntrvl
alaAaaCpIntmIntvlTrstRadStatus
alaAaaCpSessTimeoutStatus
alaAaaCpSessTimeoutIntrvl
alaAaaCpSsTmotTrstRadStatus
alaAaaCpInActLogoutStatus
alaAaaCpInActLogoutIntrvl

page 35-76 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands show aaa radius config

show aaa radius config

Displays the global AAA attribute values and MAC address format.
show aaa radius config

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The MAC address format determines the delimiter character used between MAC address octets and
whether or not characters are in uppercase or lowercase. This format is applied only when the RADIUS
attribute value is set to a MAC address.

Examples
-> show aaa radius config
RADIUS client attributes:
NAS port id = default,
NAS identifier = default
MAC format delimiter:
Username = none, UserNameCase = uppercase,
Password = none, PasswordCase = uppercase,
calling station id = none, ClgStaIdCase = uppercase,
called station id = none, CldStaIdCase = uppercase

Release History
Release 8.1.1; command was introduced.

Related Commands

show aaa device- Displays the device authentication server configuration.

authentication
show aaa accounting Displays the accounting server configuration.
show aaa profile Displays the AAA parameter profile configuration.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-77
show aaa radius config AAA Commands

MIB Objects
alaAaaAuthConfig
alaAaa8021XReAuthStatus
alaAaa8021XReAuthIntrvl
alaAaa8021XReAuthTrustRadStatus
alaAaa8021XIntrmIntrvl
alaAaa8021XIntmIntvlTrstRadStus
alaAaaMacIntrmIntrvl
alaAaaMacIntmIntvlTrstRadStatus
alaAaaMacSessTimeoutStatus
alaAaaMacSessTimeoutIntrvl
alaAaaMacSesTimeoutTrstRadStatus
alaAaaMacInActLogoutStatus
alaAaaMacInActLogoutIntrvl
alaAaaCpIntrmIntrvl
alaAaaCpIntmIntvlTrstRadStatus
alaAaaCpSessTimeoutStatus
alaAaaCpSessTimeoutIntrvl
alaAaaCpSsTmotTrstRadStatus
alaAaaCpInActLogoutStatus
alaAaaCpInActLogoutIntrvl

page 35-78 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands show aaa profile

show aaa profile

Displays the AAA profile configuration.
show aaa profile profie_name

Syntax Definitions

profile_name The name of an existing AAA profile.

Defaults
By default, all profiles are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Enter an AAA profile name with this command to display information about a specific profile.

Examples
-> show aaa profile ap2

AAA profile name = ap2

Authentication type = mac
Session Timeout:
Status = disable,
Interval (sec) = 43200,
Trust Radius = disable

Inactivity Timeout:
Status = disable,
Interval (sec) = 600

Accounting Interim:
Interval (sec) = 600,
Trust Radius = disable

Authentication type = 802.1x

Re-Authentication Timeout:
Status = disable,
Interval (sec) = 3600,
Trust Radius = disable

Accounting Interim:
Interval (sec) = 600,
Trust Radius = disable

Authentication type = captive-portal

Session Timeout:
Status = disable,
Interval (sec) = 43200,

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-79
show aaa profile AAA Commands

Trust Radius = disable

Inactivity Timeout:
Status = disable,
Interval (sec) = 600

Accounting Interim:
Interval (sec) = 600,
Trust Radius = disable

RADIUS client attributes:

NAS port id = default,
NAS identifier = default,
MAC format delimiter:
Username = none, UserNameCase = uppercase,
Password = none, PasswordCase = uppercase,
calling station id = none, ClgStaIdCase = uppercase,
called station id = none, CldStaIdCase = uppercase

output definitions
Authentication type The type of authentication (802.1x, mac, or captive-portal) configured
through the profile.
Session Timeout The profile values defined for the AAA session timeout parameter.
Does not apply to 802.1X authentication.
Inactivity Logout The profile values defined for the AAA inactivity logout parameter.
Does not apply to 802.1X authentication.
Accounting Interim The profile values defined for the AAA accounting interim parameter.
Re-authentication Timeout The profile values defined for the AAA re-authentication timeout
parameter. Does not apply to MAC or Captive Portal authentication.
RADIUS client attributes The profile values defined for the NAS-Port and NAS-Port-Identifier
attributes and the format to use when the specified attribute value is set
to a MAC address.

Release History
Release 8.1.1; command was introduced.

Related Commands

aaa profile Configures an AAA profile.

MIB Objects
alaAaaProfTable
alaAaaProfOnexReAuthSts
alaAaaProfOnexReAuthIntrvl
alaAaaProfOnexReAuthTrstRadSts
alaAaaProfOnexIntrmIntrvl
alaAaaProfOnexIntmItvlTstRadSts
alaAaaProfMacIntrmIntrvl
alaAaaProfMacIntmItvlTrstRadSts
alaAaaProfMacSessTimeoutSts

page 35-80 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands show aaa profile

alaAaaProfMacSessTimeoutIntrvl
alaAaaProfMacSessTmoutTrstRadSts
alaAaaProfMacInActLogoutSts
alaAaaProfMacInActLogoutIntrvl
alaAaaProfCpSessTimeoutSts
alaAaaProfCpSessTimeoutIntrvl
alaAaaProfCpSessTmotTrstRadSts
alaAaaProfCpInActLogoutSts
alaAaaProfCpInActLogoutIntrvl
alaAaaProfCpIntrmIntrvl
alaAaaProfCpItrmIntlTrstRadSts
alaAaaProfRadNasPortId
alaAaaProfRadNasIdentifier
alaAaaProfRadUserNameDelim
alaAaaProfRadPasswrdDelim
alaAaaProfRadCallnStnIdDelim
alaAaaProfRadCalldStnIdDelim
alaAaaProfRadUserNameCase
alaAaaProfRadPasswordCase
alaAaaProfRadCallnStnIdCase
alaAaaProfRadCalldStnIdCase

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-81
show user AAA Commands

show user
Displays information about all users or a particular user configured in the local user database on the
switch.
show user [username]

Syntax Definitions

username The name of the user. Used for logging into the switch.

Defaults
By default, all users are displayed if the username parameter is not specified with this command.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use this command to display information about read/write access and partitioned management access
(domains and families).

Examples
-> show user
User name = admin,
Password expiration = None,
Password allow to be modified date = None,
Account lockout = None,
Password bad attempts = 2,
Read Only for domains = None,
Read/Write for domains = All ,
Snmp allowed = NO
Console-Only = Disabled
User name = default (*),
Password expiration = None,
Password allow to be modified date = None,
Account lockout = None,
Password bad attempts = 0,
Read Only for domains = None,
Read/Write for domains = None,
Snmp allowed = NO
Console-Only = Disabled,
(*)Note:
The default user is not an active user account.
It constains the default user account settings,
for new user accounts.

User name = snmpadmin,

Password expiration = None,
Password allow to be modified date = None,
Account lockout = None,
Password bad attempts = 0,

page 35-82 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands show user

Read Only for domains = None,

Read/Write for domains = None,
Snmp allowed = YES,
Snmp authentication = MD5,
Snmp encryption = DES
Console-Only = Disabled
User name = tpubs,
Password expiration = None,
Password allow to be modified date = None,
Account lockout = None,
Password bad attempts = 0,
Read Only for domains = None,
Read/Write for domains = All ,
Snmp allowed = NO
Console-Only = Disabled

output definitions
User name The user name for this account.
Password expiration The date and time on which the password will expire. This field only
displays if the password expiration is configured specifically for a user,
or a default password expiration is configured globally on the switch
through the user password-expiration command. (Note that the date/
time are based on the switch’s default system date/time or the system
date/time configured through the system date and system time com-
mands.)
Password allow to be modified The earliest date and time on which the user may change the password.
date Configured through the user password-min-age command.
Account lockout Indicates if the user account is locked out (Yes or No) and how many
minutes remain until the user account is automatically unlocked. If no
remaining time is displayed, the admin user or a user with admin privi-
leges must manually unlock the account. Configured through the user
lockout-duration and user lockout unlock commands.
Password bad attempts The number of failed password login attempts for this user account.
Read Only for domains The command domains available with the user’s read-only access. See
the table on the next page for a listing of valid domains.
Read/Write for domains The command domains available with the user’s read-write access. See
the table on the next page for a listing of valid domains.
Read Only for families The command families available with the user’s read-only access. See
the table on the next page for a listing of valid families.
Read/Write for families The command families available with the user’s read-write access. See
the table on the next page for a listing of valid families.
Snmp allowed Indicates whether or not the user is authorized to use SNMP (YES or
NO). SNMP is allowed for the user account when SNMP authentica-
tion is specified for the account.
Snmp authentication The level of SNMP authentication, if any, configured for the user. This
field only displays if the user is authorized to use SNMP.
Snmp encryption The level of SNMP encryption, if any, configured for the user. This
field only displays if the user is authorized to use SNMP.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-83
show user AAA Commands

Possible values for command domains and families are listed here:

Domain Corresponding Families

domain-admin file telnet dshell debug
domain-system system aip snmp rmon webmgt config
domain-physical chassis module interface pmm health
domain-network ip rip ospf bgp vrrp ip-routing ipx ipmr ipms
domain-layer2 vlan bridge stp 802.1q linkagg ip-helper
domain-service dns
domain-policy qos policy slb
domain-security session avlan aaa

Release History
Release 8.1.1; command was introduced.

Related Commands

user Configures user entries in the local user database.

show user password-policy Displays the global password policy configuration for the switch.
show user lockout-setting Displays the global user lockout settings for the switch.

MIB Objects
aaaUserTable
aaauUserName
aaauPasswordExpirationDate
aaauPasswordExpirationInMinute
aaauPasswordAllowModifyDate
aaauPasswordLockoutEnable
aaauBadAttempts
aaauReadRight1
aaauReadRight2
aaauWriteRight1
aaauWriteRight2
aaauSnmpLevel
aaauSnmpAuthkey

page 35-84 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands show user password-policy

show user password-policy

Displays the global password settings configured for the switch.
show user password-policy

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The password policy contains parameter values that define configuration requirements for all passwords
that are created on the switch. Use this command to display the current parameter values for the password
policy.

Examples
-> show user password-policy
Password Policy:
Contain username flag: Enable
Minimum number of English uppercase characters: 6
Minimum number of English lowercase characters: 4
Minimum number of base-10 digit: 2
Minimum number of non-alphanumeric: 3
Minimum size: 8
Password history: 4
Password minimum age: 20 (days)
Password expiration: 40 (days)

output definitions
Contain username flag Indicates if the username is included with the password check (Enable
or Disable). Configured through the user password-policy cannot-
contain-username command.
Minimum number of English The minimum number of uppercase characters required in a password.
uppercase characters Configured through the user password-policy min-uppercase com-
mand.
Minimum number of English The minimum number of lowercase characters required in a password.
lowercase characters Configured through the user password-policy min-lowercase.
Minimum number of base-10 The minimum number of digits required in a password. Configured
digit through the user password-policy min-digit command.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-85
show user password-policy AAA Commands

output definitions
Minimum number of non- The minimum number of non-alphanumeric characters required in a
alphanumeric password. Configured through the user password-policy min-nonal-
pha command.
Minimum size The minimum number of characters required for the password size.
Configured through the user password-size min command.
Password history The maximum number of old passwords retained in the password his-
tory. Configured through the user password-history command.
Password minimum age The number of days a password is protected from any modification.
Configured through the user password-min-age command.
Password expiration The default expiration date applied to all passwords. Configured
through the user password-expiration command.

Release History
Release 8.1.1; command was introduced.

Related Commands

show user password-policy Displays the expiration date for passwords configured for user accounts
stored on the switch.

MIB Objects
aaaAsaConfig
aaaAsaPasswordContainUserName
aaaAsaPasswordMinUpperCase
aaaAsaPasswordMinLowerCase
aaaAsaPasswordMinDigit
aaaAsaPasswordMinNonAlpha
aaaAsaPasswordHistory
aaaAsaPasswordMinAge
aaaAsaPasswordSizeMin
aaaAsaDefaultPasswordExpirationInDays

page 35-86 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands show user lockout-setting

show user lockout-setting

Displays the global user lockout settings for the switch.
show user lockout-setting

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The global lockout settings include parameter values that determine the length of a user observation
window, the amount of time a locked user remains locked, and the number of failed password login
attempts allowed.

Examples
-> show user lockout-setting
Lockout Setting:
Observation window: 30 (minutes)
Duration: 200 (minutes)
Threshold: 20

output definitions
Observation window The amount of time, in minutes, during which the number of failed
password login attempts are counted. Configured through the user
lockout-window command.
Duration The amount of time, in minutes, that a locked user account remains
locked out of the switch. Configured through the user lockout-dura-
tion command.
Threshold The maximum number of failed password login attempts allowed
before the user is locked out of the switch. Configured through the user
lockout-threshold command.

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-87
show user lockout-setting AAA Commands

Related Commands

user lockout unlock Manually locks or unlocks a user account on the switch.
show user Displays information about all users or a particular user configured in
the local user database on the switch.

MIB Objects
aaaAsaConfig
aaaAsaLockoutWindow
aaaAsaLockoutDuration
aaaAsaLockoutThreshold

page 35-88 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands show aaa priv hexa

show aaa priv hexa

Displays hexadecimal values for command domains/families. Useful for determining how to express
command families in hexadecimal; hexadecimal values are used in configuring user privileges in attributes
on an external LDAP or RADIUS authentication server.
show aaa priv hexa [domain or family]

Syntax Definitions

domain or family The CLI command domain or particular command family for which you
want to display hexadecimal values. See table in Usage Guidelines.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Valid values for the family parameter are listed in the Corresponding Families column of the following
table:

Domain Corresponding Families

domain-admin file telnet dshell debug
domain-system system aip snmp rmon webmgt config
domain-physical chassis module interface pmm health
domain-network ip rip ospf bgp vrrp ip-routing ipx ipmr ipms
domain-layer2 vlan bridge stp 802.1q linkagg ip-helper
domain-service dns
domain-policy qos policy slb
domain-security session avlan aaa

• Note that some command families may not be supported depending on the hardware platform you are
running.
• If you do not specify a command family, hexadecimal values for all commands sets will display.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-89
show aaa priv hexa AAA Commands

Examples
-> show aaa priv hexa
file = 0x00000001 0x00000000,
telnet = 0x00000008 0x00000000,
dshell = 0x00000020 0x00000000,
debug = 0x00000040 0x00000000,
domain-admin = 0x00000069 0x00000000,

system = 0x00000080 0x00000000,

aip = 0x00000100 0x00000000,
snmp = 0x00000200 0x00000000,
rmon = 0x00000400 0x00000000,
webmgt = 0x00000800 0x00000000,
config = 0x00001000 0x00000000,
domain-system = 0x00001F80 0x00000000,

chassis = 0x00002000 0x00000000,

module = 0x00004000 0x00000000,
interface = 0x00008000 0x00000000,
pmm = 0x00010000 0x00000000,
health = 0x00040000 0x00000000,
domain-physical = 0x0005E000 0x00000000,

ip = 0x00080000 0x00000000,
rip = 0x00100000 0x00000000,
ospf = 0x00200000 0x00000000,
bgp = 0x00400000 0x00000000,
vrrp = 0x00800000 0x00000000,
ip-routing = 0x01000000 0x00000000,
ipx = 0x02000000 0x00000000,
ipmr = 0x04000000 0x00000000,
ipms = 0x08000000 0x00000000,
domain-network = 0x0FF80000 0x00000000,

vlan = 0x10000000 0x00000000,

bridge = 0x20000000 0x00000000,
stp = 0x40000000 0x00000000,
802.1q = 0x80000000 0x00000000,
linkagg = 0x00000000 0x00000001,
ip-helper = 0x00000000 0x00000002,
domain-layer2 = 0xF0000000 0x00000003,

dns = 0x00000000 0x00000010,

domain-service = 0x00000000 0x00000010,

qos = 0x00000000 0x00000020,

policy = 0x00000000 0x00000040,
slb = 0x00000000 0x00000080,
domain-policy = 0x00000000 0x000000E0,

session = 0x00000000 0x00000100,

avlan = 0x00000000 0x00000400,
aaa = 0x00000000 0x00000800,
domain-security = 0x00000000 0x00000D00

-> show aaa priv hexa rip

0x00100000 0x00000000

page 35-90 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
AAA Commands show aaa priv hexa

Release History
Release 8.1.1; command was introduced.

Related Commands

user Configures or modifies user entries in the local user database.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 35-91
show system fips AAA Commands

show system fips

Displays the configured and running status of the FIPS mode on the switch.
show system fips

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Status of the FIPS mode can be checked using the show system fips-status command.

• The show system fips is the only command that can be used to view the FIPS mode status. The FIPS
status is not shown in showconfiguration snaphot command output.

Examples
-> show system fips

Admin State: Enabled

Oper State: Enabled

Release History
Release 8.1.1; command introduced.

Related Commands

system fips admin-state Enable or disable the FIPS mode on the switch.

MIB Objects
systemFipsAdminState
systemFipsOperState

page 35-92 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 36 UNP Commands

The Universal Network Profile (UNP) feature provides administrators with the ability to define and apply
network access control to specific types of devices by grouping such devices according to specific
matching profile criteria. This allows network administrators to create virtual machine network profiles
(vNPs) and user device profiles from a unified framework of operation and administration.
UNP is not limited to creating profiles to classify only certain types of devices. However, the following
authentication and classification methods implemented through UNP functionality and profile criteria
provide the ability to tailor profiles for specific devices (physical or virtual):
• MAC-based and 802.1X-based authentication using a RADIUS-capable server.

• Redirection for Captive Portal authentication.

• Redirection to ClearPass Policy Manager (CPPM) for Bring Your Own Devices (BYOD) user device
registration, integrity check, UNP assignment, and policy list assignment.
• Switch-wide classification rules to classify users based on port and device attributes (for example,
source MAC, Group ID, IP address). No authentication required.
• Default UNP classification for traffic not classified through other methods.

Basically, UNP provides a method for dynamically assigning network devices to VLAN domains. A
profile consists of configurable attributes. When a device sends traffic that matches these attributes, the
device is then assigned to a VLAN associated with the UNP. The UNP may also specify role-based
attributes (such as a QoS/ACL policy list, a location-based policy, or a time-based policy) that are
subsequently applied to device traffic associated with the UNP VLAN.
Dynamic assignment of devices using UNP is achieved through port-based functionality that provides the
ability to authenticate and classify device traffic. Authentication verifies the device identity and provides a
UNP name. In the event authentication is not available or is unsuccessful, classification rules associated
with the UNPs are applied to the traffic to determine the UNP VLAN assignment.
The UNP feature is a major component of the OmniSwitch Access Guardian functionality that provides
proactive, dynamic solutions for network security. This chapter provides information about configuring
UNP port parameters and profile attributes through the Command Line Interface (CLI).
In addition to UNP, this chapter also documents the CLI commands used to configure Captive Portal and
Quarantine Manager and Remediation (QMR) functionality. These features are Access Guardian
components that interact with the UNP framework to provide post-authentication and post-classification
security functions.
MIB information for the UNP commands is as follows:
Filename: ALCATEL-IND1-DA-MIB
Module: alcatelIND1DaMIB
Filename: ALCATEL-IND1-UDP-RELAY-MIB
Module: alcatelIND1UDPRelayMIB

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-1
 UNP Commands

A summary of the available commands is listed here:

Global Configuration unp group-id

Commands unp customer-domain
unp policy validity-period
unp policy validity-location
unp dynamic-vlan-configuration
unp dynamic-profile-configuration
unp auth-server-down
unp auth-server-down timeout
unp redirect port-bounce
unp redirect pause-timer
unp redirect proxy-server-port
unp redirect-server
unp redirect allowed-name
unp edge-user flush
unp spb-access-user flush
show unp global configuration
show unp group-id
show unp customer-domain
show unp user
show unp edge-user
show unp edge-user status
show unp edge-user details
show unp vlan-user details
show unp spb-access-user details
show unp policy validity-period
show unp policy validity-location

page 36-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands

Port Commands unp port

unp redirect port-bounce
unp port edge-template
unp port group-id
unp unp-customer-domain
unp default-edge-profile
unp default-vlan-profile
unp default-spb-profile
unp aaa-profile
unp mac-authentication
unp mac-authentication pass-alternate
unp 802.1x-authentication
unp 802.1x-authentication pass-alternate
unp 802.1x-authentication tx-period
unp 802.1x-authentication supp-timeout
unp 802.1x-authentication max-req
unp 802.1x-authentication bypass
unp mac-authentication allow-eap
unp 802.1x-authentication failure-policy
unp classification
unp trust-tag
unp direction
unp vlan
unp edge-template
show unp port
show unp port bandwidth
show unp port 802.1x statistics
show unp port configured-vlans
show unp edge-template
Edge Profile Commands unp edge-profile
unp edge-profile qos-policy-list
unp edge-profile location-policy
unp edge-profile period-policy
unp edge-profile captive-portal-authentication
unp edge-profile captive-portal-profile
unp edge-profile authentication-flag
unp edge-profile mobile-tag
unp edge-profile redirect
unp edge-profile maximum-ingress-bandwidth
unp edge-profile maximum-egress-bandwidth
unp edge-profile maximum-ingress-depth
unp edge-profile maximum-egress-depth
unp vlan-mapping edge-profile
show unp edge-profile
show unp edge-profile vlan-mapping

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-3
 UNP Commands

VLAN Profile Commands unp vlan-profile

unp vlan-profile qos-policy-list
unp vlan-profile mobile-tag
unp vlan-profile maximum-ingress-bandwidth
unp vlan-profile maximum-egress-bandwidth
unp vlan-profile maximum-ingress-depth
unp vlan-profile maximum-egress-depth
unp vlan-profile saa-profile
show unp vlan-profile
SPB Profile Commands unp spb-profile
unp spb-profile qos-policy-list
unp spb-profile multicast-mode
unp spb-profile vlan-xlation
unp spb-profile mobile-tag
show unp spb-profile
SAA Profile Commands unp saa-profile
show unp saa-profile
Classification Rule Commands unp classification port
unp classification group-id
unp classification mac-address
unp classification mac-oui
unp classification mac-address-range
unp classification ip-address
unp classification vlan-tag
unp classification lldp med-endpoint ip-phone
unp classification authentication-type
show unp classification
Extended Classification Rule unp classification-rule
Commands unp classification-rule port
unp classification-rule group-id
unp classification-rule mac-address
unp classification-rule mac-oui
unp classification-rule mac-address-range
unp classification-rule ip-address
unp classification-rule vlan-tag
unp classification-rule lldp med-endpoint ip-phone
unp classification-rule authentication-type
show unp classification-rule
User Role Commands unp user-role
unp user-role policy-list
unp user-role edge-profile
unp user-role authentication-type
unp user-role cp-status-post-login
unp restricted-role policy-list
show unp user-role
show unp restricted-role

page 36-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands

Captive Portal Commands captive-portal name

captive-portal ip-address
captive-portal success-redirect-url
captive-portal proxy-server-port
captive-portal retry-count
captive-portal authentication-pass
captive-portal-profile
captive-portal customization
show captive-portal configuration
show captive-portal profile-name
Quarantine Manager and qmr quarantine path
Remediation (QMR) qmr quarantine page
Commands qmr quarantine allowed-name
qmr quarantine custom-proxy
show qmr
show quarantine mac group
Multicast Domain Name mdns-relay
System (mDNS) Commands mdns-relay tunnel
show mdns-relay config
Simple Service Discovery ssdp-relay
Protocol (SSDP) Relay ssdp-relay tunnel
Commands show ssdp-relay config

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-5
unp edge-profile UNP Commands

unp edge-profile
Configures an Edge classification profile that is used to provide role-based access to the switch. This type
of UNP profile determines the VLAN a device can join and applies any additional profile-defined
attributes to the device.
When an Edge profile is created with this command, the base command (unp edge-profile profile_name)
may be used with other command keywords to define attributes for the specified profile. These keywords
are listed here and described as separate commands later in this chapter. In addition, some keywords have
a no form to remove the parameter or return it to its default.
unp edge-profile profile_name
[qos-policy-list list_name]
[location-policy policy_name]
[period-policy policy_name]
[captive-portal-authentication {enable | disable}]
[captive-portal-profile profile_name]
[authentication-flag {enable | disable}]
[mobile-tag {enable | disable}]
[redirect {enable | disable}]
[maximum ingress-bandwidth bps[k | m]]
[maximum egress-bandwidth bps[k | m]]
[maximum ingress-depth bps]
[maximum egress-depth bps]
no unp edge-profile profile_name

Syntax Definitions

edge-profile profile_name The name to assign to the UNP Edge profile.

Defaults
By default, no profile attributes are enabled or defined when the Edge profile is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an Edge profile from the switch configuration.

• Edge profiles are applied only to traffic received on UNP Edge ports or link aggregates.

Examples
-> unp edge-profile unp-edge1
-> no unp edge-profile unp-edge1

page 36-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp edge-profile

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; maximum ingress-bandwidth, maximum egress-bandwidth, and maximum default-
depth parameters added.

Related Commands

unp edge-profile qos-policy-list Assigns a QoS policy list to an existing Edge profile.
unp edge-profile location- Assigns a UNP location policy to the specified Edge profile.
policy
unp edge-profile period-policy Assigns a UNP time-based policy to the specified Edge profile.
unp edge-profile captive- Configures the status of Captive Portal authentication for the specified
portal-authentication Edge profile.
unp edge-profile captive- Assigns a Captive Portal configuration to the specified Edge profile.
portal-profile
unp edge-profile Configures whether the specified Edge profile only allows authenticated
authentication-flag devices into the profile.
unp edge-profile mobile-tag Configures whether a tagged VLAN-port association is created for a
device port that is classified into the specified Edge profile.
unp edge-profile redirect Configures the redirect status for the specified Edge profile.
unp edge-profile maximum- Configures a maximum ingress bandwidth value that is applied to UNP
ingress-bandwidth ports associated with the specified Edge profile.
unp edge-profile maximum- Configures a maximum egress bandwidth value that is applied to UNP
egress-bandwidth ports associated with the specified Edge profile.
unp edge-profile maximum- Configures a maximum depth value that is applied to UNP ports
ingress-depth associated with the specified Edge profile.
show unp edge-profile Displays the Edge profile configuration for the switch.

MIB Objects
alaDaUNPEdgeProfTable
alaDaUNPEdgeProfName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-7
unp edge-profile qos-policy-list UNP Commands

unp edge-profile qos-policy-list

Configures the QoS policy list attribute for the specified Edge profile. Use this command to assign the
name of an existing QoS policy list to the Edge profile. A policy list contains QoS policy rules/ACLs that
are applied to devices classified with the associated profile.
unp edge-profile profile_name qos-policy-list list_name
no unp edge-profile profile_name qos-policy-list

Syntax Definitions

profile_name The name of a UNP Edge profile.

list_name The name of a policy list to associate with the specified UNP.

Defaults
By default, no profile attributes are enabled or defined when the Edge profile is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the QoS list name from the Edge profile configuration.

• Specifying a QoS policy list name that is inactive or does not already exist in the switch configuration
is allowed. However, the list will remain inactive for the UNP until the list is enabled or configured
using the QoS policy list command.

Examples
-> unp edge-profile qos-policy-list unp-edge1
-> no unp edge-profile qos-policy-list unp-edge1

Release History
Release 8.1.1; command was introduced.

page 36-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp edge-profile qos-policy-list

Related Commands

unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
policy list Configures a QoS policy list.
show unp edge-profile Displays the Edge profile configuration for the switch.

MIB Objects
alaDaUNPEdgeProfTable
alaDaUNPEdgeProfName
alaDaUNPEdgeProfQosPolicyList

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-9
unp edge-profile location-policy UNP Commands

unp edge-profile location-policy

Configures the location policy attribute for the specified Edge profile. Use this command to assign the
name of an existing UNP location policy to an Edge profile. This type of policy defines criteria (such as
the slot/port, system name and location) to determine if a device is accessing the network from a valid
location.
unp edge-profile profile_name location-policy policy_name
no unp edge-profile profile_name location-policy

Syntax Definitions

profile_name The name of a UNP Edge profile.

policy_name The name of an existing UNP location policy.

Defaults
By default, no profile attributes are enabled or defined when the Edge profile is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the location policy name from the Edge profile
configuration.
• The location policy name specified with this command must already exist in the switch configuration.

• If a UNP device does not meet the criteria applied through the location policy, the device role is
changed to unauthorized.

Examples
-> unp edge-profile unp-edge1 location-policy alu-na
-> no unp edge-profile unp-edge1 location-policy

Release History
Release 8.1.1; command was introduced.

page 36-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp edge-profile location-policy

Related Commands

unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
unp policy validity-location Configures a UNP location policy.
show unp edge-profile Displays the Edge profile configuration for the switch.

MIB Objects
alaDaUNPEdgeProfTable
alaDaUNPEdgeProfName
alaDaUNPEdgeProfLocationPolicy

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-11
unp edge-profile period-policy UNP Commands

unp edge-profile period-policy

Configures the period policy attribute for the specified Edge profile. Use this command to assign the name
of an existing UNP period policy to an Edge profile. This type of policy specifies the days and times
during which a device can access the network.
unp edge-profile profile_name period-policy policy_name
no unp edge-profile profile_name period-policy

Syntax Definitions

profile_name The name of a UNP Edge profile.

policy_name The name of an existing UNP period policy.

Defaults
By default, no profile attributes are enabled or defined when the Edge profile is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the period policy name from the Edge profile
configuration.
• The period policy name specified with this command must already exist in the switch configuration.

• If a UNP device does not meet the criteria applied through the period policy, the device role is changed
to unauthorized.

Examples
-> unp edge-profile unp-edge1 period-policy office-time
-> no unp edge-profile unp-edge1 period-policy

Release History
Release 8.1.1; command was introduced.

page 36-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp edge-profile period-policy

Related Commands

unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
unp policy validity-period Configures a UNP period policy.
show unp edge-profile Displays the Edge profile configuration for the switch.

MIB Objects
alaDaUNPEdgeProfTable
alaDaUNPEdgeProfName
alaDaUNPEdgeProfPeriodPolicy

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-13
unp edge-profile captive-portal-authentication UNP Commands

unp edge-profile captive-portal-authentication

Configures the status of Captive Portal (CP) authentication for the specified UNP Edge profile. When
enabled, the Captive Portal authentication process is triggered for devices classified into the profile.
unp edge-profile profile_name captive-portal-authentication {enable | disable}

Syntax Definitions

profile_name The name of a UNP Edge profile.

enable Enables Captive Portal authentication for profile devices.
disable Disables Captive Portal authentication for profile devices.

Defaults
By default, Captive Portal authentication is disabled for the Edge profile.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When CP authentication is enabled, the UNP user is assigned an implicit CP pre-login role to facilitate
the CP authentication process with the configured CP RADIUS server through the CP profile
associated with the Edge profile or the global CP configuration.
• If CP authentication for the device is successful, the user role is automatically changed according to the
CP pass policy list returned from the RADIUS server, if it is the highest precedence role known for the
user.
• If CP authentication for the device fails, the user role will be changed to the last known highest
precedence role for the user.

Examples
-> unp edge-profile unp-edge1 captive-portal-authentication enable
-> unp edge-profile unp-edge1 captive-portal-authentication disable

Release History
Release 8.1.1; command was introduced.

page 36-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp edge-profile captive-portal-authentication

Related Commands

unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
show unp edge-profile Displays the Edge profile configuration for the switch.

MIB Objects
alaDaUNPEdgeProfTable
alaDaUNPEdgeProfName
alaDaUNPEdgeProfCPortalAuth

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-15
unp edge-profile captive-portal-profile UNP Commands

unp edge-profile captive-portal-profile

Configures the Captive Portal (CP) profile attribute for the specified Edge profile. Use this command to
assign the name of an existing CP profile to an Edge profile. This type of profile defines a CP
configuration that is applied to devices when CP authentication is enabled for the Edge profile.
unp edge-profile profile_name captive-portal-profile cp_profile_name
no unp edge-profile profile_name captive-portal-profile

Syntax Definitions

profile_name The name of a UNP Edge profile.

cp_profile_name The name of an existing UNP Captive Portal profile.

Defaults
By default, no CP profile is assigned to an Edge profile.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the CP profile name from the Edge profile configuration.

• The CP profile name specified with this command must already exist in the switch configuration.

• The configuration defined in the CP profile overrides the global CP configuration for the switch.

Examples
-> unp edge-profile unp-edge1 captive-portal-profile cp-prof
-> no unp edge-profile unp-edge1 captive-portal-profile

Release History
Release 8.1.1; command was introduced.

page 36-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp edge-profile captive-portal-profile

Related Commands

unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
captive-portal-profile Configures a Captive Portal profile.
show unp edge-profile Displays the Edge profile configuration for the switch.

MIB Objects
alaDaUNPEdgeProfTable
alaDaUNPEdgeProfName
alaDaUNPEdgeProfCPortalProf

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-17
unp edge-profile authentication-flag UNP Commands

unp edge-profile authentication-flag

Configures the authentication flag status for the specified UNP Edge profile. When enabled, only devices
successfully authenticated are classified into the profile.
unp edge-profile profile_name authentication-flag {enable | disable}

Syntax Definitions

profile_name The name of a UNP Edge profile.

enable Allows only authenticated (802.1X or MAC) devices into the profile.
disable Allows authenticated or classified devices into the profile.

Defaults
By default, the authentication flag is disabled for the Edge profile.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
When the authentication flag is enabled for an Edge profile, devices that did not pass L2 authentication
(802.1X or MAC) are not allowed into the Edge profile. However, other configured classification options
are applied to such devices to determine the appropriate network access control for that device.

Examples
-> unp edge-profile unp-edge1 authentication-flag enable
-> unp edge-profile unp-edge1 authentication-flag disable

Release History
Release 8.1.1; command was introduced.

Related Commands

unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
show unp edge-profile Displays the Edge profile configuration for the switch.

MIB Objects
alaDaUNPEdgeProfTable
alaDaUNPEdgeProfName
alaDaUNPEdgeProfAuthStatus

page 36-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp edge-profile mobile-tag

unp edge-profile mobile-tag

Configures the mobile tag status for the specified UNP Edge profile. When enabled, the UNP port to
which a device is connected is tagged with the VLAN associated with the Edge profile when the device is
classified into that profile.
unp edge-profile profile_name mobile-tag {enable | disable}

Syntax Definitions

profile_name The name of a UNP Edge profile.

enable Enables the mobile tag status for the profile.
disable Disables the mobile tag status for the profile.

Defaults
By default, the mobile tag status is disabled for the Edge profile.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When the mobile tag status is disabled for an Edge profile, any user device classified into the profile
will remain learned in that profile. In this case, the tagged/untagged VLAN-port association would be
determined based on the user traffic which was learned as tagged or untagged, respectively.
• If the device port is already an untagged member of the VLAN associated with the profile, then a
tagged association is not created.

Examples
-> unp edge-profile unp-edge1 mobile-tag enable
-> unp edge-profile unp-edge1 mobile-tag disable

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-19
unp edge-profile mobile-tag UNP Commands

Related Commands

unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
show unp edge-profile Displays the Edge profile configuration for the switch.

MIB Objects
alaDaUNPEdgeProfTable
alaDaUNPEdgeProfName
alaDaUNPEdgeProfMobileTag

page 36-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp edge-profile redirect

unp edge-profile redirect

Configures the redirect status for the specified UNP Edge profile. When enabled, the Edge profile will
interact with the ClearPass Policy Manager (CPPM) as part of the OmniSwitch Bring Your Own Devices
(BYOD) solution.
unp edge-profile profile_name redirect {enable | disable}

Syntax Definitions

profile_name The name of a UNP Edge profile.

enable Enables the redirect status for the profile.
disable Disables the redirect status for the profile.

Defaults
By default, the redirect status is disabled for the Edge profile.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• An OmniSwitch Edge profile with redirect enabled must also exist in the CPPM configuration.

• To ensure proper redirection for devices classified into the profile, configure the redirection server as
the preferred server through authentication, authorization, and accounting (AAA) commands for MAC
and 802.1X authentication.

Examples
-> unp edge-profile unp-edge1 redirect enable
-> unp edge-profile unp-edge1 redirect disable

Release History
Release 8.1.1; command was introduced.

Related Commands

unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
show unp edge-profile Displays the Edge profile configuration for the switch.

MIB Objects
alaDaUNPEdgeProfTable
alaDaUNPEdgeProfName
alaDaUNPEdgeProfRedirectStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-21
unp edge-profile maximum-ingress-bandwidth UNP Commands

unp edge-profile maximum-ingress-bandwidth

Configures the maximum bandwidth limit allocated for ingress traffic on UNP ports assigned to the
specified Edge profile.
unp edge-profile profile_name maximum-ingress-bandwidth bps[k | m]
no unp edge-profile profile_name maximum-ingress-bandwidth

Syntax Definitions

profile_name The name of a UNP Edge profile.

bps[k | m] The maximum amount of bandwidth, in bits-per-second. The valid
range is 0–10485760. The value may be entered as an integer (for
example, 10) or with abbreviated units (for example, 10k, 5m).

Defaults
By default, the maximum ingress bandwidth value is not defined for the Edge profile.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the maximum ingress bandwidth value is specified as an integer without an abbreviated unit
designation, the value is applied in Kbps by default. For example, if the number 10 is specified, 10K is
the value applied.
• If the maximum ingress bandwidth value is set to zero, then all egress traffic is allowed on the UNP
port.
• The maximum ingress bandwidth, egress bandwidth, and depth values are applied to the port of a user
device that is classified into the specified Edge profile. If multiple user devices are classified into
different profiles but learned on the same UNP port, the bandwidth parameter values obtained for the
last user learned are applied on the port. Parameter values applied through previously learned users are
overwritten.

Examples
-> unp edge-profile unp-edge1 maximum-ingress-bandwidth 100
-> unp edge-profile unp-edge1 maximum-ingress-bandwidth 10m
-> no unp edge-profile unp-edge1 maximum-ingress-bandwidth

Release History
Release 8.2.1; command was introduced.

page 36-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp edge-profile maximum-ingress-bandwidth

Related Commands

unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
unp edge-profile maximum- Configures how much the traffic can burst over the maximum ingress
ingress-depth bandwidth rate.
show unp edge-profile Displays the Edge profile configuration for the switch.

MIB Objects
alaDaUNPEdgeProfTable
alaDaUNPEdgeProfName
alaDaUNPEdgeProfMaxIngressBw

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-23
unp edge-profile maximum-egress-bandwidth UNP Commands

unp edge-profile maximum-egress-bandwidth

Configures the maximum bandwidth limit allocated for egress traffic on UNP ports assigned to the
specified Edge profile.
unp edge-profile profile_name maximum-egress-bandwidth bps[k | m]
no unp edge-profile profile_name maximum-egress-bandwidth

Syntax Definitions

profile_name The name of a UNP Edge profile.

bps[k | m] The maximum amount of bandwidth, in bits-per-second. The valid
range is 0–10485760. The value may be entered as an integer (for
example, 10) or with abbreviated units (for example, 10k, 5m).

Defaults
By default, the maximum egress bandwidth value is not defined for the Edge profile.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the maximum egress bandwidth value is specified as an integer without an abbreviated unit
designation, the value is applied in Kbps by default. For example, if the number 10 is specified, 10K is
the value applied.
• If the maximum egress bandwidth value is set to zero, then all egress traffic is allowed on the UNP
port.
• The maximum ingress bandwidth, egress bandwidth, and depth values are applied to the port of a user
device that is classified into the specified Edge profile. If multiple user devices are classified into
different profiles but learned on the same UNP port, the bandwidth parameter values obtained for the
last user learned are applied on the port. Parameter values applied through previously learned users are
overwritten.

Examples
-> unp edge-profile unp-edge1 maximum-egress-bandwidth 100
-> unp edge-profile unp-edge1 maximum-egress-bandwidth 10m
-> no unp edge-profile unp-edge1 maximum-egress-bandwidth

Release History
Release 8.2.1; command was introduced.

page 36-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp edge-profile maximum-egress-bandwidth

Related Commands

unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
unp edge-profile maximum- Configures how much the traffic can burst over the maximum egress
egress-depth bandwidth rate.
show unp edge-profile Displays the Edge profile configuration for the switch.

MIB Objects
alaDaUNPEdgeProfTable
alaDaUNPEdgeProfName
alaDaUNPEdgeProfMaxEgressB

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-25
unp edge-profile maximum-ingress-depth UNP Commands

unp edge-profile maximum-ingress-depth

Configures the maximum ingress depth value that is applied to traffic on UNP ports that are assigned to
the specified UNP Edge profile. This value determines how much the traffic can burst over the maximum
ingress bandwidth rate.
unp edge-profile profile_name maximum-ingress-depth bps
no unp edge-profile profile_name maximum-ingress-depth

Syntax Definitions

profile_name The name of a UNP Edge profile.

bps The maximum ingress depth value in Kbps. The valid range is 0–16384.

Defaults
By default, the maximum ingress depth value is determined by dividing the maximum ingress bandwidth
value by 25. If the result of this calculation is 0 or 1, then 2K is used as the ingress depth value.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the maximum ingress depth value from the profile.

• The maximum ingress depth value is configured in conjunction with the maximum ingress bandwidth
parameter. When the ingress depth value is reached, the switch starts to drop packets.
• Configure the maximum ingress bandwidth rate (unp edge-profile maximum-ingress-bandwidth)
before attempting to set the maximum ingress depth value.
• The maximum ingress bandwidth and depth values are applied to the port of a user device that is
classified into the specified Edge profile. If multiple user devices are classified into different profiles
but learned on the same UNP port, the bandwidth parameter values obtained for the last user learned
are applied on the port. Parameter values applied through previously learned users are overwritten.

Examples
-> unp edge-profile unp-edge1 maximum-ingress-bandwidth 10
-> unp edge-profile unp-edge1 maximum-ingress-depth 5
-> no unp edge-profile unp-edge1 maximum-ingress-depth

Release History
Release 8.2.1; command was introduced.

page 36-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp edge-profile maximum-ingress-depth

Related Commands

unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
unp edge-profile maximum- Configures the maximum bandwidth limit allocated for ingress traffic
ingress-bandwidth on UNP ports assigned to the specified Edge profile.
show unp edge-profile Displays the Edge profile configuration for the switch.

MIB Objects
alaDaUNPEdgeProfTable
alaDaUNPEdgeProfName
alaDaUNPEdgeProfMaxIngressDepth

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-27
unp edge-profile maximum-egress-depth UNP Commands

unp edge-profile maximum-egress-depth

Configures the maximum egress depth value that is applied to traffic on UNP ports that are assigned to the
specified UNP Edge profile. This value determines how much the traffic can burst over the maximum
egress bandwidth rate.
unp edge-profile profile_name maximum-egress-depth bps
no unp edge-profile profile_name maximum-egress-depth

Syntax Definitions

profile_name The name of a UNP Edge profile.

bps The maximum egress depth value in Kbps. The valid range is 0–16384.

Defaults
By default, the maximum egress depth value is determined by dividing the maximum ingress bandwidth
value by 25. If the result of this calculation is 0 or 1, then 2K is used as the ingress depth value.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the maximum egress depth value from the profile.

• The maximum egress depth value is configured in conjunction with the maximum egress bandwidth
parameter. When the egress depth value is reached, the switch starts to drop packets.
• Configure the maximum egress bandwidth rate (unp edge-profile maximum-egress-bandwidth)
before attempting to set the maximum egress depth value.
• The maximum egress bandwidth and depth values are applied to the port of a user device that is
classified into the specified Edge profile. If multiple user devices are classified into different profiles
but learned on the same UNP port, the bandwidth parameter values obtained for the last user learned
are applied on the port. Parameter values applied through previously learned users are overwritten.

Examples
-> unp edge-profile unp-edge1 maximum-egress-bandwidth 10
-> unp edge-profile unp-edge1 maximum-egress-depth 5
-> no unp edge-profile unp-edge1 maximum-egress-depth

Release History
Release 8.2.1; command was introduced.

page 36-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp edge-profile maximum-egress-depth

Related Commands

unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
unp edge-profile maximum- Configures the maximum bandwidth limit allocated for egress traffic on
egress-bandwidth UNP ports assigned to the specified Edge profile.
show unp edge-profile Displays the Edge profile configuration for the switch.

MIB Objects
alaDaUNPEdgeProfTable
alaDaUNPEdgeProfName
alaDaUNPEdgeProfMaxEgressDepth

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-29
unp vlan-mapping edge-profile UNP Commands

unp vlan-mapping edge-profile

Configures the mapping of a standard VLAN to a UNP Edge profile. When a device is assigned to an
Edge profile through authentication or classification, the device and the port on which the device was
learned are dynamically assigned to the VLAN associated with the profile.
unp vlan-mapping edge-profile profile_name vlan vlan_id
no unp vlan-mapping edge-profile profile_name vlan

Syntax Definitions

edge-profile profile_name The name of an existing UNP Edge profile.

vlan_id The VLAN ID number to associate with the specified Edge profile
name. Devices assigned to the profile are assigned to the associated
VLAN.

Defaults
By default, no VLAN mapping configuration is applied to an Edge profile.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a VLAN mapping from the specified profile name.

• Only one VLAN is associated with an Edge profile at any given time.

• Configuring a new VLAN-to-profile mapping for an Edge profile will overwrite the existing VLAN
mapping for that profile.

Examples
-> unp vlan-mapping edge-profile UNP1 vlan 10
-> no unp vlan-mapping edge-profile UNP1 vlan

Release History
Release 8.1.1; command was introduced.

page 36-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp vlan-mapping edge-profile

Related Commands

unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
show unp edge-profile vlan- Displays the VLAN mapping configuration for the Edge profile.
mapping

MIB Objects
alaDaUNPVlanMapTable
alaDaUNPVlanMapEdgeProf
alaDaUNPVlanMapIdent
alaDaUNPVlanMapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-31
unp vlan-profile UNP Commands

unp vlan-profile
Configures a VLAN classification profile that is used to provide role-based access to the switch. This type
of UNP profile determines the VLAN a device can join and applies any additional profile-defined
attributes to the device.
When a VLAN profile is created with this command, the base command (unp vlan-profile profile_name
vlan vlan_id) may be used with other command keywords to define attributes for the specified profile.
These keywords are listed here and described as separate commands later in this chapter. In addition, some
keywords have a no form to remove the parameter or return it to its default.
unp vlan-profile profile_name vlan vlan_id
[qos-policy-list list_name]
[mobile-tag {enable | disable}]
[maximum ingress-bandwidth bps[k | m]]
[maximum egress-bandwidth bps[k | m]]
[maximum ingress-depth bps]
[maximum ingress-depth bps]
[saa-profile profile_name]
no unp vlan-profile profile_name

Syntax Definitions

vlan-profile profile_name The name to assign to the UNP VLAN profile.

vlan_id The VLAN ID number to associate with the specified VLAN profile.
Devices classified with the profile are assigned to the associated VLAN.

Defaults
By default, no profile attributes are enabled or defined when the VLAN profile is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a VLAN profile from the switch configuration.

• VLAN classification profiles are applied only to traffic received on ports or link aggregates configured
as UNP bridge ports.
• If the UNP dynamic VLAN configuration capability is enabled, a VLAN specified with this command
that does not exist in the switch configuration is automatically created when the UNP is created.

Note. Dynamic VLANs are not saved in the VLAN section of the boot.cfg file. However, the unp
commands to enable dynamic VLAN configuration and create a UNP are saved in the UNP section of the
boot.cfg file. As a result, the VLAN is created again on the next switch bootup.

page 36-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp vlan-profile

Examples
-> unp vlan-profile unp-vlan1 vlan 200
-> no unp vlan-profile unp-vlan1

Release History
Release 8.2.1; command was introduced.

Related Commands

unp vlan-profile qos-policy-list Assigns a QoS policy list to an existing VLAN profile.
unp vlan-profile mobile-tag Configures whether a tagged VLAN-port association is created for a
device port that is classified into the specified VLAN profile.
unp vlan-profile maximum- Configures a maximum ingress bandwidth value that is applied to UNP
ingress-bandwidth ports associated with the specified VLAN profile.
unp vlan-profile maximum- Configures a maximum egress bandwidth value that is applied to UNP
egress-bandwidth ports associated with the specified VLAN profile.
unp vlan-profile maximum- Configures a maximum ingress depth value that is applied to UNP ports
ingress-bandwidth associated with the specified VLAN profile.
unp vlan-profile maximum- Configures a maximum egress depth value that is applied to UNP ports
egress-bandwidth associated with the specified VLAN profile.
unp vlan-profile saa-profile Assigns a Service Assurance Agent (SAA) profile to a VLAN profile.
show unp vlan-profile Displays the VLAN profile configuration for the switch.

MIB Objects
alaDaUserNetProfileTable
alaDaUserNetProfileName
alaDaUserNetProfileVlanID

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-33
unp vlan-profile qos-policy-list UNP Commands

unp vlan-profile qos-policy-list

Configures the QoS policy list attribute for the specified VLAN profile. Use this command to assign the
name of a QoS policy list to the VLAN profile. A policy list contains QoS policy rules/ACLs that are
applied to devices classified with the associated profile.
unp vlan-profile profile_name vlan vlan_id qos-policy-list list_name
no unp vlan-profile profile_name qos-policy-list

Syntax Definitions

profile_name The name of a UNP VLAN profile.

vlan_id The VLAN ID number to associate with the specified VLAN profile.
Devices classified with the profile are assigned to the associated VLAN.
list_name The name of a QoS policy list to associate with the specified VLAN
profile.

Defaults
By default, no QoS policy list is assigned to the VLAN profile.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a QoS policy list from a VLAN profile configuration.

• Specifying a QoS policy list name that is inactive or does not already exist in the switch configuration
is allowed. However, the list will remain inactive for the UNP until the list is enabled or configured
using the QoS policy list command.

Examples
-> unp vlan-profile unp1 vlan 200 qos-policy-list list1
-> no unp vlan-profile unp1 qos-policy-list

Release History
Release 8.2.1; command was introduced.

page 36-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp vlan-profile qos-policy-list

Related Commands

unp vlan-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
policy list Configures a QoS policy list.
show unp vlan-profile Displays the VLAN profile configuration for the switch.

MIB Objects
alaDaUserNetProfileTable
alaDaUserNetProfileName
alaDaUserNetProfileVlanID
alaDaUserNetProfileQosPolicyListName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-35
unp vlan-profile mobile-tag UNP Commands

unp vlan-profile mobile-tag

Configures the mobile tag status for the specified UNP VLAN profile. When enabled, the UNP port to
which a device is connected is tagged with the VLAN associated with the VLAN profile when the device
is classified into that profile.
unp vlan-profile profile_name vlan vlan_id mobile-tag {enable | disable}

Syntax Definitions

profile_name The name of a UNP VLAN profile.

vlan_id The VLAN ID number to associate with the specified VLAN profile.
Devices classified with the profile are assigned to the associated VLAN.
enable Enables mobile tagging for the specified UNP VLAN profile.
disable Disables mobile tagging for the specified UNP VLAN profile.

Defaults
By default, mobile tagging is disabled for the VLAN profile.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When the mobile tag status is enabled, the first user device that is learned on a UNP port and
subsequently classified into a VLAN profile, triggers a tagged VLAN-port association between the
UNP port and the VLAN associated with the profile.
• When the mobile tag status is disabled, any user device classified into the VLAN profile will remain
learned in that profile. In this case, the tagged/untagged VLAN-port association is determined based on
the user traffic which was learned as tagged or untagged, respectively.
• If the device port is already an untagged member of the VLAN associated with the profile, then a
tagged association is not created.

Examples
-> unp vlan-profile unp2 vlan 501 mobile-tag enable
-> unp vlan-profile unp2 vlan 501 mobile-tag disable

Release History
Release 8.2.1; command was introduced.

page 36-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp vlan-profile mobile-tag

Related Commands

unp vlan-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
show unp vlan-profile Displays the VLAN profile configuration for the switch.

MIB Objects
alaDaUserNetProfileTable
alaDaUserNetProfileName
alaDaUserNetProfileVlanID
alaDaUserNetProfileMobileTag

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-37
unp vlan-profile maximum-ingress-bandwidth UNP Commands

unp vlan-profile maximum-ingress-bandwidth

Configures the maximum bandwidth limit allocated for ingress traffic on UNP ports assigned to the
specified VLAN profile.
unp vlan-profile profile_name maximum-ingress-bandwidth bps[k | m]
no unp vlan-profile profile_name maximum-ingress-bandwidth

Syntax Definitions

profile_name The name of a UNP VLAN profile.

bps[k | m] The maximum amount of bandwidth, in bits-per-second. The valid
range is 0–10485760. The value may be entered as an integer (for
example, 10) or with abbreviated units (for example, 10k, 5m).

Defaults
By default, the maximum ingress bandwidth value is not defined for the VLAN profile.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the maximum ingress bandwidth value is specified as an integer without an abbreviated unit
designation, the value is applied in kbps by default. For example, if the number 10 is specified, 10K is
the value applied.
• If the maximum ingress bandwidth value is set to zero, then all egress traffic is allowed on the UNP
port.
• The maximum ingress bandwidth, egress bandwidth, and depth values are applied to the port of a user
device that is classified into the specified VLAN profile. If multiple user devices are classified into
different profiles but learned on the same UNP port, the bandwidth parameter values obtained for the
last user learned are applied on the port. Parameter values applied through previously learned users are
overwritten.

Examples
-> unp vlan-profile unp1 maximum-ingress-bandwidth 100
-> unp vlan-profile unp1 maximum-ingress-bandwidth 10m
-> no unp vlan-profile unp1 maximum-ingress-bandwidth

Release History
Release 8.2.1; command was introduced.

page 36-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp vlan-profile maximum-ingress-bandwidth

Related Commands

unp vlan-profile Configures a UNP VLAN profile. This type of profile is applied to
traffic learned on UNP bridge ports and link aggregates.
show unp vlan-profile Displays the VLAN profile configuration for the switch.

MIB Objects
alaDaUserNetProfileTable
alaDaUserNetProfileName
alaDaUserNetProfileVlanID
alaDaUserNetProfileMaxIngressBw

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-39
unp vlan-profile maximum-egress-bandwidth UNP Commands

unp vlan-profile maximum-egress-bandwidth

Configures the maximum bandwidth limit allocated for egress traffic on UNP ports assigned to the
specified VLAN profile.
unp vlan-profile profile_name maximum-egress-bandwidth bps[k | m]
no unp vlan-profile profile_name maximum-egress-bandwidth

Syntax Definitions

profile_name The name of a UNP VLAN profile.

bps[k | m] The maximum amount of bandwidth, in bits-per-second. The valid
range is 0–10485760. The value may be entered as an integer (for
example, 10) or with abbreviated units (for example, 10k, 5m).

Defaults
By default, the maximum egress bandwidth value is not defined for the VLAN profile.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If the maximum egress bandwidth value is specified as an integer without an abbreviated unit
designation, the value is applied in kbps by default. For example, if the number 10 is specified, 10K is
the value applied.
• If the maximum egress bandwidth value is set to zero, then all egress traffic is allowed on the UNP
port.
• The maximum ingress bandwidth, egress bandwidth, and depth values are applied to the port of a user
device that is classified into the specified VLAN profile. If multiple user devices are classified into
different profiles but learned on the same UNP port, the bandwidth parameter values obtained for the
last user learned are applied on the port. Parameter values applied through previously learned users are
overwritten.

Examples
-> unp vlan-profile unp1 maximum-egress-bandwidth 100
-> unp vlan-profile unp1 maximum-egress-bandwidth 10m
-> no unp vlan-profile unp1 maximum-egress-bandwidth

Release History
Release 8.2.1; command was introduced.

page 36-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp vlan-profile maximum-egress-bandwidth

Related Commands

unp vlan-profile Configures a UNP VLAN profile. This type of profile is applied to
traffic learned on UNP bridge ports and link aggregates.
show unp vlan-profile Displays the VLAN profile configuration for the switch.

MIB Objects
alaDaUserNetProfileTable
alaDaUserNetProfileName
alaDaUserNetProfileVlanID
alaDaUserNetProfileMaxEgressBw

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-41
unp vlan-profile maximum-ingress-depth UNP Commands

unp vlan-profile maximum-ingress-depth

Configures the maximum ingress depth value that is applied to traffic on UNP ports that are assigned to
the specified UNP VLAN profile. This value determines how much the traffic can burst over the
maximum ingress bandwidth rate.
unp vlan-profile profile_name maximum-ingress-depth bps
no unp vlan-profile profile_name maximum-ingress-depth

Syntax Definitions

profile_name The name of a UNP VLAN profile.

bps The maximum ingress depth value in Kbps. The valid range is 0–16384.

Defaults
By default, the maximum ingress depth value is determined by dividing the maximum ingress bandwidth
value by 25. If the result of this calculation is 0 or 1, then 2K is used as the ingress depth value.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the maximum ingress depth value from the profile.

• The maximum ingress depth value is configured in conjunction with the maximum ingress bandwidth
parameter. When the ingress depth value is reached, the switch starts to drop packets.
• Configure the maximum ingress bandwidth rate (unp vlan-profile maximum-ingress-bandwidth)
before attempting to set the maximum ingress depth value.
• The maximum ingress bandwidth and depth values are applied to the port of a user device that is
classified into the specified VLAN profile. If multiple user devices are classified into different profiles
but learned on the same UNP port, the bandwidth parameter values obtained for the last user learned
are applied on the port. Parameter values applied through previously learned users are overwritten.

Examples
-> unp vlan-profile unp-vlan10 maximum-ingress-bandwidth 10
-> unp vlan-profile unp-vlan10 maximum-ingress-depth 5
-> no unp vlan-profile unp-vlan10 maximum-ingress-depth

Release History
Release 8.2.1; command was introduced.

page 36-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp vlan-profile maximum-ingress-depth

Related Commands

unp vlan-profile Configures a UNP VLAN profile. This type of profile is applied to
traffic learned on UNP bridge ports and link aggregates.
unp vlan-profile maximum- Configures the maximum bandwidth limit allocated for ingress traffic
ingress-bandwidth on UNP ports assigned to the specified VLAN profile.
show unp vlan-profile Displays the VLAN profile configuration for the switch.

MIB Objects
alaDaUserNetProfileTable
alaDaUserNetProfileName
alaDaUserNetProfileVlanID
alaDaUserNetProfileMaxIngressDepth

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-43
unp vlan-profile maximum-egress-depth UNP Commands

unp vlan-profile maximum-egress-depth

Configures the maximum egress depth value that is applied to traffic on UNP ports that are assigned to the
specified UNP VLAN profile. This value determines how much the traffic can burst over the maximum
egress bandwidth rate.
unp vlan-profile profile_name maximum-egress-depth bps
no unp vlan-profile profile_name maximum-egress-depth

Syntax Definitions

profile_name The name of a UNP VLAN profile.

bps The maximum egress depth value in Kbps. The valid range is 0–16384.

Defaults
By default, the maximum egress depth value is determined by dividing the maximum egress bandwidth
value by 25. If the result of this calculation is 0 or 1, then 2K is used as the egress depth value.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the maximum egress depth value from the profile.

• The maximum egress depth value is configured in conjunction with the maximum egress bandwidth
parameter. When the egress depth value is reached, the switch starts to drop packets.
• Configure the maximum egress bandwidth rate (unp vlan-profile maximum-egress-bandwidth)
before attempting to set the maximum egress depth value.
• The maximum egress bandwidth and depth values are applied to the port of a user device that is
classified into the specified VLAN profile. If multiple user devices are classified into different profiles
but learned on the same UNP port, the bandwidth parameter values obtained for the last user learned
are applied on the port. Parameter values applied through previously learned users are overwritten.

Examples
-> unp vlan-profile unp-vlan10 maximum-egress-bandwidth 10
-> unp vlan-profile unp-vlan10 maximum-egress-depth 5
-> no unp vlan-profile unp-vlan10 maximum-egress-depth

Release History
Release 8.2.1; command was introduced.

page 36-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp vlan-profile maximum-egress-depth

Related Commands

unp vlan-profile Configures a UNP VLAN profile. This type of profile is applied to
traffic learned on UNP bridge ports and link aggregates.
unp vlan-profile maximum- Configures the maximum bandwidth limit allocated for egress traffic on
egress-bandwidth UNP ports assigned to the specified VLAN profile.
show unp vlan-profile Displays the VLAN profile configuration for the switch.

MIB Objects
alaDaUserNetProfileTable
alaDaUserNetProfileName
alaDaUserNetProfileVlanID
alaDaUserNetProfileMaxEgressDepth

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-45
unp vlan-profile saa-profile UNP Commands

unp vlan-profile saa-profile

Note: This command is not supported in this release.

Assigns a Service Assurance Agent (SAA) profile to the specified VLAN profile. Although an SAA
profile can be assigned to a VLAN profile with this command, an SAA profile is mainly used by the
Alcatel-Lucent OmniVista network management application to monitor connections between virtual
machines (VMs) in a data center network.
unp vlan-profile profile_name saa-profile profile_name
no unp vlan-profile profile_name saa-profile

Syntax Definitions

vlan-profile profile_name The name of a UNP VLAN profile.

saa-profile profile_name The name of the SAA profile to assign to the UNP VLAN profile.

Defaults
By default, no SAA profile is assigned to the VLAN profile.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an SAA profile assignment from a VLAN profile
configuration.
• The SAA profile specified with this command must already exist in the switch configuration.

Examples
-> unp vlan-profile unp1 vlan 200 saa-profile saa1
-> no unp vlan-profile unp1 saa-profile

Release History
Release 8.2.1; command was introduced.

page 36-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp vlan-profile saa-profile

Related Commands

unp vlan-profile Configures a UNP VLAN profile. This type of profile is applied to
traffic learned on UNP bridge ports and link aggregates.
unp saa-profile Configures an SAA profile.
show unp vlan-profile Displays the VLAN profile configuration for the switch.

MIB Objects
alaDaUserNetProfileTable
alaDaUserNetProfileName
alaDaUserNetProfileVlanID
alaDaUserNetProfileSaaProfileNam

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-47
unp spb-profile UNP Commands

unp spb-profile
Configures a service classification profile that is used to provide role-based access to the switch. This type
of UNP profile determines the Shortest Path Bridging (SPB) service a device can join and applies any
additional profile-defined attributes to the device.
When a service profile is created with this command, the base command (unp spb-profile profile_name
tag-value {0 | qtag | outer_qtag:inner_qtag} isid instance_id bvlan bvlan_id) may be used with other
command keywords to define attributes for the specified profile. These keywords are listed here and
described as separate commands later in this chapter. In addition, some keywords have a no form to
remove the parameter or return it to its default.
unp spb-profile profile_name tag-value {0 | qtag | outer_qtag:inner_qtag} isid instance_id bvlan
bvlan_id
[qos-policy-list list_name]
[multicast-mode {headend | tandem}]
[vlan-xlation {enable | disable}]
[mobile-tag {enable | disable}]
no unp spb-profile profile_name

Syntax Definitions

profile_name The name to assign to the UNP service profile.

0 Use VLAN tag information from classified traffic to create the Service
Access Point (SAP) for the traffic. If the traffic is untagged, the SAP is
created with 0 as the encapsulation value (for example, 1/12:0).
qtag The outer VLAN ID tag to use when creating a SAP for single-tagged
traffic.
outer_qtag:inner_qtag An outer VLAN ID tag and an inner VLAN tag to use when creating a
SAP for double-tagged (QinQ) classified traffic.
instance_id A service instance identifier (I-SID) that is used to identify an SPB
service in a provider backbone bridge (PBB) network. The valid range is
256–16777214.
bvlan_id The VLAN ID number of an existing SPB backbone VLAN (BVLAN).

Defaults
By default, no profile attributes are enabled or defined when the SPB service profile is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the service profile from the switch configuration.

• UNP service classification profiles are applied only to traffic received on ports or link aggregates
configured as UNP service access ports.

page 36-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp spb-profile

• The tag-value parameter specifies the VLAN tag values that are used to create the SAP to which
profile traffic is mapped. The SAP is then bound to the I-SID and BVLAN profile values specified
with this command.
• Consider the following when configuring the profile tag value:
– If the tag value is set to zero, the SAP for the classified traffic is created using the VLAN tags of the
traffic. For example, a SAP with an encapsulation value set to 1/12:5 is created when classified
traffic received on port 1/12 is single-tagged with VLAN ID 5.
– Enabling the trust VLAN tag option for the UNP service port triggers the same functionality as
setting the service profile tag value to zero. In both cases, the VLAN tags of the classified traffic are
used to specify the encapsulation value of the SAP to which the traffic is mapped.
– If the trust VLAN tag option is disabled for the UNP port and the service profile tag value is not set
to zero (for example, tag-value 10), the VLAN tag values of the classified traffic are compared to
the configured profile tag value. If the traffic tag values match the profile tag value, the traffic is
mapped to the appropriate SAP. If the traffic tags do not match, traffic is not mapped to a SAP.
• UNP first checks the switch configuration to see if a SAP already exists for the expected VLAN tag
value (CVLAN tags) and I-SID. If a SAP already exists, the MAC addresses are learned on that SAP.
If the SAP does not exist, the switch dynamically creates a SAP for the profile traffic.
• If the I-SID specified with this command does not exist in the switch configuration, the switch will
dynamically create the expected service and then the SAP as needed.
• The BVLAN ID specified with this command must already exist in the switch configuration.

• Dynamically creating services and related SAPs is subject to available switch resources. If an attempt
to dynamically create a service or SAP fails, the MAC addresses classified for the service profile are
learned as filtering.

Examples
-> unp spb-profile spb1 tag-value 10 isid 1525 bvlan 4001
-> no spb-profile spb1 tag-value 20:100 isid 1525 bvlan 4001

Release History
Release 8.2.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-49
unp spb-profile UNP Commands

Related Commands

unp port Configures the port type (service access, edge, or bridge) for the
specified port or link aggregate.
unp spb-profile qos-policy-list Assigns a QoS policy list name to the SPB profile.
unp spb-profile multicast-mode Selects the multicast replication mode for the SPB service associated
with the profile.
unp spb-profile vlan-xlation Configures the VLAN translation status for the SPB service associated
with the profile.
unp spb-profile mobile-tag Configures the mobile tag status for the SPB service associated with the
profile.
service spb Configures an SPB service, which identifies the SPB I-SID value.
show unp spb-profile Displays the service-based profile configuration for the switch.

MIB Objects
alaDaSpbProfileTable
alaDaSpbProfileName
alaDaSpbProfileEncapVal
alaDaSpbProfileIsid
alaDaSpbProfileBVlan

page 36-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp spb-profile qos-policy-list

unp spb-profile qos-policy-list

Configures the QoS policy list attribute for the specified SPB service profile. Use this command to assign
the name of a QoS policy list to the profile. The policy list contains QoS policy rules/ACLs that are
applied to devices classified with the UNP.
unp spb-profile profile_name tag-value {0 | qtag | outer_qtag:inner_qtag} isid instance_id bvlan
bvlan_id [qos-policy-list list_name]
no unp spb-profile profile_name qos-policy-list

Syntax Definitions

profile_name The name of an SPB service profile.

0 Use VLAN tag information from classified traffic to create the Service
Access Point (SAP) for the traffic. If the traffic is untagged, the SAP is
created with 0 as the encapsulation value (for example, 1/12:0).
qtag The outer VLAN ID tag to use when creating a SAP for single-tagged
traffic.
outer_qtag:inner_qtag An outer VLAN ID tag and an inner VLAN tag to use when creating a
SAP for double-tagged (QinQ) classified traffic.
instance_id A service instance identifier (I-SID) that is used to identify an SPB
service in a provider backbone bridge (PBB) network. The valid range is
256–16777214.
bvlan_id The VLAN ID number of an existing SPB backbone VLAN (BVLAN).
list_name The name of a policy list to associate with the specified UNP.

Defaults
By default, no QoS policy list is assigned to the SPB service profile.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the QoS policy list from an SPB service profile
configuration.
• Specifying a QoS policy list name that is inactive or does not already exist in the switch configuration
is allowed. However, the list will remain inactive for the UNP until the list is enabled or configured
using the QoS policy list command.

Examples
-> unp spb-profile spb2 tag-value 20:100 isid 1525 bvlan 4001 qos-policy-list list1
-> no spb-profile spb1 qos-policy-list

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-51
unp spb-profile qos-policy-list UNP Commands

Release History
Release 8.2.1; command was introduced.

Related Commands

unp spb-profile Configures a UNP VLAN profile. This type of profile is applied to
traffic learned on UNP bridge ports and link aggregates.
policy list Configures a QoS policy list.
show unp spb-profile Displays the service-based profile configuration for the switch.

MIB Objects
alaDaSpbProfileTable
alaDaSpbProfileName
alaDaSpbProfileEncapVal
alaDaSpbProfileQosPolicyListName
alaDaSpbProfileIsid
alaDaSpbProfileBVlan

page 36-52 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp spb-profile multicast-mode

unp spb-profile multicast-mode

Configures the multicast mode attribute for the specified SPB service profile. Use this command to specify
the replication mode for the SPB service that is associated with the SPB profile.
unp spb-profile profile_name tag-value {0 | qtag | outer_qtag:inner_qtag} isid instance_id bvlan
bvlan_id multicast-mode {headend | tandem}

Syntax Definitions

profile_name The name of an SPB service profile.

0 Use VLAN tag information from classified traffic to create the Service
Access Point (SAP) for the traffic. If the traffic is untagged, the SAP is
created with 0 as the encapsulation value (for example, 1/12:0).
qtag The outer VLAN ID tag to use when creating a SAP for single-tagged
traffic.
outer_qtag:inner_qtag An outer VLAN ID tag and an inner VLAN tag to use when creating a
SAP for double-tagged (QinQ) classified traffic.
instance_id A service instance identifier (I-SID) that is used to identify an SPB
service in a provider backbone bridge (PBB) network. The valid range is
256–16777214.
bvlan_id The VLAN ID number of an existing SPB backbone VLAN (BVLAN).
headend Specifies the head-end replication mode.
tandem Specifies the tandem replication mode.

Defaults
By default, the multicast mode is set to headend.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When an SPB service is configured to use the head-end multicast mode, a non-unicast packet received
on an SPB access port is replicated once for each receiver in the provider backbone bridge (PBB)
network using its unicast base MAC (BMAC) address.
• When a SPB service is configured to use the tandem multicast mode, a non-unicast packet received on
an SPB access port is replicated once at each node using the multicast group address.

Examples
-> unp spb-profile spb3 tag-value 200 isid 1500 bvlan 4002 multicast-mode tandem
-> unp spb-profile spb3 tag-value 200 isid 1500 bvlan 4002 multicast-mode headend

Release History
Release 8.2.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-53
unp spb-profile multicast-mode UNP Commands

Related Commands

unp spb-profile Configures a UNP VLAN profile. This type of profile is applied to
traffic learned on UNP bridge ports and link aggregates.
show unp spb-profile Displays the service-based profile configuration for the switch.

MIB Objects
alaDaSpbProfileTable
alaDaSpbProfileName
alaDaSpbProfileEncapVal
alaDaSpbProfileQosPolicyListName
alaDaSpbProfileIsid
alaDaSpbProfileBVlan
alaDaSpbProfileMulticastMode

page 36-54 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp spb-profile vlan-xlation

unp spb-profile vlan-xlation

Configures the status of VLAN translation for the specified SPB service profile.
unp spb-profile profile_name tag-value {0 | qtag | outer_qtag:inner_qtag} isid instance_id bvlan
bvlan_id vlan-xlation {enable | disable}

Syntax Definitions

profile_name The name of an SPB service profile.

0 Use VLAN tag information from classified traffic to create the Service
Access Point (SAP) for the traffic. If the traffic is untagged, the SAP is
created with 0 as the encapsulation value (for example, 1/12:0).
qtag The outer VLAN ID tag to use when creating a SAP for single-tagged
traffic.
outer_qtag:inner_qtag An outer VLAN ID tag and an inner VLAN tag to use when creating a
SAP for double-tagged (QinQ) classified traffic.
instance_id A service instance identifier (I-SID) that is used to identify an SPB
service in a provider backbone bridge (PBB) network. The valid range is
256–16777214.
bvlan_id The VLAN ID number of an existing SPB backbone VLAN (BVLAN).
list_name The name of a policy list to associate with the specified UNP. The
policy list contains QoS policy rules/ACLs that are applied to devices
classified with the UNP.
enable Enables egress VLAN translation for the SPB service associated with
this UNP.
disable Disables egress VLAN translation for the SPB service associated with
this UNP.

Defaults
By default, the VLAN translation mode is disabled for the SPB service profile.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enabling VLAN translation at the service level is only applicable if the corresponding SPB access
ports for the SPB Service Access Points (SAPs) also have VLAN translation enabled.
• When VLAN translation is enabled for the profile, the VLAN tags for profile traffic are processed
according to the settings for the SAP on which the frames will egress, not according to the settings for
the SAP on which the frames were received.

Examples
-> unp spb-profile spb3 tag-value 200 isid 1500 bvlan 4002 vlan-xlation enable

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-55
unp spb-profile vlan-xlation UNP Commands

-> unp spb-profile spb3 tag-value 200 isid 1500 bvlan 4002 vlan-xlation disable

Release History
Release 8.2.1; command was introduced.

Related Commands

unp spb-profile Configures a UNP VLAN profile. This type of profile is applied to
traffic learned on UNP bridge ports and link aggregates.
show unp spb-profile Displays the service-based profile configuration for the switch.

MIB Objects
alaDaSpbProfileTable
alaDaSpbProfileName
alaDaSpbProfileEncapVal
alaDaSpbProfileQosPolicyListName
alaDaSpbProfileIsid
alaDaSpbProfileBVlan
alaDaSpbProfileSapVlanXlation

page 36-56 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp spb-profile mobile-tag

unp spb-profile mobile-tag

Configures the mobile tag attribute for the specified SPB service profile.
unp spb-profile profile_name tag-value {0 | qtag | outer_qtag:inner_qtag} isid instance_id bvlan
bvlan_id [mobile-tag {enable | disable}]

Syntax Definitions

profile_name The name of an SPB service profile.

0 Use VLAN tag information from classified traffic to create the Service
Access Point (SAP) for the traffic. If the traffic is untagged, the SAP is
created with 0 as the encapsulation value (for example, 1/12:0).
qtag The outer VLAN ID tag to use when creating a SAP for single-tagged
traffic.
outer_qtag:inner_qtag An outer VLAN ID tag and an inner VLAN tag to use when creating a
SAP for double-tagged (QinQ) classified traffic.
instance_id A service instance identifier (I-SID) that is used to identify an SPB
service in a provider backbone bridge (PBB) network. The valid range is
256–16777214.
bvlan_id The VLAN ID number of an existing SPB backbone VLAN (BVLAN).
mobile-tag enable Enables mobile tagging of egress packets for the service associated with
this UNP.
mobile-tag disable Disables mobile tagging of egress packets for the service associated
with this UNP.

Defaults
By default, the mobile tag status is disabled for the SPB service profile.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When the mobile tag status is enabled, the first user device that is learned on a UNP access port and
subsequently classified into an SPB service profile, triggers a tagged VLAN-port association between
the UNP port and the BVLAN associated with the profile.
• When the mobile tag status is disabled, any user device classified into the SPB profile will remain
learned in that profile. In this case, the tagged/untagged VLAN-port association is determined based on
the user traffic which was learned as tagged or untagged, respectively.

Examples
-> unp spb-profile spb3 tag-value 200 isid 1500 bvlan 4002 mobile-tag enable
-> unp spb-profile spb3 tag-value 200 isid 1500 bvlan 4002 mobile-tag disable

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-57
unp spb-profile mobile-tag UNP Commands

Release History
Release 8.2.1; command was introduced.

Related Commands

unp spb-profile Configures a UNP VLAN profile. This type of profile is applied to
traffic learned on UNP bridge ports and link aggregates.
show unp spb-profile Displays the service-based profile configuration for the switch.

MIB Objects
alaDaSpbProfileTable
alaDaSpbProfileName
alaDaSpbProfileEncapVal
alaDaSpbProfileQosPolicyListName
alaDaSpbProfileIsid
alaDaSpbProfileBVlan
alaDaSpbProfileMobileTag

page 36-58 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp saa-profile

unp saa-profile

Note: This command is not supported in this release.

Configures a Service Assurance Agent (SAA) performance monitoring profile. This type of profile is
assigned to UNP VLAN profiles to specify jitter and latency threshold values for SAA sessions that apply
to the assigned UNP VLAN profile.
unp saa-profile profile_name [jitter-threshold jitter_thresh] [latency-threshold latency_thresh]
no unp saa-profile profile_name

Syntax Definitions

profile_name The name to assign to the SAA profile.

jitter_thresh The jitter threshold value, in microseconds. A trap is generated when
this value is crossed. The valid range is 0–1000000.
latency_thresh The latency threshold value, in microseconds. A trap is generated when
this value is crossed. The valid range is 0–1000000.

Defaults

parameter default
jitter_thresh 0 (disabled)
latency_thresh 0 (disabled)

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the SAA profile from the switch configuration.

• Although SAA profiles can be configured and assigned to a UNP through the CLI, these profiles are
mainly used by the Alcatel-Lucent OmniVista network management application to trigger SAA
sessions that monitor connections between virtual machines (VMs) in a data center network.
• Assigning SAA profiles is supported only with UNP VLAN-based profiles; UNP service-based
profiles do not support this functionality.

Examples
-> unp saa-profile unp_saa1 jitter-threshold 100 latency-threshold 500
-> unp saa-profile unp_saa2 jitter-threshold 150
-> unp saa-profile unp_saa3 latency-threshold 250

Release History
Release 8.2.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-59
unp saa-profile UNP Commands

Related Commands

unp vlan-profile Configures a UNP VLAN profile.

show unp vlan-profile Displays the UNP VLAN profile configuration for the switch.
show unp saa-profile Displays the SAA profile configuration for the switch.

MIB Objects
alaDaSaaProfileTable
alaDaSaaProfileName
alaDaSaaProfileLatencyThreshold
alaDaSaaProfileJitterThreshold

page 36-60 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp port

unp port
Configures UNP functionality on a port or link aggregate.
unp {port chassis/slot/port[-port2] | linkagg agg_id} [port-type {edge | bridge | spb-access}]
no unp {port chassis/slot/port[-port2] | linkagg agg_id}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id The link aggregate ID number.
edge Configures the specified port or link aggregate as an edge port. This port
type is used for classifying traffic into Edge-based profiles.
bridge Configures the specified port or link aggregate as a standard bridge port.
This port type is used for classifying traffic into VLAN-based profiles.
spb-access Configures the specified port or link aggregate as a Shortest Path
Bridging (SPB) service access port. This port type is used for classifying
traffic into service-based SPB profiles.

Defaults
By default, UNP is disabled on all ports and link aggregates. However, when UNP is enable on a port or
link aggregate, the following default port type value applies:

parameter default
edge | bridge | spb-access edge

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the UNP configuration from a port or link aggregate.

• To change the port type of an existing UNP port, remove the current UNP configuration first using the
no unp port or no unp linkagg command then use the unp port-type command to set the new port
type.
• Any configuration change to a UNP-enabled port will flush all MAC addresses learned on that port.
This applies only to CLI commands used to configure UNP port parameters.
• There is no limit to the number of switch ports that can have UNP enabled.

• Traffic received on UNP edge, bridge, and service access ports is classified as follows:
– UNP edge port traffic is classified using Edge-based profiles.
– UNP bridge port traffic is classified using VLAN-based profiles.
– UNP service access port traffic is classified using service-based SPB profiles.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-61
unp port UNP Commands

• Enabling UNP is not supported on the following port types:

– 802.1q-tagged ports.
– MVRP ports.
– Port Mirroring destination ports (MTP).
– Port Mapping network ports.
– STP and ERP ports.
– Ports on which a static MAC address is configured.
– Ports on which dynamic Source Learning is disabled.
– VLAN Stacking (Ethernet Services NNI or UNI) ports.
– Service Manager access and network ports.
– Ethernet OAM ports.
– Edge Virtual Bridging (EVB) ports.
• UNP and Learned Port Security (LPS) are supported on the same port with the following conditions:
– LPS is not supported on link aggregates.
– The LPS learning window is set globally but not on a per-port basis. So the window applies to all
UNP ports.
– When LPS is enabled or disabled on a UNP edge or bridge port (LPS is not supported on UNP
access ports), MAC addresses already learned on that port are flushed.
– Configuring a static MAC address is not allowed on a UNP port unless LPS is also enabled on the
same port.
– When both LPS and UNP are enabled on the same port, UNP first authenticates and classifies any
MAC addresses received, then LPS rules are applied. If a MAC address violates any of the LPS
rules for the port, the address may get filtered or the port violated even if UNP initially determined
the address was valid. In other words, LPS rules take precedence over UNP to determine if a MAC
address is bridged or filtered on the port.
– If UNP classifies a MAC address as learning but LPS learns the address as filtering, an untagged
packet will show as filtering in the default VLAN for the port and a tagged packet MAC will show
as filtering in the specific tagged VLAN.
– When a MAC address is filtered by LPS, the show unp edge-user command will display “LPS-
Blocked” as the classification source for that MAC address.
• UNP ports support both tagged and untagged packets. If the VLAN ID of a tagged packet matches the
VLAN associated with a UNP into which the packet was classified, the packet is learned as forwarding
and a tagged VLAN-port association is created. However, if the VLAN ID tag does not match the
VLAN ID associated with the profile, the packet is filtered.
• UNP edge and bridge ports support single-tagged packets. However, double-tagged packets are treated
the same as single-tagged packets in that UNP will only use the outer VLAN tag to determine how the
packet is processed on the UNP bridge port.
• UNP access ports use the inner VLAN tag of double-tagged packets received on the port to determine
the service access port (SAP) to use or create for forwarding the traffic on the network backbone.

Examples
-> unp port 2/1/1
-> unp port 1/1/5-10 port-type bridge

page 36-62 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp port

-> unp port 1/15-20 port-type spb-access

-> unp linkagg 10 port-type edge
-> unp linkagg 2-5 port-type bridge
-> no unp port 2/1/1
-> no unp linkagg 10

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; bridge and spb-access parameters added.

Related Commands

unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
received on UNP Edge ports.
unp vlan-profile Configures a UNP VLAN profile. This type of profile is applied to
traffic received on UNP bridge ports.
unp spb-profile Configures a UNP SPB profile. This type of profile is applies to traffic
received on UNP service access ports.
show unp port Displays the UNP configuration for the port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPortIfIndex
alaDaUNPPortType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-63
unp redirect port-bounce UNP Commands

unp redirect port-bounce

Enables or disables the port bounce action on the specified UNP port or globally for the switch. When
enabled, a port bounce is triggered upon receipt of a RADIUS Change of Authorization (COA) or a
Disconnect request (DM) message from a redirection server to enforce a user role or terminate a user
session.
unp [port chassis/slot/port1[-port2]] redirect port-bounce {enable | disable}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific UNP edge
port. Use a hyphen to specify a range of ports (3/1/1-8).
enable Enables the port bounce function.
disable Disables the port bounce function.

Defaults
By default, port bounce is enabled on all UNP ports.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the port parameter to enable or disable the port bounce status for a specific UNP edge port. Note
that port bounce is not supported on link aggregates or on UNP bridge or access ports.
• If a port is not specified with this command, then the port bounce status is enabled or disabled for all
UNP edge ports on the entire switch.
• The port bounce action only applies to a MAC authenticated non-supplicant (non-802.1x device). If the
device is a supplicant (802.1X device), then an EAP-Fail frame is sent instead. In both cases, re-
authentication is triggered for both types of devices.
• The port-level setting of the port bounce action overrides the global setting for the switch. The
following table indicates when a port is toggled based on the status of port bounce at the global and
port level:

Global Port Bounce Per-Port Bounce Action

Enabled Disabled Port is not toggled
Enabled Enabled Port is toggled
Disabled Enabled Port is toggled
Disabled Disabled Port is not toggled

• This command is used when configuring the switch to interact with the ClearPass Policy Manager
(CPPM) as part of the OmniSwitch Bring Your Own Devices (BYOD) solution.

page 36-64 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp redirect port-bounce

Examples
-> unp port 1/1/6 redirect port-bounce disable
-> unp redirect port-bounce disable

Release History
Release 8.1.1; command was introduced.

Related Commands

show unp global configuration Displays the profile designated as the authentication server down UNP
for the switch.

MIB Objects
alaDaUNPPortTable
alaDaUNPPortIfIndex
alaDaUNPPortRedirectPortBounce
alaDaUNPGlobalConfiguration
alaDaUNPRedirectPortBounce

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-65
unp port group-id UNP Commands

unp port group-id

Assigns a UNP edge port or link aggregate to a group ID. This command is used to group physical UNP
ports or link aggregates into one logical domain.
unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} group-id group_id
no unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} group-id

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific UNP edge
port. Use a hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of link
aggregate IDs (10-15).
group_id The numerical group ID to which the specified port or link aggregate is
assigned.

Defaults
By default, all UNP edge ports are assigned to group ID zero (0).

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to set the group ID back to zero (the default).

• The group ID specified with this command must already exist in the switch configuration.

• This command is only allowed on UNP edge ports and link aggregates, not on UNP bridge or service
access ports.

Examples
-> unp port 1/1/1 group-id 1
-> unp port 1/1/1-3 group-id 2
-> unp linkagg 5 group-id 5
-> unp linkagg 8-10 group-id 6

Release History
Release 8.1.1; command was introduced.

page 36-66 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp port group-id

Related Commands

unp port Configures the status of UNP for the specified port or link aggregate.
unp group-id Creates a group ID to assign to UNP ports or link aggregates.
show unp port Displays the UNP configuration for the port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPortIfIndex
alaDaUNPPortGroupId

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-67
unp unp-customer-domain UNP Commands

unp unp-customer-domain
Assigns a UNP port or link aggregate to a customer domain (UNP group). This command applies only to
UNP bridge and service access ports.
unp {port chassis_id/slot/port1[-port2] | linkagg agg_id[-agg_id2]} unp-customer-domain domain_id

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of link
aggregate IDs (10-15).
domain_id The numerical domain ID to which the specified port or link aggregate
is assigned.

Defaults
By default, all UNP ports are assigned to customer domain zero (0).

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The domain ID specified with this command must already exist in the switch configuration.

• Customer domains are used to group physical UNP ports or link aggregates into one logical domain.

• Once a port is assigned to a specific customer domain, only classification rules associated with the
same customer domain ID are applied to that port.

Examples
-> unp port 1/1 unp-customer-domain 1
-> unp port 1/1-3 unp-customer-domain 2
-> unp linkagg 5 unp-customer-domain 5
-> unp linkagg 8-10 unp-customer-domain 6

Release History
Release 8.2.1; command was introduced.

page 36-68 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp unp-customer-domain

Related Commands

unp port Configures the status of UNP for the specified port or link aggregate.
unp customer-domain Creates a customer domain ID.
show unp customer-domain Displays the available customer domain IDs.
show unp port Displays the UNP configuration for the port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPortIfIndex
laDaUNPPortCustomerDomainId

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-69
unp default-edge-profile UNP Commands

unp default-edge-profile
Assigns the name of an existing UNP Edge classification profile to serve as the default profile for the
specified UNP edge port or link aggregate.
unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} default-edge-profile profile_name
no unp {port chassis/slot/port1[-port2] | linkagg agg_id} default-edge-profile

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific UNP edge
port. Use a hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of link
aggregate IDs (10-15).
profile_name The name of an existing Edge classification profile.

Defaults
By default, there is no default profile configured for UNP ports or link aggregates.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove the default Edge profile from the port configuration.

• This command applies only to UNP-enabled ports and link aggregates that are configured as edge ports
and link aggregates.
• The Edge classification profile specified with this command must already exist in the switch
configuration.
• The default UNP is used to classify devices on the port when one of the following conditions occur:
– UNP authentication and UNP classification are not enabled on the port.
– UNP authentication fails and UNP classification is not enabled on the port.
– UNP authentication is not enabled for the port and UNP classification fails.
– UNP authentication and UNP classification fails.
– UNP authentication passes but no profile or an invalid profile is returned and UNP classification
fails or is not enabled on the port.
– The UNP trust VLAN tag option (see unp trust-tag) is enabled for the port, but the VLAN ID
specified in the tag field of the device traffic does not exist.

Examples
-> unp port 1/1/1 default-edge-profile “Sales”
-> no unp port 1/1/1 default-edge-profile
-> unp port 1/1/1-4 default-edge-profile “Sales”

page 36-70 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp default-edge-profile

ERROR: Port 1/1/2 is not a unp port

ERROR: Port 1/1/3 is not a unp port
-> unp port 1/1/1 default-edge-profile “BAD-UNP”
ERROR: UNP doesn't exist
-> no unp port 1/1/1-4 default-edge-profile
-> unp linkagg 5 default-edge-profile “VM1-Server1”
-> no unp linkagg 5 default-edge-profile

Release History
Release 8.1.1; command was introduced.

Related Commands

unp port Configures the UNP status and port type for the specified port or link
aggregate.
unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
received on UNP Edge ports.
show unp port Displays the UNP configuration for the port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPortIfIndex
alaDaUNPPortDefaultEdgeProfName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-71
unp default-vlan-profile UNP Commands

unp default-vlan-profile
Configures the name of an existing VLAN classification profile to serve as the default UNP for the
specified UNP bridge port or link aggregate.
unp {port chassis_id/slot/port1[-port2] | linkagg agg_id[-agg_id2]} default-vlan-profile profile_name
no unp {port chassis_id/slot/port1[-port2] | linkagg agg_id} default-vlan-profile

Syntax Definitions

chassis_id The chassis identifier when running in virtual chassis mode.

slot/port[-port2] The slot and port number (3/1) for a specific UNP bridge port. Use a
hyphen to specify a range of ports (3/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
profile_name The name of an existing VLAN classification profile.

Defaults
By default, there is no default profile configured for UNP ports or link aggregates.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove the default UNP from the port configuration.

• This command applies only to UNP-enabled ports and link aggregates that are configured as bridge
ports and link aggregates.
• The VLAN classification profile specified with this command must already exist in the switch
configuration.
• The default UNP is used to classify devices on the port when one of the following conditions occur:
– UNP authentication and UNP classification are not enabled on the port.
– UNP authentication fails and UNP classification is not enabled on the port.
– UNP authentication is not enabled for the port and UNP classification fails.
– UNP authentication and UNP classification fails.
– UNP authentication passes but no profile or an invalid profile is returned and UNP classification
fails or is not enabled on the port.
– The UNP trust VLAN tag option (see unp trust-tag) is enabled for the port, but the VLAN ID
specified in the tag field of the device traffic does not exist.

Examples
-> unp port 1/1 default-vlan-profile Sales
-> no unp port 1/1 default-vlan-profile

page 36-72 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp default-vlan-profile

-> unp port 1/1-4 default-vlan-profile Sales

ERROR: Port 1/2 is not a unp port
ERROR: Port 1/3 is not a unp port
-> unp port 1/1 default-vlan-profile “BAD-UNP”
ERROR: UNP doesn't exist
-> no unp port 1/1-4 default-vlan-profile
-> unp linkagg 5 default-vlan-profile “VM1-Server1”
-> no unp linkagg 5 default-vlan-profile

Release History
Release 8.2.1; command was introduced.

Related Commands

unp vlan-profile Configures a UNP VLAN profile. This type of profile is applied to
traffic received on UNP bridge ports.
unp port Configures the UNP status and port type for the specified port or link
aggregate.
show unp port Displays the UNP configuration for the port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPortIfIndex
alaDaUNPPortDefaultProfileName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-73
unp default-spb-profile UNP Commands

unp default-spb-profile
Configures the name of an existing Shortest Path Bridging (SPB) service-based UNP to serve as the
default profile for the specified UNP access port or link aggregate.
unp {port chassis_id/slot/port1[-port2] | linkagg agg_id[-agg_id2]} default-spb-profile profile_name
no unp {port chassis_id/slot/port1[-port2] | linkagg agg_id} default-spb-profile

Syntax Definitions

chassis_id The chassis identifier when running in virtual chassis mode.

slot/port[-port2] The slot and port number (3/1) for a specific UNP access port. Use a
hyphen to specify a range of ports (3/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
profile_name The name of an existing SPB service classification profile.

Defaults
By default, there is no default SPB service profile configured for UNP access ports or link aggregates.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove the default service profile from the port configuration.

• This command applies only to UNP-enabled ports and link aggregates that are configured as SPB
service access ports and link aggregates.
• The SPB service classification profile specified with this command must already exist in the switch
configuration.
• The default service profile is used to classify devices on the access port when one of the following
conditions occur:
– UNP authentication and UNP classification are not enabled on the port.
– UNP authentication fails and UNP classification is not enabled on the port.
– UNP authentication is not enabled for the port and UNP classification fails.
– UNP authentication and UNP classification fails.
– UNP authentication passes but no profile or an invalid profile is returned and UNP classification
fails or is not enabled on the port.
– The UNP trust VLAN tag option (see unp trust-tag) is enabled for the port, but the VLAN ID
specified in the tag field of the device traffic does not exist.

Examples
-> unp port 1/10 default-spb-profile “SLA_1”

page 36-74 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp default-spb-profile

-> no unp port 1/10 default-spb-profile

-> unp port 1/1-4 default-spb-profile “CustomerA”
ERROR: Port 1/2 is not a unp port
ERROR: Port 1/3 is not a unp port
-> unp port 1/1 default-spb-profile “BAD-UNP”
ERROR: UNP doesn't exist
-> no unp port 1/1-4 default-spb-profile
-> unp linkagg 5 default-spb-profile “VM1-Server1”
-> no unp linkagg 5 default-spb-profile

Release History
Release 8.2.1; command was introduced.

Related Commands

unp spb-profile Configures a UNP SPB service profile. This type of profile is applied to
traffic received on UNP access ports.
unp port Configures the UNP status and port type for the specified port or link
aggregate.
show unp port 802.1x statistics Displays the UNP configuration for the port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPortIfIndex
alaDaUNPPortDefaultSpbProfileName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-75
unp aaa-profile UNP Commands

unp aaa-profile
Assigns the name of an existing authentication, authorization, and accounting (AAA) profile to the
specified UNP edge port or link aggregate. This type of profile defines AAA configuration options (such
as RADIUS servers and RADIUS client attributes) that are applied to device traffic received on the UNP
port to which the profile is assigned.
unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} aaa-profile profile_name
no unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} aaa-profile

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific UNP edge
port. Use a hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of link
aggregate IDs (10-15).
profile_name The name of an existing AAA profile.

Defaults
By default, there is no AAA profile assigned to UNP ports or link aggregates. The global AAA
configuration for the switch is applied.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove the AAA profile from the port configuration.

• This command applies only to UNP-enabled ports and link aggregates that are configured as edge ports
and link aggregates.
• The AAA profile specified with this command must already exist in the switch configuration.

• AAA profiles are configured using the aaa profile command. See the “AAA Commands” chapter in
the OmniSwitch AOS Release 8 CLI Reference Guide for more information.

Examples
-> unp port 1/1/5 aaa-profile A1
-> no unp port 1/1/5 aaa-profile

-> unp port 1/1/1-5 aaa-profile A2

-> no unp port 1/1/1-5 aaa-profile

-> unp linkagg 10 aaa-profile A3

-> no unp linkagg 10 aaa-profile

page 36-76 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp aaa-profile

Release History
Release 8.1.1; command was introduced.

Related Commands

unp port Configures the UNP status and port type for the specified port or link
aggregate.
aaa profile Configures an AAA configuration profile.
show unp port Displays the UNP configuration for the port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPortIfIndex
alaDaUNPPortAaaProfile

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-77
unp port edge-template UNP Commands

unp port edge-template

Assigns the name of an existing Edge template to the specified UNP edge port or link aggregate. An Edge
template defines UNP port configuration options (such as the type of authentication, classification status, a
default profile) that is applied to the UNP port to which the template is assigned.
unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} edge-template template_name
no unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} edge-template

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific UNP edge
port. Use a hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of link
aggregate IDs (10-15).
template_name The name of an existing Edge template.

Defaults
By default, there is no Edge template configured for UNP ports or link aggregates.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove the Edge template from the port configuration.

• This command applies only to UNP-enabled ports and link aggregates that are configured as edge ports
and link aggregates.
• The Edge template specified with this command must already exist in the switch configuration.

Examples
-> unp port 1/1/5 edge-template up1
-> no unp port 1/1/5 edge-template

-> unp port 1/1/1-5 edge-template up2

-> no unp port 1/1/1-5 edge-template

-> unp linkagg 10 edge-template up3

-> no unp linkagg 10 edge-template

-> unp linkagg 10-50 edge-template up4

-> no unp linkagg 10-50 edge-template

Release History
Release 8.1.1; command was introduced.

page 36-78 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp port edge-template

Related Commands

unp port Configures the UNP status and port type for the specified port or link
aggregate.
unp edge-template Configures an Edge configuration template.
show unp port Displays the UNP configuration for the port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPortIfIndex
alaDaUNPPortEdgeTemplate

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-79
unp mac-authentication UNP Commands

unp mac-authentication
Configures the status of MAC authentication for the specified UNP port. Enable this functionality to
invoke MAC-based authentication for devices connected to the UNP port.
unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} mac-authentication {enable | disable}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] Link aggregate ID number. Use a hyphen to specify a range of link
aggregate IDs (10-15).
enable Enables MAC authentication.
disable Disables MAC authentication.

Defaults
By default, MAC authentication is disabled on UNP ports.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is only allowed on UNP-enabled ports and link aggregates.

• MAC-based authentication is supported only through a RADIUS-capable server.

• If a range of ports is specified with this command, any non-UNP ports within the range are skipped.

• An option exists to classify a device into an alternate UNP in the event successful MAC authentication
does not return a UNP name. See the unp mac-authentication pass-alternate command.
• If UNP MAC authentication, 802.1x authentication, and classification (see unp classification) are
disabled on the UNP port, all MAC addresses received on that port are blocked unless a default UNP is
configured.
• Configuring an authentication server down UNP (see unp auth-server-down) is highly recommended
when MAC or 802.1X authentication is enabled on any UNP port or link aggregate. This is because
after a switch reload, traffic from devices connected to UNP ports and link aggregates reaches the
switch and triggers the authentication process before route convergence has completed and the server
can be reached.
– If an authentication server down UNP is configured, devices are temporarily learned in that profile
and authentication is automatically attempted again after the timeout period expires. This allows
time for the server to become reachable from the switch after a reload.
– If an authentication server down UNP is not configured, devices are learned as filtering and will
remain in that state. There is no further attempt to authenticate these devices again.

page 36-80 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp mac-authentication

Examples
-> unp port 1/1/1 mac-authentication enable
-> unp port 1/1/1 mac-authentication disable
-> unp linkagg 2 mac-authentication enable
-> unp linkagg 2 mac-authentication disable

Release History
Release 8.1.1; command was introduced.

Related Commands

unp port Configures the UNP status and port type for the specified port or link
aggregate.
unp mac-authentication pass- Assigns the device to another UNP when successful MAC
alternate authentication does not return a UNP name.
unp 802.1x-authentication Configures the 802.1x authentication status for the UNP port.
unp classification Configures the classification status for the UNP port.
unp auth-server-down Configures an authentication server down UNP for the switch.
show unp port Displays the UNP configuration for the port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPortIfIndex
alaDaUNPPortMacAuthFlag

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-81
unp mac-authentication pass-alternate UNP Commands

unp mac-authentication pass-alternate

Configures the name of an existing UNP to use as an alternate profile. A device is assigned to the alternate
profile when successful MAC authentication does not return a UNP name.
unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} mac-authentication pass-alternate
{edge-profile | vlan-profile | spb-profile} profile_name
no unp {port chassis/slot/port1[-port2] | linkagg agg_id} mac-authentication pass-alternate {edge-
profile | vlan-profile | spb-profile}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] Link aggregate ID number. Use a hyphen to specify a range of link
aggregate IDs (10-15).
edge-profile Assigns an Edge profile as an alternate profile.
vlan-profile Assigns a VLAN profile as an alternate profile.
spb-profile Assigns a Shortest Path Bridging (SPB) service profile as an alternate
profile.
profile_name An Edge profile name.

Defaults
By default, no alternate UNP is configured.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the alternate profile from the UNP port configuration.

• The profile name specified with this command must already exist in the switch configuration.

Examples
-> unp port 2/1/1 mac-authentication pass-alternate edge-profile Finance
-> unp port 2/1/2-5 mac-authentication pass-alternate vlan-profile CustomerA
-> unp port 3/1 mac-authentication pass-alternate spb-profile SLA-10
-> no unp port 2/1/1 mac-authentication pass-alternate edge-profile
-> no unp port 2/1/2-5 mac-authentication pass-alternate vlan-profile
-> no unp port 3/1 mac-authentication pass-alternate spb-profile
-> unp linkagg 5 mac-authentication pass-alternate edge-profile AltUNP
-> unp linkagg 10 mac-authentication pass-alternate vlan-profile CustomerB
-> unp linkagg 20 mac-authentication pass-alternate spb-profile SLA-20
-> no unp linkagg 5 mac-authentication pass-alternate edge-profile
-> no unp linkagg 10 mac-authentication pass-alternate vlan-profile
-> no unp linkagg 20 mac-authentication pass-alternate spb-profile

page 36-82 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp mac-authentication pass-alternate

Release History
Release 8.1.1; command was introduced.
Release 8.2.1 vlan-profile and spb-profile parameters added.

Related Commands

unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
received on UNP Edge ports and link aggregates.
unp port Configures the status of UNP functionality on the port.
unp mac-authentication Configures the MAC authentication status for the UNP port.
show unp port Displays the UNP port parameter configuration.

MIB Objects
alaDaUNPPortTable
alaDaUNPPortIfIndex
alaDaUNPPortMacPassEdgeProfName
alaDaUNPPortPassAltProfileName
alaDaUNPPortPassAltSpbProfileName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-83
unp 802.1x-authentication UNP Commands

unp 802.1x-authentication
Configures the status of 802.1x authentication for the specified UNP port. Enable this functionality to
invoke 802.1x-based authentication for devices connected to the UNP port.
unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} 802.1x-authentication {enable |
disable}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] Link aggregate ID number. Use a hyphen to specify a range of link
aggregate IDs (10-15).
enable Enables 802.1x authentication.
disable Disables 802.1x authentication.

Defaults
By default, 802.1x authentication is disabled on UNP ports.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is only allowed on UNP-enabled ports and link aggregates.

• If a range of ports or link aggregates is specified with this command, any non-UNP ports or aggregates
within the range are skipped.
• An option exists to classify a device into an alternate UNP in the event successful 802.1x
authentication does not return a UNP name. See the unp 802.1x-authentication pass-alternate
command.
• If UNP MAC authentication, 802.1x authentication, and classification (see unp classification) are not
enabled on the UNP port, all MAC addresses received on that port are blocked unless a default UNP is
configured.
• Configuring an authentication server down UNP (see unp auth-server-down) is highly recommended
when MAC or 802.1X authentication is enabled on any UNP port or link aggregate. This is because
after a switch reload, traffic from devices connected to UNP ports and link aggregates reaches the
switch and triggers the authentication process before route convergence has completed and the server
can be reached.
– If an authentication server down UNP is configured, devices are temporarily learned in that profile
and authentication is automatically attempted again after the timeout period expires. This allows
time for the server to become reachable from the switch after a reload.
– If an authentication server down UNP is not configured, devices are learned as filtering and will
remain in that state. There is no further attempt to authenticate these devices again.

page 36-84 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp 802.1x-authentication

Examples
-> unp port 1/1/5 802.1x-authentication enable
-> unp port 1/1/5 802.1x-authentication disable

-> unp port 1/1/10-15 802.1x-authentication enable

-> unp port 1/1/10-15 802.1x-authentication disable

-> unp linkagg 10 802.1x-authentication enable

-> unp linkagg 20 802.1x-authentication disable

-> unp linkagg 10-50 802.1x-authentication enable

-> unp linkagg 10-50 802.1x-authentication disable

Release History
Release 8.1.1; command was introduced.

Related Commands

unp port Configures the status of UNP functionality on the port.

unp 802.1x-authentication Assigns the device to another profile when successful 802.1x
pass-alternate authentication does not return a UNP name.
unp mac-authentication Configures the MAC authentication status for the UNP port.
unp classification Configures the classification status for the UNP port.
unp auth-server-down Configures an authentication server down UNP for the switch.
show unp port Displays the UNP configuration for the port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPortIfIndex
alaDaUNPPort8021XAuthFlag

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-85
unp 802.1x-authentication pass-alternate UNP Commands

unp 802.1x-authentication pass-alternate

Configures the name of an existing UNP to use as an alternate profile. A device is assigned to the alternate
profile when successful 802.1X authentication does not return the name of a profile.
unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} 802.1x-authentication pass-alternate
{edge-profile | vlan-profile | spb-profile} profile_name
no unp {port chassis/slot/port1[-port2] | linkagg agg_id} 802.1X-authentication pass-alternate edge-
profile

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] Link aggregate ID number. Use a hyphen to specify a range of link
aggregate IDs (10-15).
edge-profile Assigns an Edge profile as an alternate profile.
vlan-profile Assigns a VLAN profile as an alternate profile.
spb-profile Assigns a Shortest Path Bridging (SPB) service profile as an alternate
profile.
profile_name The name of a UNP Edge profile.

Defaults
By default, no alternate UNP is configured.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the alternate profile from the UNP port configuration.

• This command is only allowed on UNP-enabled ports and link aggregates.

• If a range of ports or link aggregates is specified with this command, any non-UNP ports or aggregates
within the range are skipped.
• The profile name specified with this command must already exist in the switch configuration.

Examples
-> unp port 1/1/1 802.1x-authentication pass-alternate edge-profile Finance
-> unp port 1/1/2-5 802.1x-authentication pass-alternate vlan-profile CustomerA
-> unp port 3/1 802.1x-authentication pass-alternate spb-profile SLA-10
-> no unp port 1/1/1 802.1x-authentication pass-alternate edge-profile
-> no unp port 1/1/2-5 802.1x-authentication pass-alternate vlan-profile
-> no unp port 3/1 802.1x-authentication pass-alternate spb-profile
-> unp linkagg 5 802.1x-authentication pass-alternate edge-profile AltUNP
-> unp linkagg 10-15 802.1x-authentication pass-alternate vlan-profile CustomerB

page 36-86 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp 802.1x-authentication pass-alternate

-> unp linkagg 20 802.1x-authentication pass-alternate spb-profile SLA-20

-> no linkagg 5 802.1x-authentication pass-alternate edge-profile
-> no linkagg 5 802.1x-authentication pass-alternate vlan-profile
-> no linkagg 5 802.1x-authentication pass-alternate spb-profile

Release History
Release 8.1.1; command was introduced.
Release 8.2.1 vlan-profile and spb-profile parameters added.

Related Commands

unp edge-profile Configures an Edge UNP. This type of profile is applied to traffic
received on UNP Edge ports.
unp port Configures the status of UNP functionality on the port.
unp 802.1x-authentication Configures the 802.1X authentication status for the UNP port.
show unp port Displays the UNP port parameter configuration.

MIB Objects
alaDaUNPPortTable
alaDaUNPPortIfIndex
alaDaUNPPort8021XEdgeProfName
alaDaUNPPort8021XPassAltUserNetProfName
alaDaUNPPort8021XPassAltSpbProfName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-87
unp 802.1x-authentication tx-period UNP Commands

unp 802.1x-authentication tx-period

Configures the 802.1x authentication re-transmission time interval for the specified UNP port.
unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} 802.1x-authentication tx-period
seconds

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] Link aggregate ID number. Use a hyphen to specify a range of link
aggregate IDs (10-15).
seconds The amount of time before an EAP Request Identity is retransmitted.
The valid range is 1–60 seconds.

Defaults
By default, the retransmission period is set to 30 seconds.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is only allowed on UNP-enabled ports and link aggregates.

• The re-transmission time period only applies to UNP ports on which 802.1X authentication is enabled.

• If a range of ports is specified with this command, any non-UNP ports within the range are skipped.

Examples
-> unp port 1/1/5 802.1x-authentication tx-period 60
-> unp port 1/1/6-10 802.1x-authentication tx-period 20

-> unp linkagg 10 802.1x-authentication tx-period 60

-> unp linkagg 20-25 802.1x-authentication tx-period 20

Release History
Release 8.1.1; command was introduced.

page 36-88 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp 802.1x-authentication tx-period

Related Commands

unp port Configures the status of UNP functionality on the port.

unp 802.1x-authentication Configures the 802.1X authentication status for the UNP port.
show unp port Displays the UNP configuration for the port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPort8021XTxPeriodStatus
alaDaUNPPort8021XTxPeriod

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-89
unp 802.1x-authentication supp-timeout UNP Commands

unp 802.1x-authentication supp-timeout

Configures the 802.1x authentication supplicant timeout for the specified UNP port. This value is the
amount of time the switch will wait before timing out an 802.1X user that is attempting to authenticate.
unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} 802.1x-authentication supp-timeout
seconds

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] Link aggregate ID number. Use a hyphen to specify a range of link
aggregate IDs (10-15)
seconds The timeout value. The valid range is 1–120 seconds.

Defaults
By default, the supplicant timeout value is set to 30 seconds.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Increase the supplicant timeout value if the authentication process requires additional steps by the user
(for example, entering a challenge).
• This command is only allowed on UNP-enabled ports and link aggregates.

• The supplicant timeout is applied only to 802.1x users connected to a UNP port on which 802.1X
authentication is enabled.
• If a range of ports is specified with this command, any non-UNP ports within the range are skipped.

Examples
-> unp port 1/1/5 802.1x-authentication supp-timeout 10
-> unp port 1/1/10-15 802.1x-authentication supp-timeout 60

-> unp linkagg 10 802.1x-authentication supp-timeout 40

-> unp linkagg 2-5 802.1x-authentication supp-timeout 40

Release History
Release 8.1.1; command was introduced.

page 36-90 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp 802.1x-authentication supp-timeout

Related Commands

unp port Configures the status of UNP functionality on the port.

unp 802.1x-authentication Configures the 802.1X authentication status for the UNP port.
show unp port Displays the UNP configuration for the port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPort8021XSuppTimeOutStatus
alaDaUNPPort8021XSuppTimeout

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-91
unp 802.1x-authentication max-req UNP Commands

unp 802.1x-authentication max-req

Configures the maximum number of times the switch will retransmit a request for authentication
information (request identity, password, challenge) to an 802.1x user on the specified UNP port.
unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} 802.1x-authentication max-req
max_req

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] Link aggregate ID number. Use a hyphen to specify a range of link
aggregate IDs (10-15).
max_req The maximum number of times information requests are retransmitted.
The valid range is 0–3.

Defaults
By default, the maximum number of requests is set to two.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The 802.1X requests are transmitted, up to the maximum number allowed, until the authentication
session is shut down based on the supplicant timeout value configured for the 802.1X port.
• This command is only allowed on UNP-enabled ports and link aggregates.

• The maximum number of requests is applied only to 802.1x users connected to a UNP port on which
802.1X authentication is enabled.
• If a range of ports or link aggregates is specified with this command, any non-UNP ports within the
range are skipped.

Examples
-> unp port 1/1/5 802.1x-authentication max-req 1
-> unp port 1/1/10-15 802.1x-authentication max-req 3

-> unp linkagg 10 802.1x-authentication max-req 1

-> unp linkagg 2-5 802.1x-authentication max-req 3

Release History
Release 8.1.1; command was introduced.

page 36-92 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp 802.1x-authentication max-req

Related Commands

unp 802.1x-authentication Configures the number of seconds before the switch will time out an
supp-timeout 802.1X user that is attempting to authenticate.
unp port Configures the status of UNP functionality on the port.
unp 802.1x-authentication Configures the 802.1X authentication status for the UNP port.
show unp port Displays the UNP configuration for the port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPort8021XMaxReqOutStatus
alaDaUNPPort8021XMaxReq

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-93
unp 802.1x-authentication bypass UNP Commands

unp 802.1x-authentication bypass

Configures whether the 802.1X authentication process is bypassed on the specified UNP port. When
enabled, the 802.1x device authentication process is skipped; only MAC authentication or rule
classification is applied to device traffic on the UNP port.
unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} 802.1x-authentication bypass {enable |
disable}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] Link aggregate ID number. Use a hyphen to specify a range of link
aggregate IDs (10-15).
enable Enables 802.1X bypass on the specified port; MAC authentication is
performed first.
disable Disables 802.1X bypass on the specified port; 802.1X authentication is
attempted first.

Defaults
By default, 801.1X authentication bypass is disabled on the UNP port; 802.1X authentication is attempted
first.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is only allowed on UNP-enabled ports and link aggregates.

• Enabling 802.1X authentication bypass is not allowed on UNP ports that are configured with an
802.1X authentication failure policy.

Examples
-> unp port 1/1/5 802.1x-authentication bypass enable
-> unp port 1/1/5 802.1x-authentication bypass disable
-> unp port 1/1/10-15 802.1x-authentication bypass enable
-> unp port 1/1/10-15 802.1x-authentication bypass disable

-> unp linkagg 10 802.1x-authentication bypass enable

-> unp linkagg 10 802.1x-authentication bypass disable
-> unp linkagg 2-5 802.1x-authentication bypass enable
-> unp linkagg 2-5 802.1x-authentication bypass disable

Release History
Release 8.1.1; command was introduced.

page 36-94 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp 802.1x-authentication bypass

Related Commands

unp port Configures the status of UNP functionality on the port.

unp 802.1x-authentication Configures the 802.1X authentication status for the UNP port.
unp mac-authentication allow- Configures whether or not subsequent 802.1x authentication is
eap attempted based on the MAC authentication results.
show unp port Displays the UNP configuration for the port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPort8021XBypassStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-95
unp mac-authentication allow-eap UNP Commands

unp mac-authentication allow-eap

Configures whether the switch attempts subsequent 802.1x authentication for a device connected to a UNP
port on which 802.1x-authentication bypass is enabled. When 802.1x bypass is enabled on the port, MAC
authentication is performed first on any device connected to that port. This command specifies the
conditions under which 802.1x authentication is performed or bypassed after the initial MAC
authentication process.
unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} mac-authentication allow-eap {pass |
fail | noauth | none}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] Link aggregate ID number. Use a hyphen to specify a range of link
aggregate IDs (10-15).
pass Perform 802.1x (EAP frame) authentication if the device passes MAC
authentication.
fail Perform 802.1x (EAP frame) authentication if the device fails MAC
authentication.
noauth Perform 802.1x (EAP frame) authentication if MAC authentication is
not configured on the UNP port.
none Prevents subsequent 802.1x authentication; only MAC authentication is
performed on any device accessing the UNP port.

Defaults
By default, the allow 801.1X authentication option is set to none.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The port specified with this command must also have 802.1x bypass enabled (see the unp 802.1x-
authentication bypass command). If bypass is not enabled, the option configured with this command
does not apply.
• This command is only allowed on UNP-enabled ports and link aggregates.

Examples
-> unp port 1/1/5 mac-authentication allow-eap pass
-> unp port 1/1/10-15 mac-authentication allow-eap fail

-> unp linkagg 10 mac-authentication allow-eap noauth

-> unp linkagg 2-5 mac-authentication allow-eap none

page 36-96 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp mac-authentication allow-eap

Release History
Release 8.1.1; command was introduced.

Related Commands

unp port Configures the status of UNP functionality on the port.

unp 802.1x-authentication Configures the 802.1x bypass operation status for the UNP port.
bypass
show unp port Displays the UNP configuration for the port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPortMacAllowEap

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-97
unp 802.1x-authentication failure-policy UNP Commands

unp 802.1x-authentication failure-policy

Configures whether the switch attempts subsequent MAC authentication for a device after the initial
802.1X authentication process fails.
unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} 802.1x-authentication failure-policy
{mac-authentication | default}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] Link aggregate ID number. Use a hyphen to specify a range of link
aggregate IDs (10-15).
mac-authentication Perform MAC authentication if 802.1x authentication fails.
default Perform device classification if 802.1x authentication fails; MAC
authentication is not performed.

Defaults
By default, the 801.1X authentication failure policy is set to classification (default).

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Configuring the 802.1X authentication failure policy is not allowed on UNP ports on which 802.1X
authentication bypass is enabled.
• Device classification (the default) is performed based on the classification options configured for the
UNP port.

Examples
-> unp port 1/1/5 802.1x-authentication failure-policy mac-authentication
-> unp port 1/1/10-15 802.1x-authentication failure-policy default

-> unp linkagg 10 802.1x-authentication failure-policy mac-authentication

-> unp linkagg 2-5 802.1x-authentication failure-policy classification

Release History
Release 8.1.1; command was introduced.

page 36-98 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp 802.1x-authentication failure-policy

Related Commands

unp port Configures the status of UNP functionality on the port.

unp 802.1x-authentication Configures the 802.1X authentication status for the UNP port.
unp 802.1x-authentication Configures the 802.1x bypass operation status for the UNP port.
bypass
show unp port Displays the UNP configuration for the port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPortMacAllowEap

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-99
unp classification UNP Commands

unp classification
Configures the classification status for the specified UNP port. When enabled and MAC authentication is
disabled or fails, UNP classification rules are applied to the traffic received on the UNP port.
unp {port chassis/slot/port1[-port2] | linkagg agg_id} classification {enable | disable}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id Link aggregate ID.
enable Enables classification.
disable Disables classification.

Defaults
By default, classification is disabled on the UNP port.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is allowed only on UNP-enabled ports and link aggregates.

• If a range of ports or link aggregates is specified with this command, any non-UNP ports or aggregates
within the range are skipped.
• UNP classification rules are applied when one of the following occurs:
– 802.1X authentication fails.
– MAC authentication fails.
– MAC and 802.1X authentication are disabled on the port.
– MAC or 802.1X authentication passes but no profile or an invalid profile is returned.
• If device traffic does not match any of the classification rules, the device is assigned to the default UNP
configured for the port.
• If both UNP MAC authentication and classification (see unp mac-authentication) are not enabled on
the UNP port, all MAC addresses received on that port are blocked unless a default UNP is specified
for the port.

Examples
-> unp port 1/1/5 classification enable
-> unp port 1/1/5 classification disable
-> unp port 1/1/10-15 classification enable
-> unp port 1/1/10-15 classification disable

-> unp linkagg 10 classification enable

page 36-100 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification

-> unp linkagg 10 classification disable

-> unp linkagg 10-50 classification enable
-> unp linkagg 10-50 classification disable

Release History
Release 8.1.1; command was introduced.

Related Commands

show unp classification Displays the UNP classification rule configuration for the switch.
show unp port Displays the UNP configuration for the port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPortIfIndex
alaDaUNPPortClassificationFlag

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-101
unp trust-tag UNP Commands

unp trust-tag
Configures the option of whether or not to trust the VLAN ID of a tagged packet to determine how the
packet is classified.
unp port {port chassis_id/slot/port1[-port2] | linkagg agg_id[-agg_id2]} trust-tag {enable | disable}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of IDs
(10-20).
enable Trust the VLAN ID tag.
disable Do not trust the VLAN ID tag.

Defaults
By default, the VLAN tag is not trusted.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When this option is enabled, the device is classified into a VLAN or service access point (SAP) when
one of the following conditions occur:
– MAC or 802.1X authentication passes, but the RADIUS server returns a UNP that does not exist in
the switch configuration.
– MAC or 802.1X authentication passes, but the RADIUS server does not return a UNP and the
alternate UNP option is disabled for the port.
– Device traffic does not match any of the classification rules configured for the UNP port.
– The UNP VLAN obtained from the matching classification rule does not exist in the switch
configuration.
– Auth-Server-Down UNP option is used, but the VLAN associated with that UNP does not exist in
the switch configuration.
• When the trust tag option is triggered on a regular UNP bridge or edge port and a VLAN exists in the
switch configuration that matches the VLAN tag, a VLAN-port-association (VPA) is created between
the UNP port and the matching VLAN even if the matching VLAN is not associated with a UNP.
• When the trust tag option is triggered on a UNP SPB access port, the VLAN tag information is used to
create a dynamic SAP (virtual port) to which the access port is associated.
• Enabling the trust VLAN ID tag option provides an implicit method of VLAN tag classification that
will accept tagged traffic matching any of the existing UNPs without the need to create specific
classification rules for those profiles.

page 36-102 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp trust-tag

Examples
-> unp port 1/1 trust-tag enable
-> unp port 1/1 trust-tag disable
-> unp port 1/1-4 trust-tag enable

-> unp linkagg 5 trust-tag enable

-> unp linkagg 6-10 trust-tag enable
-> unp linkagg 5 trust-tag disable

Release History
Release 8.2.1; command was introduced.

Related Commands

show unp port Displays the UNP configuration for the port.
show unp edge-user Displays information about the devices learned on a UNP port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPortIfIndex
alaDaUNPPortTrustTagStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-103
unp direction UNP Commands

unp direction
Configures whether network access control is applied to both incoming and outgoing traffic or only
applied to incoming traffic on the specified UNP port or link aggregate.
unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} direction {both | in}
no unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} direction

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific UNP edge or
bridge port. Use a hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] Link aggregate ID number. Use a hyphen to specify a range of link
aggregate IDs (10-15).
both Enables bidirectional network access control on the specified port or
link aggregate.
in Enables network access control for incoming traffic only on the
specified port or link aggregate.

Defaults
By default, bidirectional network access control is enabled on the port.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to set the network access control direction to the default (both).

• This command applies only to UNP-enabled ports or link aggregates configured as edge or bridge
ports; does not apply to UNP access ports.
• When the port control direction is set to both, egress broadcast, unknown unicast, and multicast traffic
is blocked on the UNP port.
• When the port control direction is set to in, egress broadcast, unknown unicast, and multicast traffic is
allowed on the UNP port.

Examples
-> unp port 1/1/5 direction in
-> unp port 1/1/10-15 direction both
-> no unp port 1/1/10-15 direction

-> unp linkagg 10 direction in

-> unp linkagg 2-5 direction both
-> no unp linkagg 2-5 direction

page 36-104 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp direction

Release History
Release 8.1.1; command was introduced.

Related Commands

unp port Configures the status of UNP functionality on the port.

unp 802.1x-authentication Configures the 802.1X authentication status for the UNP port.
show unp port Displays the UNP configuration for the port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPortIfIndex
alaDaUNPPortAdminControlledDirections

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-105
unp vlan UNP Commands

unp vlan
Configures an untagged VLAN-port association between the specified UNP port and VLAN ID.
unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} vlan vlan_id [-vlan_id2]
no unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} vlan vlan_id [-vlan_id2]

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific UNP edge or
bridge port. Use a hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] Link aggregate ID number. Use a hyphen to specify a range of link
aggregate IDs (10-15).
vlan_id [-vlan_id2] The VLAN ID to assign to the UNP port. Use a hyphen to specify a
range of VLAN IDs.

Defaults
By default, no VLAN associations are configured for UNP edge and bridge ports.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a VLAN association from the UNP port configuration.

• This command applies only to UNP-enabled ports or link aggregates configured as edge or bridge
ports; does not apply to UNP access ports.
• When this command is used to assign a VLAN to a UNP edge or bridge port, the port goes into a
forwarding state for egress traffic associated with the VLANs assigned to the port. This automatically
occurs even when there is no MAC address learned on the UNP port in the assigned VLANs and
regardless of the direction value (in or both) set for the port.

Examples
-> unp port 1/1/5 vlan 500
-> unp port 1/1/10 vlan 100-105
-> no unp port 1/1/5 vlan 500
-> no unp port 1/1/10 vlan 100-105

-> unp linkagg 10 vlan 500

-> unp linkagg 20 vlan 100-105
-> no unp linkagg 10 vlan 500
-> no unp linkagg 20 vlan 100-105

Release History
Release 8.2.1; command was introduced.

page 36-106 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp vlan

Related Commands

unp port Configures the status of UNP functionality on the port.

show unp port configured- Displays the VLAN assignments configure for UNP edge and bridge
vlans ports or link aggregates.

MIB Objects
alaDaUNPPortVlanTable
alaDaUNPPortVlanVID

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-107
unp edge-template UNP Commands

unp edge-template
Configures an Edge port template that is used to apply pre-defined port configuration to UNP Edge ports
or link aggregates. This section describes the base command (unp edge-template template_name) along
with the other command keywords that are used to configure port parameter values that are applied when
the template is assigned to a UNP port or link aggregate.
unp edge-template template_name
[802.1x-authentication {enable | disable}]
[802.1x-authentication pass-alternate edge-profile profile_name]
[mac-authentication {enable | disable}]
[mac-authentication pass-alternate edge-profile profile_name]
[classification {enable | disable}]
[default-edge-profile profile_name]
[group-id group_id]
[aaa-profile profile_name]
[redirect port-bounce {enable | disable}]
[direction {in | both}]
[802.1x-authentication tx-period seconds]
[802.1x-authentication supp-timeout seconds]
[802.1x-authentication max-req max_req]
[802.1x-authentication bypass {enable | disable}]
[802.1x-authentication failure-policy {mac-authentication | default}]
[mac-authentication allow-eap {pass | fail | noauth | none}]
[trust-tag {enable | disable}]
[vlan vlan_id [-vlan_id2]
no unp edge-template template_name

Syntax Definitions

template_name The name to associate with the Edge port template.

Defaults
When a template is created without specifying any port parameter values, the template parameters are set
to the following default values:

parameter default
802.1x-authentication {enable | disable}] disable
802.1x-authentication pass-alternate edge- none
profile profile_name
mac-authentication {enable | disable} disable
mac-authentication pass-alternate edge-profile none
profile_name]
classification {enable | disable} disable

page 36-108 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp edge-template

parameter default
default-edge-profile profile_name none
group-id group_id 0
aaa-profile profile_name none
redirect port-bounce {enable | disable} enable
direction {in | both} both
802.1x-authentication tx-period seconds 30
802.1x-authentication supp-timeout seconds 30
802.1x-authentication max-req max_req 2
802.1x-authentication bypass {enable | disable} disable
802.1x-authentication failure-policy {mac- default
authentication | default}
mac-authentication allow-eap {pass | fail | none
noauth | none}
trust-tag {enable | disable} disable
vlan vlan_id [-vlan_id2] none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the Edge port template from the switch configuration.

• Using an Edge port template to configure UNP functionality on a port or link aggregate avoids having
to configure each parameter with a separate CLI command. Applying an Edge template configures all
port-based parameters with a single CLI command.
• Creating the template name with the base command (unp edge-template template_name) is not
required to configure a template port parameter value. If the template does not exist, the switch will
automatically create the template name specified when the port parameter is configured. For example,
the unp edge-template et-1 mac-authentication enable command will create the “et-1” template if it
does not already exist in the switch configuration.
• When an Edge template is applied to a UNP Edge port, the parameter values defined in the template
will override any existing UNP port configuration. In addition, any attempt to explicitly configure a
port that is associated with a template is not allowed.
• For more information about specific port parameter values, refer to the following explicit UNP port
configuration commands for each template parameter:

Edge Template Parameter Explicit Port Configuration Command

[802.1x-authentication {enable | disable}] unp 802.1x-authentication
[802.1x-authentication pass-alternate edge-profile unp 802.1x-authentication pass-alternate
profile_name]

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-109
unp edge-template UNP Commands

Edge Template Parameter Explicit Port Configuration Command

[mac-authentication {enable | disable}] unp mac-authentication
[mac-authentication pass-alternate edge-profile unp mac-authentication pass-alternate
profile_name]
[classification {enable | disable}] unp classification
[default-edge-profile profile_name] unp default-edge-profile
[group-id group_id] unp port group-id
[aaa-profile profile_name] unp aaa-profile
[redirect port-bounce {enable | disable}] unp redirect port-bounce
[direction {in | both} unp direction
[802.1x-authentication tx-period seconds] unp 802.1x-authentication tx-period
[802.1x-authentication supp-timeout seconds] unp 802.1x-authentication supp-timeout
[802.1x-authentication max-req max_req] unp 802.1x-authentication max-req
[802.1x-authentication bypass {enable | disable}] unp 802.1x-authentication bypass
[802.1x-authentication failure-policy unp 802.1x-authentication failure-policy
{mac-authentication | default}
[mac-authentication allow-eap {pass | fail | noauth | unp mac-authentication allow-eap
none}]
[trust-tag {enable | disable}] unp trust-tag
[vlan vlan_id [-vlan_id2] unp vlan

Examples
-> unp edge-template et-1
-> unp edge-template et-1 mac-authentication enable
-> unp edge-template et-1 mac-authentication pass-alternate edge-profile edge1
-> unp edge-template et-1 classification enable
-> no unp edge-template et-1

-> unp edge-template et-2 802.1x-authentication enable

-> unp edge-template et-2 classification enable
-> unp edge-template et-2 group-id 10
-> no unp edge-template et-2

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; trust-tag and vlan parameters added.

page 36-110 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp edge-template

Related Commands

unp port edge-template Assigns an Edge port configuration template to a UNP port.
show unp port Displays the UNP configuration for the port, including the name of an
Edge template associated with the port, if any.
show unp edge-template Displays the Edge template configuration.

MIB Objects
alaDaUNPETmplName
alaDaUNPETmpl8021XAuthStatus
alaDaUNPETmpl8021XTxPeriodStatus
alaDaUNPETmpl8021XTxPeriod
alaDaUNPETmpl8021XSuppTimeoutStatus
alaDaUNPETmpl8021XSuppTimeOut
alaDaUNPETmpl8021XMaxReqStatus
alaDaUNPETmpl8021XMaxReq
alaDaUNPETmpl8021XPassAltEProf
alaDaUNPETmplMacAuthStatus
alaDaUNPETmplMacPassAltEProf
alaDaUNPETmplClassifStatus
alaDaUNPETmplDefEProf
alaDaUNPETmplGroupId
alaDaUNPETmplAaaProf
alaDaUNPETmplRowStatus
alaDaUNPETmplRedirectPortBounce
alaDaUNPETmplFailurePolicy
alaDaUNPETmplBypassStatus
alaDaUNPETmplMacAllowEap
alaDaUNPETmpl8021XAdminControlledDirections
alaDaUNPETmplTrustTagStatus
alaDaUNPETmplVlanTable
alaDaUNPETmplVlanVID
alaDaUNPETmplVlanRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-111
unp classification port UNP Commands

unp classification port

Defines a Port classification rule for the specified UNP Edge profile. If the UNP edge port or link
aggregate on which the device traffic is received matches the port or link aggregate defined for the rule,
the specified profile is applied to the device.
unp classification {port chassis/slot/port1[-port2] | linkagg agg_id} [vlan-tag vlan_id] edge-profile
profile_name
no unp classification {port chassis/slot/port1[-port2] | linkagg agg_id} edge-profile

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id Link aggregate ID.
vlan_id A VLAN ID.
profile_name The name of an existing Edge profile.

Defaults
By default, no classification rules are defined for an Edge profile.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the rule from an Edge profile configuration. When a
classification rule is removed or modified, all MAC addresses classified with that rule are flushed.
• The Port rule configured for the specified Edge profile is applied only to traffic learned on the specified
UNP edge port or aggregate. This type of rule is not configurable for VLAN and SPB service profiles.
• If a range of ports is specified with this command, any non-UNP ports within the range are skipped.

• If a VLAN ID tag is specified with this command, the UNP is only applied to tagged packets received
on the specified UNP edge port and the VLAN ID tag.
• Untagged packets are only classified using the specified UNP edge port; the VLAN ID tag is ignored if
it is specified with this rule.
• A Port rule can be combined with a MAC address rule, IP address rule, or VLAN tag rule to configure
a binding classification rule. The following binding rule combinations are supported:
– Port + MAC address + IP address + VLAN tag
– Port + MAC address + VLAN tag
– Port + IP address + VLAN tag

page 36-112 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification port

Examples
-> unp classification port 1/1/5 edge-profile myProfile1
-> unp classification port 1/1/6 vlan-tag 100 edge-profile myProfile2
-> no unp classification port 1/1/5 edge-profile
-> no unp classification port 1/1/6 edge-profile

-> unp classification port 1/1/10-15 edge-profile myProfile2

-> no unp classification port 1/1/10-15 edge-profile

Port + MAC address binding rule example:

-> unp classification mac-address 00:11:22:33:44:55 port 1/1/5 edge-profile Pr1

-> no unp classification mac-address 00:11:22:33:44:55 port 1/1/5 edge-profile

Port + IP address binding rule example:

-> unp classification ip-address 10.0.0.20 mask 255.255.0.0 port 1/1/10 edge-
profile Pr2
-> no unp classification ip-address 10.0.0.20 mask 255.255.0.0 port 1/1/10 edge-
profile

Port + MAC address + IP address binding rule example:

-> unp classification mac-address 00:11:22:33:44:55 ip-address 10.0.0.20 mask

255.255.0.0 port 1/1/15 edge-profile Pr3
-> no unp classification mac-address 00:11:22:33:44:55 ip-address 10.0.0.20 mask
255.255.0.0 port 1/1/15 edge-profile

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; vlan-tag parameter added.

Related Commands

unp classification Configures the classification status for the UNP port. Rules are not
applied when classification is disabled for the port.
unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
show unp classification Displays the UNP classification rule configuration.

MIB Objects
alaDaUNPPortRuleTable
alaDaUNPPortRuleNum
alaDaUNPPortRuleEdgeProf
alaDaUNPPortRuleRowStatus
alaDaUNPPortRuleVlanTag

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-113
unp classification group-id UNP Commands

unp classification group-id

Defines a Group ID classification rule for the specified UNP Edge profile. If the port or link aggregate on
which the device traffic is received belongs to a Group ID that matches the Group ID defined for the rule,
the specified profile is applied to the device.
unp classification group-id group_id [vlan-tag vlan_id] edge-profile profile_name
no unp classification group-id group_id edge-profile

Syntax Definitions

group_id Group ID number.

vlan_id A VLAN ID.
profile_name The name of an existing Edge profile.

Defaults
By default, no classification rules are defined for an Edge profile.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the rule from an Edge profile configuration. When a
classification rule is removed or modified, all MAC addresses classified with that rule are flushed.
• The Group ID rule configured for the specified Edge profile is applied only to traffic learned on UNP
edge ports. This type of rule is not configurable for VLAN and SPB service profiles.
• If a VLAN ID tag is specified with this command, the UNP is only applied to tagged packets received
on a UNP edge port associated with the Group ID and tagged with the specified VLAN ID.
• Untagged packets are only classified using the specified Group ID; the VLAN ID tag is ignored if it is
specified with this rule.
• A Group ID rule can be combined with a MAC address rule, IP address rule, or VLAN tag rule to
configure a binding classification rule. The following binding rule combinations are supported:
– Group ID + MAC address + IP address + VLAN tag
– Group ID + MAC address + VLAN tag
– Group ID + IP address + VLAN tag

Examples
-> unp classification group-id 10 edge-profile myProfile1
-> unp classification group-id 20 vlan-tag 100 edge-profile myProfile2
-> no unp classification group-id 10 edge-profile
-> no unp classification group-id 20 edge-profile

page 36-114 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification group-id

Group ID + MAC address binding rule example:

-> unp classification mac-address 00:11:22:33:44:55 group-id GRP1 edge-profile Pr1

-> no unp classification mac-address 00:11:22:33:44:55 group-id GRP1 edge-profile

Group ID + IP address binding rule example:

-> unp classification ip-address 10.0.0.20 mask 255.255.0.0 group-id GRP2 edge-
profile Pr2
-> no unp classification ip-address 10.0.0.20 mask 255.255.0.0 group-id GRP2 edge-
profile

Group ID + MAC address + IP address binding rule example:

-> unp classification mac-address 00:11:22:33:44:55 ip-address 10.0.0.20 mask

255.255.0.0 group-id GRP3 edge-profile Pr3
-> no unp classification mac-address 00:11:22:33:44:55 ip-address 10.0.0.20 mask
255.255.0.0 group-id GRP3 edge-profile

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; vlan-tag parameter added.

Related Commands

unp classification Configures the classification status for the UNP port. Rules are not
applied when classification is disabled for the port.
unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
show unp classification Displays the UNP classification rule configuration.

MIB Objects
alaDaUNPGroupRuleTable
alaDaUNPGroupRuleId
alaDaUNPGroupRuleEdgeProf
alaDaUNPGroupRuleRowStatus
alaDaUNPGroupRuleVlanTag

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-115
unp classification mac-address UNP Commands

unp classification mac-address

Defines a MAC address classification rule for the specified UNP profile. If the source MAC address of the
device traffic matches the MAC address defined for the rule, the specified profile is applied to the device.
unp classification mac-address mac_address [group-id group_id] [vlan-tag vlan_id] edge-profile
profile_name
unp classification mac-address mac_address [vlan-tag vlan_id] [unp-customer-domain domain_id]
{vlan-profile | spb-profile} profile_name
no unp classification mac-address mac_address edge-profile
no unp classification mac-address mac_address [unp-customer-domain domain_id]

Syntax Definitions

mac_address MAC address (e.g., 00:00:39:59:f1:0c).

group_id An existing group ID number to which this rule will apply.Use this
optional parameter with Edge profiles.
vlan_id A VLAN ID.
domain_id An existing customer domain ID to which this rule will apply. Use this
optional parameter with VLAN and SPB service profiles.
edge-profile Assigns the rule to an Edge profile.
vlan-profile Assigns the rule to a VLAN profile.
spb-profile Assigns the rule to a Shortest Path Bridging (SPB) service profile.
profile_name The name of an existing Edge, VLAN, or SPB profile.

Defaults
By default, no classification rules are defined for UNP profiles.

parameter default
group_id 0
vlan_id none
domain_id 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the rule from the profile configuration. When removing a
rule from an Edge profile configuration, the edge-profile keyword is required with the no form of this
command.
• When a classification rule is removed or modified, all MAC addresses classified with that rule are
flushed.

page 36-116 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification mac-address

• When configuring a MAC address classification rule, specify and optional VLAN tag and/or an
optional customer domain ID (VLAN and SPB service profiles) or group ID (Edge profiles) before
specifying the UNP for which the rule will classify traffic.
• When a customer domain ID or group ID is configured for this rule, the rule is applied only to traffic
received on UNP ports that are associated with the same domain ID or group ID.
• The default customer domain ID and group ID is zero (0). All UNP ports not associated with a
customer domain ID or group ID are automatically assigned to ID zero.
• The MAC address rule configured for the specified profile is applied only to traffic learned on UNP
ports to which the profile is applied. For example:
– Edge profiles classify traffic received on UNP edge ports.
– VLAN profiles classify traffic received on UNP bridge ports.
– SPB service profiles classify traffic received on UNP access ports.
• It is possible to configure a single VLAN-based profile, a single SPB service-based profile, or both
types of profiles for the classification rule. Configuring both types of profiles for the same rule ensures
that the rule will be applied to traffic received on both types of UNP ports (bridge and access).
• Adding a rule does not cause a MAC address flush. If necessary, use the no mac-learning command to
clear and re-learn any addresses after the rule is added.
• If a VLAN ID tag is specified with this command, the UNP is only applied to tagged packets
containing the specified source MAC address and the VLAN ID tag.
• Untagged packets are only classified using the specified MAC address; the VLAN ID tag is ignored if
it is specified with this rule.
• A MAC address rule can be combined with a Group ID rule, Port rule, IP address rule, and VLAN tag
rule to configure a binding classification rule for an Edge profile (binding rules are not supported with
VLAN and SPB service profiles). The following binding rule combinations are supported:
– Port + MAC address + IP address + VLAN tag
– Port + MAC address + VLAN tag
– Port + IP address + VLAN tag
– Group ID + MAC address + IP address + VLAN tag
– Group ID + MAC address + VLAN tag
– Group ID + IP address + VLAN tag

Examples
-> unp classification mac-address 00:11:22:33:44:55 edge-profile myProfile1
-> unp classification mac-address 00:11:22:33:44:55 group-id 1 vlan-tag 200 edge-
profile myProfile1
-> no unp classification mac-address 00:11:22:33:44:55 edge-profile

-> unp classification mac-address 00:11:22:33:44:55 vlan-profile CustA

-> unp classification mac-address 00:2a:95:00:00:01 spb-profile VNP1
-> no unp classification mac-address 00:11:22:33:44:55
-> no unp classification mac-address 00:2a:95:00:00:01

-> unp classification mac-address 00:11:22:33:44:56 vlan-tag 100 vlan-profile CustB

-> unp classification mac-address 00:2a:95:00:00:02 unp-customer-domain 1 vlan-

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-117
unp classification mac-address UNP Commands

profile unp1 spb-profile-name spb1

-> no unp classification mac-address 00:2a:95:00:00:02 unp-customer-domain 1
-> no unp classification mac-address 00:11:22:33:44:56

The following examples apply only to rules configured for Edge profiles:
MAC address + port binding rule example.

-> unp classification mac-address 00:11:22:33:44:55 port 1/1/10 edge-profile Pr1

-> no unp classification mac-address 00:11:22:33:44:55 port 1/1/10 edge-profile

MAC address + Group ID binding rule example.

-> unp classification mac-address 00:11:22:33:44:55 group-id GRP1 edge-profile Pr1

-> no unp classification mac-address 00:11:22:33:44:55 group-id GRP1 edge-profile

MAC address + IP address + port binding rule example.

-> unp classification mac-address 00:11:22:33:44:55 ip-address 10.0.0.20 mask

255.255.0.0 port 1/1/1 edge-profile Pr3
-> no unp classification mac-address 00:11:22:33:44:55 ip-address 10.0.0.20 mask
255.255.0.0 port 1/1/1 edge-profile

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; group-id, unp-customer-domain, vlan-tag, vlan-profile, spb-profile parameters added.

Related Commands

unp classification Configures the classification status for the UNP port. Rules are not
applied when classification is disabled for the port.
unp port group-id Assigns a UNP edge port or link aggregate to a group ID.
unp unp-customer-domain Assigns a UNP bridge/access port or link aggregate to the specified
customer domain ID.
unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
unp vlan-profile Configures a UNP VLAN profile. This type of profile is applied to
traffic learned on UNP bridge ports and link aggregates.
unp spb-profile Configures a UNP SPB service profile. This type of profile is applied to
traffic learned on UNP access ports and link aggregates.
show unp classification Displays the UNP classification rule configuration.

page 36-118 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification mac-address

MIB Objects
alaDaUNPMacRulesTable
alaDaUNPMacRulesMacAddr
alaDaUNPMacRulesEdgeProf
alaDaUNPMacRulesVlanTag
alaDaUNPMacRulesRowStatus
alaDaUNPMacGroupRuleTable
alaDaUNPMacGroupRuleTable
alaDaUNPMacGroupRuleId
alaDaUNPMacGroupRuleEdgeProf
alaDaUNPMacGroupRuleRowStatus
alaDaUNPMacGroupRuleVlanTag
alaDaUNPCustDomainMacRuleTable
alaDaUNPCustDomainMacRuleAddr
alaDaUNPCustDomainMacRuleProfileName
alaDaUNPCustDomainMacRuleVlanTag
alaDaUNPCustDomainMacRuleRowStatus
alaDaUNPCustDomainMacRuleSpbProfileName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-119
unp classification mac-oui UNP Commands

unp classification mac-oui

Defines a MAC address Organizationally Unique Identifier (OUI) classification rule for the specified UNP
Edge profile. If the OUI of the source MAC address of the device traffic matches the OUI defined for the
rule, the specified profile is applied to the device.
unp classification mac-oui mac_oui [vlan-tag vlan_id] edge-profile profile_name
no unp classification mac-oui mac_oui edge-profile

Syntax Definitions

mac_oui The first three octets of the MAC address (for example, e8:39:35 is the
OUI of MAC address e8:39:35:10:fe:11).
vlan_id A VLAN ID.
profile_name The name of an existing Edge profile.

Defaults
By default, no classification rules are defined for an Edge profile.

parameter default
vlan_id none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the rule from an Edge profile configuration. When a
classification rule is removed or modified, all MAC addresses classified with that rule are flushed.
• When configuring a MAC address OUI classification rule, specify and optional VLAN tag before
specifying the UNP for which the rule will classify traffic.
• If a VLAN ID tag is specified with this command, the UNP is only applied to tagged packets
containing the specified source MAC address OUI and the VLAN ID tag.
• Untagged packets are only classified using the specified MAC address OUI; the VLAN ID tag is
ignored if it is specified with this rule.
• The MAC address OUI rule configured for the specified Edge profile is applied only to traffic learned
on UNP Edge ports. This type of rule is not configurable for VLAN and SPB service profiles.

Examples
-> unp classification mac-oui 00:11:22 edge-profile myProfile1
-> unp classification mac-oui 00:11:33 vlan-tag 10 edge-profile myProfile2
-> no unp classification mac-oui 00:11:22

page 36-120 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification mac-oui

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; vlan-tag parameter added.

Related Commands

unp classification Configures the classification status for the UNP port. Rules are not
applied when classification is disabled for the port.
unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
show unp classification Displays the UNP classification rule configuration.

MIB Objects
alaDaUNPMacOuiRuleTable
alaDaUNPMacOuiRuleAddr
alaDaUNPMacOuiRuleEdgeProfile
alaDaUNPMacOuiRuleRowStatus
alaDaUNPMacOuiRuleVlanTag

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-121
unp classification mac-address-range UNP Commands

unp classification mac-address-range

Defines a MAC address range classification rule for the specified UNP profile. If the source MAC address
of the device traffic matches any of the MAC addresses within the range of MAC addresses, the specified
profile is applied to the device.
unp classification mac-address-range low_mac_address high_mac_address [vlan-tag vlan_id] edge-
profile profile_name
unp classification mac-address-range low_mac_address high_mac_address [vlan-tag vlan_id] [unp-
customer-domain domain_id] {vlan-profile | spb-profile} profile_name
no unp classification mac-address-range low_mac_address edge-profile
no unp classification mac-address-range low_mac_address [unp-customer-domain domain_id]

Syntax Definitions

low_mac_address MAC address that defines the low end of the range (e.g.,
00:00:39:59:f1:00).
high_mac_address MAC address that defines the high end of the range (e.g.,
00:00:39:59:f1:90).
vlan_id A VLAN ID.
domain_id An existing customer domain ID to which this rule will apply. Use this
optional parameter with VLAN and SPB service profiles.
edge-profile Assigns the rule to an Edge profile.
vlan-profile Assigns the rule to a VLAN profile.
spb-profile Assigns the rule to a Shortest Path Bridging (SPB) service profile.
profile_name The name of an existing Edge, VLAN, or SPB profile.

Defaults
By default, no classification rules are defined for UNP profiles.

parameter default
vlan_id none
domain_id 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the rule from the profile configuration. When removing a
rule from an Edge profile, the edge-profile keyword is required along with the no form of this
command.

page 36-122 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification mac-address-range

• When a classification rule is removed or modified, all MAC addresses classified with that rule are
flushed.
• When configuring a MAC address range classification rule, specify and optional VLAN tag and/or an
optional customer domain ID (VLAN and SPB service profiles) or group ID (Edge profiles) before
specifying the UNP for which the rule will classify traffic.
• When a customer domain ID or group ID is configured for this rule, the rule is applied only to traffic
received on UNP ports that are associated with the same domain ID or group ID.
• The default customer domain ID and group ID is zero (0). All UNP ports not associated with a
customer domain ID or group ID are automatically assigned to ID zero.
• The MAC address range rule configured for the specified profile is applied only to traffic learned on
UNP ports to which the profile is applied. For example:
– Edge profiles classify traffic received on UNP edge ports.
– VLAN profiles classify traffic received on UNP bridge ports.
– SPB service profiles classify traffic received on UNP access ports.
• It is possible to configure a single VLAN-based profile, a single SPB service-based profile, or both
types of profiles for the classification rule. Configuring both types of profiles for the same rule ensures
that the rule will be applied to traffic received on both types of UNP ports (bridge and access).
• Adding a rule does not cause a MAC address flush. If necessary, use the no mac-learning command to
clear and re-learn any addresses after the rule is added.
• If a VLAN ID tag is specified with this command, the UNP is only applied to tagged packets
containing the specified source MAC address and the VLAN ID tag.
• Untagged packets are only classified using the specified MAC address; the VLAN ID tag is ignored if
it is specified with this rule.

Examples
-> unp classification mac-address-range 00:11:22:33:44:55 00:11:22:33:44:66 edge-
profile myProfile1
-> unp classification mac-address-range 00:00:da:01:e2:10 00:00:da:01:e2:20 vlan-
tag 5
-> no unp classification mac-address-range 00:11:22:33:44:55 edge-profile

-> unp classification mac-address-range 00:11:22:33:44:66 00:11:22:33:44:77 vlan-

profile CustA
-> unp classification mac-address-range 00:11:22:33:44:88 00:11:22:33:44:99 spb-
profile vNP1
-> no unp classification mac-address-range 00:11:22:33:44:66
-> no unp classification mac-address-range 00:11:22:33:44:88

-> unp classification mac-address-range 00:11:22:33:44:01 00:11:22:33:44:20 vlan-

tag 200 unp-customer-domain 2 vlan-profile CustB
-> unp classification mac-address-range 00:11:22:33:44:01 00:11:22:33:44:20 vlan-
tag 300 unp-customer-domain 3 vlan-profile CustC spb-profile vNP2
-> no unp classification mac-address-range 00:11:22:33:44:01 unp-customer-domain 2
-> no unp classification mac-address-range 00:11:22:33:44:01

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-123
unp classification mac-address-range UNP Commands

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; group-id, unp-customer-domain, vlan-tag, vlan-profile, spb-profile parameters added.

Related Commands

unp classification Configures the classification status for the UNP port. Rules are not
applied when classification is disabled for the port.
unp unp-customer-domain Assigns a UNP bridge/access port or link aggregate to the specified
customer domain ID.
unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
unp vlan-profile Configures a UNP VLAN profile. This type of profile is applied to
traffic learned on UNP bridge ports and link aggregates.
unp spb-profile Configures a UNP SPB service profile. This type of profile is applied to
traffic learned on UNP access ports and link aggregates.
show unp classification Displays the UNP classification rule configuration.

MIB Objects
alaDaUNPMacRangeRuleTable
alaDaUNPMacRangeRuleLoAddr
alaDaUNPMacRangeRuleHiAddr
alaDaUNPMacRangeRuleProfileName
alaDaUNPMacRangeRuleVlanTag
alaDaUNPMacRangeRuleRowStatus
alaDaUNPCustDomainMacRangeRuleTable
alaDaUNPCustDomainMacRangeRuleDomainId
alaDaUNPCustDomainMacRangeRuleLoAddr
alaDaUNPCustDomainMacRangeRuleHiAddr
alaDaUNPCustDomainMacRangeRuleProfileName
alaDaUNPCustDomainMacRangeRuleVlanTag
alaDaUNPCustDomainMacRangeRuleRowStatus
alaDaUNPCustDomainMacRangeRuleSpbProfileName
alaDaUNPCustDomainMacRangeRuleEdgeProfileName

page 36-124 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification ip-address

unp classification ip-address

Defines an IP network address classification rule for the specified UNP profile. If the source IP address of
the device traffic matches the IP address defined for the rule, the specified profile is applied to the device.
unp classification ip-address ip_address [mask subnet_mask | group-id group_id] [vlan-tag vlan_id]
edge-profile profile_name
unp classification ip-address ip_address mask subnet_mask [vlan-tag vlan_id] [unp-customer-domain
domain_id] {vlan-profile | spb-profile} profile_name
no unp classification ip-address ip_address [mask subnet_mask | group-id group_id] edge-profile
no unp classification ip-address ip_address mask subnet_mask [unp-customer-domain domain_id]

Syntax Definitions

ip_address IPv4 network address (e.g., 10.0.0.0, 171.15.0.0, 196.190.254.0).

subnet_mask An IP address mask to identify the IP subnet for the interface (supports
class-less masking).
group_id An existing group ID number to which this rule will apply.Use this
optional parameter with Edge profiles.
vlan_id A VLAN ID.
domain_id An existing customer domain ID to which this rule will apply. Use this
optional parameter with VLAN and SPB service profiles.
edge-profile Assigns the rule to an Edge profile.
vlan-profile Assigns the rule to a VLAN profile.
spb-profile Assigns the rule to a Shortest Path Bridging (SPB) service profile.
profile_name The name of an existing Edge, VLAN, or SPB profile.

Defaults
By default, no classification rules are defined for UNP profiles.

parameter default
group_id 0
vlan_id none
domain_id 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the rule from an Edge profile configuration. When
removing a rule from an Edge profile configuration, the edge-profile keyword is required along with
the no form of this command.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-125
unp classification ip-address UNP Commands

• When a classification rule is removed or modified, all MAC addresses classified with that rule are
flushed.
• When configuring an IP address classification rule, specify and optional VLAN tag and/or an optional
customer domain ID (VLAN and SPB service profiles) or group ID (Edge profiles) before specifying
the UNP for which the rule will classify traffic.
• When a customer domain ID or group ID is configured for this rule, the rule is applied only to traffic
received on UNP ports that are associated with the same domain ID or group ID.
• The default customer domain ID and group ID is zero (0). All UNP ports not associated with a
customer domain ID or group ID are automatically assigned to ID zero.
• The IP address rule configured for the specified profile is applied only to traffic learned on UNP ports
to which the profile is applied. For example:
– Edge profiles classify traffic received on UNP edge ports.
– VLAN profiles classify traffic received on UNP bridge ports.
– SPB service profiles classify traffic received on UNP access ports.
• It is possible to configure a single VLAN-based profile, a single SPB service-based profile, or both
types of profiles for the classification rule. Configuring both types of profiles for the same rule ensures
that the rule will be applied to traffic received on both types of UNP ports (bridge and access).
• Adding a rule does not cause a MAC address flush. If necessary, use the no mac-learning command to
clear and re-learn any addresses after the rule is added.
• If a VLAN ID tag is specified with this command, the UNP is only applied to tagged packets
containing the specified source MAC address and the VLAN ID tag.
• Untagged packets are only classified using the specified MAC address; the VLAN ID tag is ignored if
it is specified with this rule.
• An IP address rule can be combined with a Group ID rule, Port rule, MAC address rule, or VLAN tag
rule to configure a binding classification rule for an Edge profile (binding rules are not supported with
VLAN and SPB service profiles). The following binding rule combinations are supported:
– Port + MAC address + IP address + VLAN tag
– Port + MAC address + VLAN tag
– Port + IP address + VLAN tag
– Group ID + MAC address + IP address + VLAN tag
– Group ID + MAC address + VLAN tag
– Group ID + IP address + VLAN tag

Examples
-> unp classification ip-address 10.0.0.2 mask 255.255.255.0 edge-profile myPro-
file1
-> unp classification ip-address 10.0.0.2 group-id 1 edge-profile myProfile1
-> unp classification ip-address 10.0.0.2 vlan-tag 5 edge-profile myProfile1
-> unp classification ip-address 10.0.0.2 group-id 2 vlan-tag 10 edge-profile
myProfile1
-> no unp classification ip-address 10.0.0.2 mask 255.255.255.0 edge-profile
-> no unp classification ip-address 10.0.0.2 group-id 2 edge-profile

page 36-126 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification ip-address

-> unp classification ip-address 10.1.1.1 mask 255.255.255.0 vlan-profile CustA

-> unp classification ip-address 20.1.1.2 mask 255.255.255.0 spb-profile vNP1
-> no unp classification ip-address 10.1.1.1 mask 255.255.255.0
-> no unp classification ip-address 20.1.1.2 mask 255.255.255.0

-> unp classification ip-address 50.1.1.1 mask 255.255.255.0 vlan-tag 300 vlan-
profile CustB
-> unp classification ip-address 60.1.1.1 mask 255.255.0.0 unp-customer-domain 2
unp-name unp2 spb-profile-name spb2
-> no unp classification ip-address 50.1.1.1 mask 255.255.255.0
-> no unp classification ip-address 60.1.1.1 mask 255.255.0.0 unp-customer-domain 2

The following examples apply only to rules configured for Edge profiles:
IP address + port binding rule example.

-> unp classification ip-address 10.0.0.20 mask 255.255.0.0 port 1/1/10 edge-
profile Pr1
-> no unp classification ip-address 10.0.0.20 mask 255.255.0.0 port 1/1/10 edge-
profile

IP address + Group ID binding rule example.

-> unp classification ip-address 10.0.0.20 mask 255.255.0.0 group-id GRP1 edge-
profile Pr1
-> no unp classification ip-address 10.0.0.20 mask 255.255.0.0 group-id GRP1 edge-
profile

IP address + MAC address binding rule example.

-> unp classification mac-address 00:11:22:33:44:55 ip-address 10.0.0.20 mask

255.255.0.0 port 1/1/1 edge-profile Pr3
-> no unp classification mac-address 00:11:22:33:44:55 ip-address 10.0.0.20 mask
255.255.0.0 port 1/1/1 edge-profile

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; group-id, unp-customer-domain, vlan-tag, vlan-profile, spb-profile parameters added.

Related Commands

unp classification Configures the classification status for the UNP port. Rules are not
applied when classification is disabled for the port.
unp port group-id Assigns a UNP edge port or link aggregate to a group ID.
unp unp-customer-domain Assigns a UNP bridge/access port or link aggregate to the specified
customer domain ID.
unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
unp vlan-profile Configures a UNP VLAN profile. This type of profile is applied to
traffic learned on UNP bridge ports and link aggregates.
unp spb-profile Configures a UNP SPB service profile. This type of profile is applied to
traffic learned on UNP access ports and link aggregates.
show unp classification Displays the UNP classification rule configuration.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-127
unp classification ip-address UNP Commands

MIB Objects
alaDaUNPIpMaskRuleTable
alaDaUNPIpMaskRuleAddrType
alaDaUNPIpMaskRuleAddr
alaDaUNPIpMaskRuleMaskType
alaDaUNPIpMaskRuleMask
alaDaUNPIpMaskRuleEdgeProf
alaDaUNPIpMaskRuleRowStatus
alaDaUNPIpMaskRuleVlanTag
alaDaUNPIpGroupRuleTable
alaDaUNPIpGroupRuleAddrType
alaDaUNPIpGroupRuleAddr
alaDaUNPIpGroupRuleNum
alaDaUNPIpGroupRuleEdgeProf
alaDaUNPIpGroupRuleRowStatus
alaDaUNPIpGroupRuleVlanTag
alaDaUNPCustDomainIpNetRuleTable
alaDaUNPCustDomainIpNetRuleDomainId
alaDaUNPCustDomainIpNetRuleAddrType
alaDaUNPCustDomainIpNetRuleAddr
alaDaUNPCustDomainIpNetRuleMask
alaDaUNPCustDomainIpNetRuleProfileName
alaDaUNPCustDomainIpNetRuleVlanTag
alaDaUNPCustDomainIpNetRuleRowStatus
alaDaUNPCustDomainIpNetRuleSpbProfileName
alaDaUNPCustDomainIpNetRuleEdgeProfile

page 36-128 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification vlan-tag

unp classification vlan-tag

Defines a VLAN tag classification rule for the specified Universal Network Profile (UNP). If the VLAN
ID tag of the device traffic matches the VLAN ID defined for the rule, the specified UNP is applied to the
device.
unp classification vlan-tag vlan_id [tag-position {inner | outer}] [unp-customer-domain domain_id]
{edge-profile | vlan-profile | spb-profile} profile_name
no unp classification vlan-tag vlan_id [unp-customer-domain domain_id | edge-profile]

Syntax Definitions

vlan_id A VLAN ID.

inner Classify by matching the specified rule VLAN ID to the inner VLAN
tag of a double-tagged packet.
outer Classify by matching the specified rule VLAN ID to the outer VLAN
tag of the double-tagged packet.
domain_id An existing customer domain ID to which this rule will apply. A
customer domain ID is configurable only for VLAN and SPB profiles.
edge-profile Assigns the rule to an Edge profile.
vlan-profile Assigns the rule to a VLAN profile.
spb-profile Assigns the rule to a Shortest Path Bridging (SPB) service profile.
profile_name The name of an existing Edge, VLAN, or SPB profile.

Defaults
By default, no classification rules are defined for a UNP.

parameter default
inner | outer inner
domain_id 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a VLAN tag rule. When a classification rule is removed or
modified, all MAC addresses classified with that rule are flushed.
• When configuring a VLAN tag classification rule, specify an optional VLAN tag position and/or an
optional customer domain ID before specifying the name of the UNP for which the rule will classify
traffic.
• When a customer domain ID is configured for this rule, the rule is applied only to traffic received on
UNP bridge and access ports that are associated with the same domain ID.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-129
unp classification vlan-tag UNP Commands

• The default customer domain ID is zero (0). All UNP ports not associated with a customer domain ID
are automatically assigned to domain zero.
• The VLAN tag rule configured for the specified profile is applied only to traffic learned on UNP ports
to which the profile is applied. For example:
– Edge profiles classify traffic received on UNP edge ports.
– VLAN profiles classify traffic received on UNP bridge ports.
– SPB service profiles classify traffic received on UNP access ports.
• It is possible to configure a single VLAN-based profile, a single SPB service-based profile, or both
types of profiles for the classification rule. Configuring both types of profiles for the same rule ensures
that the rule will be applied to traffic received on both types of UNP ports (bridge and access).
• Adding a rule does not cause a MAC address flush. If necessary, use the no mac-learning command to
clear and re-learn any addresses after the rule is added.
• Untagged packets are not classified with this rule if a VLAN ID tag is specified with this command.

• A VLAN tag rule can be combined with a Group ID rule, Port rule, MAC address rule, or IP address
rule to configure a binding classification rule for an Edge profile (binding rules are not supported with
VLAN and SPB service profiles). The following binding rule combinations are supported:
– Port + MAC address + IP address + VLAN tag
– Port + MAC address + VLAN tag
– Port + IP address + VLAN tag
– Group ID + MAC address + IP address + VLAN tag
– Group ID + MAC address + VLAN tag
– Group ID + IP address + VLAN tag

Examples
-> unp classification vlan-tag 200 edge-profile CustA
-> unp classification vlan-tag 400 vlan-profile CustB
-> unp classification vlan-tag 300 tag-position inner spb-profile CustC
-> unp classification vlan-tag 10 unp-customer-domain 3 vlan-profile CustB spb-
profile CustC
-> no unp classification vlan-tag 200 edge-profile
-> no unp classification vlan-tag 400
-> no unp classification vlan-tag 10 unp-customer-domain 3

Release History
Release 8.2.1; command was introduced.

page 36-130 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification vlan-tag

Related Commands

unp classification Configures the classification status for the UNP port. Rules are not
applied when classification is disabled for the port.
unp unp-customer-domain Assigns a UNP port or link aggregate to the specified customer domain
(UNP group) ID.
unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
unp vlan-profile Configures a UNP VLAN profile. This type of profile is applied to
traffic learned on UNP bridge ports and link aggregates.
unp spb-profile Configures a UNP SPB service profile. This type of profile is applied to
traffic learned on UNP access ports and link aggregates.
show unp classification Displays the UNP classification rule configuration.

MIB Objects
alaDaUNPVlanRuleTable
alaDaUNPVlanRuleVlanTag
alaDaUNPVlanRuleVlanTagPosition
alaDaUNPVlanRuleEdgeProf
alaDaUNPVlanRuleRowStatus
alaDaUNPCustDomainVlanTagRuleTable
alaDaUNPCustDomainVlanTagRuleVlan
alaDaUNPCustDomainVlanTagRuleTagPosition
alaDaUNPCustDomainVlanTagRuleDomainId
alaDaUNPCustDomainVlanTagRuleVlanProfileName
alaDaUNPCustDomainVlanTagRuleSpbProfileName
alaDaUNPCustDomainVlanTagRuleRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-131
unp classification lldp med-endpoint ip-phone UNP Commands

unp classification lldp med-endpoint ip-phone

Defines a Link Layer Discovery Protocol (LLDP) classification rule for the specified UNP Edge profile.
This rule is specifically for IP phones. When the LLDP TLVs from an IP phone are detected, the specified
profile is applied to the IP phone.
unp classification lldp med-endpoint ip-phone edge-profile profile_name
no unp classification lldp med-endpoint ip-phone edge-profile

Syntax Definitions

profile_name The name of an existing Edge profile.

Defaults
By default, no classification rules are defined for an Edge profile.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the rule from an Edge profile configuration. When a
classification rule is removed or modified, all MAC addresses classified with that rule are flushed.
• The LLDP rule configured for the specified Edge profile is applied only to traffic learned on UNP Edge
ports. This type of rule is not configurable for VLAN and SPB service profiles.

Examples
-> unp classification lldp med-endpoint ip-phone edge-profile myProfile1
-> no unp classification lldp med-endpoint ip-phone edge-profile

Release History
Release 8.1.1; command was introduced.

Related Commands

unp classification Configures the classification status for the UNP port. Rules are not
applied when classification is disabled for the port.
unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
show unp classification Displays the UNP classification rule configuration.

page 36-132 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification lldp med-endpoint ip-phone

MIB Objects
alaDaUNPEndPoinRuleTable
alaDaUNPEndPoinRuleId
alaDaUNPEndPoinEdgeProfile
alaDaUNPEndPoinRuleRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-133
unp classification authentication-type UNP Commands

unp classification authentication-type

Defines an Authentication Type classification rule for the specified UNP Edge profile. If the type of
authentication applied to the device traffic matches the authentication type defined for the rule, the
specified profile is applied to the device.
unp classification authentication-type {none | mac [fail] | 802.1x [fail]} [vlan-tag vlan_id] edge-profile
profile_name
no unp classification authentication-type {none | mac [fail] | 802.1x [fail]} edge-profile

Syntax Definitions

none No authentication was applied to the device.

mac The device was successfully authenticated through MAC authentication.
802.1x The device was successfully authenticated through 802.1X
authentication.
fail Optional parameter to specify failed MAC or 802.1x authentication.
vlan_id A VLAN ID.
profile_name The name of an existing Edge profile.

Defaults
By default, no classification rules are defined for an Edge profile.

parameter default
vlan_id none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the rule from an Edge profile configuration. When a
classification rule is removed or modified, all MAC addresses classified with that rule are flushed.
• The optional fail parameter is used only in combination with the mac or 802.1x parameter. When
configured, the device is checked for a failed MAC or 802.1x authentication condition to determine
whether or not the profile is applied.
• When the fail parameter is not specified (the default), the device is checked for a successful MAC or
802.1x authentication condition to determine whether or not the profile is applied.
• When configuring this type of classification rule, specify and optional VLAN tag before specifying the
UNP Edge profile name for which the rule will classify traffic.
• If a VLAN ID tag is specified with this command, the UNP is only applied to tagged packets
containing the specified authentication type and the VLAN ID tag.

page 36-134 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification authentication-type

• Untagged packets are only classified using the specified authentication type; the VLAN ID tag is
ignored if it is specified with this rule.
• The Authentication Type rule configured for the specified Edge profile is applied only to traffic learned
on UNP edge ports. This type of rule is not configurable for VLAN and SPB service profiles.

Examples
-> unp classification authentication-type 802.1X edge-profile myProfile1
-> no unp classification authentication-type 802.1X edge-profile

-> unp classification authentication-type MAC edge-profile myProfile2

-> no unp classification authentication-type MAC edge-profile

-> unp classification authentication-type 802.1X fail edge-profile myProfile3

-> no unp classification authentication-type 802.1X fail edge-profile

-> unp classification authentication-type MAC fail edge-profile myProfile4

-> no unp classification authentication-type MAC fail edge-profile

-> unp classification authentication-type MAC vlan-tag 10 edge-profile myProfile4

-> no unp classification authentication-type MAC edge-profile

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; vlan-tag parameter added.

Related Commands

unp classification Configures the classification status for the UNP port. Rules are not
applied when classification is disabled for the port.
unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
show unp classification Displays the UNP classification rule configuration.

MIB Objects
alaDaUNPAuthRuleTable
alaDaUNPAuthRuleType
alaDaUNPAuthRuleEdgeProfile
alaDaUNPAuthRuleRowStatus
alaDaUNPAuthRuleVlanTag

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-135
unp classification-rule UNP Commands

unp classification-rule
Configures an extended classification rule name and assigns a precedence value to the specified name.
This type of rule defines a list of rule conditions, all of which a device must match to be classified into the
Edge profile associated with the extended rule name.
unp classification-rule rule_name [precedence precedence_value] [edge-profile profile_name]
no unp classification-rule rule_name [edge-profile profile_name]

Syntax Definitions

rule_name The name to associate with the extended classification rule.

precedence_value The precedence level to assign to the extended rule. The valid range is
1–255 (1 = lowest, 255 = highest).
profile_name The name of an existing Edge profile to assign to the extended rule.

Defaults

parameter default
precedence_value 1
profile_name none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the extended rule from the switch configuration or to
remove the Edge profile name assigned to the rule.
• The precedence value specified with this command is used to determine precedence among extended
classification rules.
• Extended rules take precedence over all other UNP classification rules (individual rules and binding
rule combinations).
• Although some individual classification rules can be combined to form a binding rule, a binding rule is
not assigned a rule name and does not have a configurable precedence value. In addition, extended
classification rules offer more rule combinations than binding rules.
• An extended classification rule is associated with an Edge profile and applied to traffic learned on UNP
edge ports. This type of rule is not configurable for VLAN and SPB service profiles.

Examples
-> unp classification-rule ext-r1
-> unp classification-rule ext-r1 edge-profile UNP1
-> no unp classification-rule ext-r1 edge-profile UNP1
-> no unp classification-rule ext-r1

page 36-136 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification-rule

Release History
Release 8.1.1; command was introduced.

Related Commands

unp classification-rule port Defines a Port rule condition for an extended classification rule.
unp classification-rule group-id Defines a Group ID rule condition for an extended classification rule.
unp classification-rule mac- Defines a MAC address rule condition for an extended classification
address rule.
unp classification-rule mac-oui Defines a MAC OUI rule condition for an extended classification rule.
unp classification-rule mac- Defines a MAC address range rule condition for an extended
address-range classification rule.
unp classification-rule ip- Defines an IP address rule condition for an extended classification rule.
address
unp classification-rule vlan-tag Defines a VLAN tag rule condition for an extended classification rule.
unp classification-rule lldp Defines an LLDP endpoint rule condition for an extended classification
med-endpoint ip-phone rule.
unp classification-rule Defines an authentication type rule condition for an extended
authentication-type classification rule.
unp edge-profile Configures a UNP Edge profile. This type of profile is applied to traffic
learned on UNP Edge ports and link aggregates.
unp classification Configures the classification status for the UNP port. Rules are not
applied when the port classification status is disabled.
show unp classification-rule Displays the UNP extended classification rule configuration.

MIB Objects
alaDaUNPClassifRuleTable
alaDaUNPClassifRuleName
alaDaUNPClassifRulePrecedenceNum
alaDaUNPClassifRuleEdgeProfile

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-137
unp classification-rule port UNP Commands

unp classification-rule port

Defines a Port rule condition for the specified extended classification rule name.
unp classification-rule rule_name {port chassis/slot/port1[-port2] | linkagg agg_id}
no unp classification-rule rule_name {port | linkagg}

Syntax Definitions

rule_name The name of an extended classification rule to which the port condition
is assigned.
chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id Link aggregate ID.

Defaults
By default, no conditions are defined when an extended classification rule is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the Port rule condition from the specified extended
classification rule name.
• If the extended classification rule name specified with this command does not exist, the switch will
automatically create the extended rule name and associate the port rule condition with that name.

Examples
-> unp classification-rule ext-r1 port 1/1/10
-> no unp classification-rule ext-r1 port 1/1/10

-> unp classification-rule ext-r2 port 1/1/1-5

-> no unp classification-rule ext-r2 port 1/1/1-5

Release History
Release 8.1.1; command was introduced.

page 36-138 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification-rule port

Related Commands

unp classification-rule Configures an extended classification rule name and associated Edge
profile.
unp classification-rule group-id Configures a Group ID rule condition for an extended rule.
unp classification-rule mac- Configures a MAC address, MAC OUI, or MAC range rule condition
address for an extended rule.
unp classification-rule ip- Configures an IP address rule condition for an extended rule.
address
unp classification-rule lldp Configures an LLDP endpoint rule condition for an extended rule.
med-endpoint ip-phone
unp classification-rule Configures an authentication type rule condition for an extended rule.
authentication-type
show unp classification-rule Displays the UNP extended classification rule configuration.

MIB Objects
alaDaUNPClassifRuleTable
alaDaUNPClassifRuleName
alaDaUNPClassifRulePort

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-139
unp classification-rule group-id UNP Commands

unp classification-rule group-id

Defines a Group ID rule condition for the specified extended classification rule name.
unp classification-rule rule_name group-id group_id
no unp classification-rule rule_name group-id

Syntax Definitions

rule_name The name of an extended classification rule to which the port condition
is assigned.
group_id Group ID number.

Defaults
By default, no conditions are defined when an extended classification rule is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the Group ID rule condition from the specified extended
classification rule name.
• If the extended classification rule name specified with this command does not exist, the switch will
automatically create the extended rule name and associate the port rule condition with that name.

Examples
-> unp classification-rule ext-r1 group-id GRP1
-> no unp classification-rule ext-r1 group-id

Release History
Release 8.1.1; command was introduced.

Related Commands

unp classification-rule Configures an extended classification rule name and associated Edge
profile.
show unp classification-rule Displays the UNP extended classification rule configuration.

MIB Objects
alaDaUNPClassifRuleTable
alaDaUNPClassifRuleName
alaDaUNPClassifRuleGroupId

page 36-140 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification-rule mac-address

unp classification-rule mac-address

Defines a MAC address, rule condition for the specified extended classification rule name.
unp classification-rule rule_name mac-address mac_address
no unp classification-rule rule_name mac-address

Syntax Definitions

rule_name The name of an extended classification rule to which the port condition
is assigned.
mac_address MAC address (e.g., 00:00:39:59:f1:0c).

Defaults
By default, no conditions are defined when an extended classification rule is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the rule condition from the specified extended
classification rule name.
• If the extended classification rule name specified with this command does not exist, the switch will
automatically create the extended rule name and associate the port rule condition with that name.

Examples
-> unp classification-rule ext-r1 mac-address 00:11:22:33:44:55
-> no unp classification-rule ext-r1 mac-address

Release History
Release 8.1.1; command was introduced.

Related Commands

unp classification-rule Configures an extended classification rule name and associated Edge
profile.
show unp classification-rule Displays the UNP extended classification rule configuration.

MIB Objects
alaDaUNPClassifRuleTable
alaDaUNPClassifRuleName
alaDaUNPClassifRuleMacAddr

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-141
unp classification-rule mac-oui UNP Commands

unp classification-rule mac-oui

Defines a MAC OUI rule condition for the specified extended classification rule name.
unp classification-rule rule_name mac-oui mac_oui
no unp classification-rule rule_name mac-oui

Syntax Definitions

rule_name The name of an extended classification rule to which the port condition
is assigned.
mac_address MAC address (e.g., 00:00:39:59:f1:0c).
mac_oui The Organizationally Unique Identifier (OUI) of the MAC address. The
OUI is the first three octets of the MAC address (for example, e8:39:35
is the OUI of MAC address e8:39:35:10:fe:11).

Defaults
By default, no conditions are defined when an extended classification rule is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the rule condition from the specified extended
classification rule name.
• If the extended classification rule name specified with this command does not exist, the switch will
automatically create the extended rule name and associate the port rule condition with that name.

Examples
-> unp classification-rule ext-r1 mac-oui 00:11:22
-> no unp classification-rule ext-r1 mac-oui

Release History
Release 8.1.1; command was introduced.

page 36-142 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification-rule mac-oui

Related Commands

unp classification-rule Configures an extended classification rule name and associated Edge
profile.
show unp classification-rule Displays the UNP extended classification rule configuration.

MIB Objects
alaDaUNPClassifRuleTable
alaDaUNPClassifRuleName
alaDaUNPClassifRuleMacOuiAddr

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-143
unp classification-rule mac-address-range UNP Commands

unp classification-rule mac-address-range

Defines a MAC address range rule condition for the specified extended classification rule name.
unp classification-rule rule_name mac-address-range low_mac_address high_mac_address
no unp classification-rule rule_name mac-address-range

Syntax Definitions

rule_name The name of an extended classification rule to which the port condition
is assigned.
low_mac_address MAC address that defines the low end of the range (for example,
00:00:39:59:f1:00).
high_mac_address MAC address that defines the high end of the range (for example,
00:00:39:59:f1:90).

Defaults
By default, no conditions are defined when an extended classification rule is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the rule condition from the specified extended
classification rule name.
• If the extended classification rule name specified with this command does not exist, the switch will
automatically create the extended rule name and associate the port rule condition with that name.

Examples
-> unp classification-rule ext-r1 mac-address-range 00:11:22:33:44:55
00:11:22:33:44:66
-> no unp classification-rule ext-r1 mac-address-range

Release History
Release 8.1.1; command was introduced.

page 36-144 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification-rule mac-address-range

Related Commands

unp classification-rule Configures an extended classification rule name and associated Edge
profile.
show unp classification-rule Displays the UNP extended classification rule configuration.

MIB Objects
alaDaUNPClassifRuleTable
alaDaUNPClassifRuleName
alaDaUNPClassifRuleMacRngLoaddr
alaDaUNPClassifRuleMacRngHiaddr

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-145
unp classification-rule ip-address UNP Commands

unp classification-rule ip-address

Defines an IP network address rule condition for the specified extended classification rule name.
unp classification-rule rule_name ip-address ip_address mask subnet_mask
no unp classification-rule rule_name ip-address

Syntax Definitions

rule_name The name of an extended classification rule to which the IP address rule
condition is assigned.
ip_address IPv4 network address (e.g., 10.0.0.0, 171.15.0.0, 196.190.254.0).
subnet_mask An IP address mask to identify the IP subnet for the interface (supports
class-less masking).

Defaults
By default, no conditions are defined when an extended classification rule is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the rule condition from the specified extended
classification rule name.
• If the extended classification rule name specified with this command does not exist, the switch will
automatically create the extended rule name and associate the port rule condition with that name.

Examples
-> unp classification-rule ext-r1 ip-address 10.0.0.20 mask 255.0.0.0
-> no unp classification-rule ip-address

Release History
Release 8.1.1; command was introduced.

page 36-146 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification-rule ip-address

Related Commands

unp classification-rule Configures an extended classification rule name and associated Edge
profile.
show unp classification-rule Displays the UNP extended classification rule configuration.

MIB Objects
alaDaUNPClassifRuleTable
alaDaUNPClassifRuleName
alaDaUNPClassifRuleIpAddressType
alaDaUNPClassifRuleIpAddress
alaDaUNPClassifRuleIpMaskType
alaDaUNPClassifRuleIpMask

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-147
unp classification-rule vlan-tag UNP Commands

unp classification-rule vlan-tag

Defines a VLAN tag rule condition for the specified extended classification rule name.
unp classification-rule rule_name vlan-tag vlan_id
no unp classification-rule vlan-tag

Syntax Definitions

rule_name The name of an extended classification rule to which the VLAN tag rule
condition is assigned.
vlan_id A VLAN ID.

Defaults
By default, no conditions are defined when an extended classification rule is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the rule condition from the specified extended
classification rule name.
• If the extended classification rule name specified with this command does not exist, the switch will
automatically create the extended rule name and associate the port rule condition with that name.

Examples
-> unp classification-rule ext-r1 vlan-tag 200
-> no unp classification-rule vlan-tag

Release History
Release 8.2.1; command was introduced.

Related Commands

unp classification-rule Configures an extended classification rule name and associated Edge
profile.
show unp classification-rule Displays the UNP extended classification rule configuration.

MIB Objects
alaDaUNPClassifRuleTable
alaDaUNPClassifRuleName
alaDaUNPClassifRuleVlanTag

page 36-148 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification-rule lldp med-endpoint ip-phone

unp classification-rule lldp med-endpoint ip-phone

Defines an LLDP rule condition for the specified extended classification rule name. This rule condition is
specifically to detect IP phone TLVs.
unp classification-rule rule_name lldp med-endpoint ip-phone
no unp classification-rule rule_name lldp med-endpoint ip-phone

Syntax Definitions

rule_name The name of an extended classification rule to which the port condition
is assigned.

Defaults
By default, no conditions are defined when an extended classification rule is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the rule condition from the specified extended
classification rule name.
• If the extended classification rule name specified with this command does not exist, the switch will
automatically create the extended rule name and associate the port rule condition with that name.

Examples
-> unp classification-rule ext-r1 lldp med-endpoint ip-phone
-> no unp classification-rule ext-r1 lldp med-endpoint ip-phone

Release History
Release 8.1.1; command was introduced.

Related Commands

unp classification-rule Configures an extended classification rule name and associated Edge
profile.
show unp classification-rule Displays the UNP extended classification rule configuration.

MIB Objects
alaDaUNPClassifRuleTable
alaDaUNPClassifRuleName
alaDaUNPClassifRuleEndPoin

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-149
unp classification-rule authentication-type UNP Commands

unp classification-rule authentication-type

Defines an authentication type rule condition for the specified extended classification rule name.
unp classification-rule rule_name authentication-type {none | mac [fail] | 802.1x [fail]}
no unp classification-rule rule_name authentication-type

Syntax Definitions

rule_name The name of an extended classification rule to which the port condition
is assigned.
none No authentication was applied to the device.
mac The device was successfully authenticated through MAC authentication.
802.1x The device was successfully authenticated through 802.1X
authentication.
fail Optional parameter to specify failed MAC or 802.1x authentication.

Defaults
By default, no conditions are defined when an extended classification rule is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the rule condition from the specified extended
classification rule name.
• If the extended classification rule name specified with this command does not exist, the switch will
automatically create the extended rule name and associate the port rule condition with that name.
• The optional fail parameter is used only in combination with the mac or 802.1x parameter. When
configured, the device is checked for a failed MAC or 802.1x authentication condition to determine
whether or not the profile is applied.
• When the fail parameter is not specified (the default), the device is checked for a successful MAC or
802.1x authentication condition to determine whether or not the profile is applied.

Examples
-> unp classification-rule ext-r1 authentication-type 8021x
-> no unp classification-rule ext-r1 authentication-type

-> unp classification-rule ext-r1 authentication-type mac

-> no unp classification-rule ext-r1 authentication-type

-> unp classification-rule ext-r1 authentication-type 8021X fail

-> no unp classification-rule ext-r1 authentication-type

page 36-150 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp classification-rule authentication-type

Release History
Release 8.1.1; command was introduced.

Related Commands

unp classification-rule Configures an extended classification rule name and associated Edge
profile.
show unp classification-rule Displays the UNP extended classification rule configuration.

MIB Objects
alaDaUNPClassifRuleTable
alaDaUNPClassifRuleName
alaDaUNPClassifRuleAuthType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-151
unp user-role UNP Commands

unp user-role
Configures a user-defined role name and assigns a precedence value to the specified name. This type of
role is used to define a list of conditions and a QoS policy list name. If the current context of a device
matches all the role conditions, then the policy list is applied to that device.
unp user-role role_name [precedence precedence_value]
no unp user-role role_name

Syntax Definitions

role_name The name to associate with the user-defined role.

precedence_value The precedence level to assign to the user-defined role. The valid range
is 1–255 (1 = lowest, 255 = highest).

Defaults

parameter default
precedence_value 1

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the user-defined role from the switch configuration.

• The precedence value specified with this command is used to determine precedence among other user-
defined roles.
• Every time the user context changes for a device, all the user-defined roles are checked to see if there is
a role that matches the current user context.
• Only one user-defined role per user is allowed because only one QoS policy list per user is allowed.

Examples
-> unp user-role role1
-> unp user-role role2 precedence 255
-> no unp user-role role2

Release History
Release 8.1.1; command was introduced.

page 36-152 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp user-role

Related Commands

unp user-role policy-list Assigns a QoS policy list to a user-defined role.

unp user-role edge-profile Configures an Edge profile condition for a user-defined role name.
unp user-role authentication- Defines an authentication type condition for a user-defined role name.
type
unp user-role cp-status-post- Configures the Captive Portal post login status as a condition for a user-
login defined role.
show unp user-role Displays the user-defined role configuration for the switch.

MIB Objects
alaDaUNPUserRoleTable
alaDaUNPUserRoleName
alaDaUNPUserRolePrecedenceNum

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-153
unp user-role policy-list UNP Commands

unp user-role policy-list

Assigns a QoS policy list to the specified user-defined role name. When the context of a user device
matches all the user-defined role conditions, the policy list associated with the role is applied to the device.
unp user-role role_name policy-list list_name
no unp user-role role_name policy-list

Syntax Definitions

role_name The name of a user-defined role to which the QoS policy list is assigned.
list_name The name of an existing QoS policy list.

Defaults
By default, no QoS policy list is assigned to a user-defined role.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a QoS policy list from the specified user-defined role.

• If the user-defined role name specified with this command does not exist, the switch will automatically
create the role name and associate the QoS policy list with that name.
• The QoS policy list name specified with this command must already exist in the switch configuration.

Examples
-> unp user-role role1 policy-list role1-list
-> unp user-role role2 policy-list role2-list
-> no unp user-role role2 policy-list

Release History
Release 8.1.1; command was introduced.

page 36-154 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp user-role policy-list

Related Commands

unp user-role Configures the name and precedence for a user-defined role.
unp user-role edge-profile Configures an Edge profile condition for a user-defined role name.
unp user-role authentication- Defines an authentication type condition for the specified user-defined
type role name.
unp user-role cp-status-post- Configures the Captive Portal post login status as a condition for a user-
login defined role.
policy list Configures a QoS policy list.
show unp user-role Displays the user-defined role configuration for the switch.

MIB Objects
alaDaUNPUserRoleTable
alaDaUNPUserRoleName
alaDaUNPUserRolePolicyList

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-155
unp user-role edge-profile UNP Commands

unp user-role edge-profile

Defines an Edge profile condition for the specified user-defined role name.
unp user-role role_name edge-profile profile_name
no unp user-role role_name edge-profile

Syntax Definitions

role_name The name of a user-defined role.

profile_name The name of an existing Edge profile.

Defaults
By default, the Edge profile condition is not configured for a user-defined role.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the Edge profile name as a condition for the specified
user-defined role.
• If the user-defined role name specified with this command does not exist, the switch will automatically
create the role name and associate the Edge profile with that name.
• The Edge profile name specified with this command must already exist in the switch configuration.

Examples
-> unp user-role role1 edge-profile edge1
-> no unp user-role role1 edge-profile

Release History
Release 8.1.1; command was introduced.

page 36-156 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp user-role edge-profile

Related Commands

unp user-role Configures the name and precedence for a user-defined role.
unp user-role policy-list Assigns a QoS policy list to a user-defined role.
unp user-role authentication- Defines an authentication type condition for the specified user-defined
type role name.
unp user-role cp-status-post- Configures the Captive Portal post login status as a condition for a user-
login defined role.
show unp user-role Displays the user-defined role configuration for the switch.

MIB Objects
alaDaUNPUserRoleTable
alaDaUNPUserRoleName
alaDaUNPUserRoleEdgeProfile

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-157
unp user-role authentication-type UNP Commands

unp user-role authentication-type

Defines an authentication type condition for the specified user-defined role name.
unp user-role role_name authentication-type {none | mac [fail] | 802.1x [fail]}
no unp user-role role_name authentication-type

Syntax Definitions

role_name The name of a user-defined role.

none No authentication was applied to the device.
mac The device was successfully authenticated through MAC authentication.
802.1x The device was successfully authenticated through 802.1X
authentication.
fail Optional parameter to specify failed MAC or 802.1x authentication.

Defaults
By default, the authentication type condition is not configured for a user-defined role.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the authentication type as a condition for the specified
user-defined role.
• If the user-defined role name specified with this command does not exist, the switch will automatically
create the role name and associate the Edge profile with that name.
• The optional fail parameter is used only in combination with the mac or 802.1x parameter. When
configured, the device is checked for a failed MAC or 802.1x authentication condition to determine
whether or not the user role (policy list associated with the derivation rule) is applied to the device.
• When the fail parameter is not specified (the default), the device is checked for a successful MAC or
802.1x authentication condition to determine whether or not the user role (policy list associated with
the derivation rule) is applied to the device.

Examples
-> unp user-role role1 authentication-type 8021x
-> no unp user-role role1 authentication-type

-> unp user-role role1 authentication-type mac

-> no unp user-role role1 authentication-type

-> unp user-role role1 authentication-type 8021X fail

-> no unp user-role role1 authentication-type

page 36-158 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp user-role authentication-type

Release History
Release 8.1.1; command was introduced.

Related Commands

unp user-role Configures the name and precedence for a user-defined role.
unp user-role policy-list Assigns a QoS policy list to a user-defined role.
unp user-role edge-profile Configures an Edge profile condition for a user-defined role name.
unp user-role cp-status-post- Configures the Captive Portal post login status as a condition for a user-
login defined role.
show unp user-role Displays the user-defined role configuration for the switch.

MIB Objects
alaDaUNPUserRoleTable
alaDaUNPUserRoleName
alaDaUNPUserRoleAuthType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-159
unp user-role cp-status-post-login UNP Commands

unp user-role cp-status-post-login

Configures the Captive Portal (CP) post login status as a condition for the specified user-defined role
name.
unp user-role role_name cp-status-post-login
no unp user-role role_name cp-status-post-login

Syntax Definitions

role_name The name of an existing user-defined role.

Defaults
By default, the CP post login status condition is not configured for a user-defined role.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the CP post login status as a condition for the specified
user-defined role.
• When this condition is active for a user-defined role, the switch will check to see if a device is in a CP
post login state before applying the QoS policy list associated with the user-defined role.

Examples
-> unp user-role role1 cp-status-post-login
-> no unp user-role role1 cp-status-post-login

Release History
Release 8.1.1; command was introduced.

page 36-160 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp user-role cp-status-post-login

Related Commands

unp user-role Configures the name and precedence for a user-defined role.
unp user-role policy-list Assigns a QoS policy list to a user-defined role.
unp user-role edge-profile Configures an Edge profile condition for a user-defined role name.
unp user-role authentication- Configures an authentication type condition for a user-defined role
type name.
show unp user-role Displays the user-defined role configuration for the switch.

MIB Objects
alaDaUNPUserRoleTable
alaDaUNPUserRoleName
alaDaUNPUserRolePostLoginStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-161
unp restricted-role policy-list UNP Commands

unp restricted-role policy-list

Assigns an explicit QoS policy list to an implicit restricted role. When the switch assigns a user device to
one of the restricted role states (unauthorized, Quarantine Manager, or Captive Portal pre-login), the
explicit QoS policy list is applied instead of the built-in policy list associated with the restricted role.
unp restricted-role {unauthorized | qmr | cp-prelogin} policy-list list_name
no unp restricted-role {unauthorized | qmr | cp-prelogin} policy-list

Syntax Definitions

list_name The name of an existing QoS policy list.

unauthorized Applies the explicit policy list to unauthorized devices.
qmr Applies the explicit policy list to quarantined devices.
cp-prelogin Applies the explicit policy list to devices in a Captive Portal pre-login
state.

Defaults
By default, the built-in policy list associated with the restricted role state.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the explicit QoS policy list assignment.

• An explicit QoS policy list overrides the built-in policy list associated with the restricted role state.
When the explicit policy list assignment is removed, the switch reverts back to using the built-in policy
list associated with the restricted role state.

Examples
-> unp restricted-role unauthorized policy-list unauth1
-> unp restricted-role qmr policy-list quarantined1
-> unp restricted-role cp-prelogin policy-list cplogin1

Release History
Release 8.1.1; command was introduced.

page 36-162 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp restricted-role policy-list

Related Commands

policy list Configures a QoS policy list.

show unp restricted-role Displays the UNP restricted role policy list configuration.

MIB Objects
alaDaUNPRstrctedRoleTable
alaDaUNPRstrctedRoleType
alaDaUNPRstrctedRolePolicyList

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-163
unp group-id UNP Commands

unp group-id
Configures a group ID to which UNP Edge ports or link aggregates are assigned to form a logical domain.
The Group-ID is also used in UNP classification rules as a criteria for classifying only those ports that are
assigned to a specific Group ID.
unp group-id group_id [description group_description]
no unp group-id group_id

Syntax Definitions

group_id A numerical group ID. The valid range is 0–255.

group_description An alphanumeric string (1–128 characters).

Defaults
By default, no group ID is assigned to UNP ports.

parameter default
group_description group ID

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the group ID from the switch configuration.

• UNP edge ports are assigned to group IDs to form a logical domain. UNP bridge and service access
ports are assigned to customer domain IDs to form a logical domain.
• When a group ID is specified in a classification rule, the rule is applied to all ports and link aggregates
that are assigned to the group ID that matches the ID defined by the rule.

Examples
-> unp group-id 1
-> unp group-id 2 description CustomerA
-> no unp group-id 2

Release History
Release 8.1.1; command was introduced.

page 36-164 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp group-id

Related Commands

unp port group-id Assigns UNP ports and link aggregate IDs to a Group ID.
show unp group-id Displays the group ID configuration for the switch.

MIB Objects
alaDaUnpGroupIdTable
alaDaUnpGroupId
alaDaUnpGroupDescription

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-165
unp customer-domain UNP Commands

unp customer-domain
Configures a customer domain ID to which UNP ports and classification rules are assigned. The customer
domain ID is also used in UNP classification rules as a criteria for classifying only those ports that are
assigned to a specific domain ID.
unp customer-domain domain_id [description domain_description]
no unp customer-domain domain_id [description domain_description]

Syntax Definitions

domain_id A numerical customer domain ID.

domain_description An alphanumeric string (1–128 characters).

Defaults
By default, customer domain ID zero (0) is assigned to all UNP ports.

parameter default
domain_description Domain ID

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the customer domain ID from the switch configuration.
When a domain ID is removed, all UNP ports are assigned to the default domain and any classification
rules assigned to that domain are also removed.
• Customer domains are used to group physical UNP ports or link aggregates into one logical domain.

• UNP bridge and service access ports are assigned to customer domain IDs to form a logical domain.
UNP edge ports are assigned to group IDs to form a logical domain.
• Once a port is assigned to a specific customer domain, classification rules associated with the same
customer domain ID are applied only to UNP ports associated with the same domain ID.

Examples
-> unp customer-domain 1
-> unp customer-domain 2 description CustomerA
-> no unp customer-domain 2

Release History
Release 8.2.1; command was introduced.

page 36-166 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp customer-domain

Related Commands

unp unp-customer-domain Assigns a UNP port or link aggregate to the specified customer domain
(UNP group) ID.
show unp customer-domain Displays the customer domain ID configuration for the switch.

MIB Objects
alaDaUnpCustomerDomainTable
alaDaUnpCustomerDomainId
alaDaUnpCustomerDomainDesc

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-167
unp policy validity-period UNP Commands

unp policy validity-period

Configures a UNP validity period policy that specifies the days and times during which a device can
access the network. This type of policy is assigned to a UNP Edge profile and applied to devices classified
into the profile. A device must match all of the policy criteria.
unp policy validity-period policy_name [days days] [months months] [hours hh:mm to hh:mm]
[interval mm:dd:yyyy hh:mm to mm:dd:yyyy hh:mm] [timezone zones]
unp policy validity-period name no {days | months | hours | interval | timezone}
no unp policy validity-period name

Syntax Definitions

policy_name The name of the validity period (up to 31 alphanumeric characters).

days The day(s) of the week this validity period is active. Enter the actual day
of the week (e.g., monday, tuesday, wednesday, etc.).
months The month(s) in which the validity period is active. Enter the actual
month (e.g., january, february, march, etc.).
hh:mm The time of day, specified in hours and minutes, the validity period
starts and the time of day the validity period ends (e.g., 10:30 to 11:30).
mm:dd:yyyy hh:mm An interval of time during which the validity period is active. Specify a
start and end to the interval period by entering a beginning date and time
followed by an end date and time (e.g., 11:01:2005 12:01 to 11:02:2005
12:01).
zones The timezone in which the validity period is active (for example, pst,
est, gmt, etc.)

Defaults

parameter default
days no restriction
months no restriction
hh:mm no specific
time
mm:dd:yyyy hh:mm no interval
zones local timezone

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a UNP period policy from the configuration, or to remove
parameters from a particular period policy.

page 36-168 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp policy validity-period

• Any combination of the days, months, hours, interval, and timezone parameters is allowed. The
validity period is only in effect when all specified parameters are true.
• Use the unp edge-profile period-policy command to associate a period policy with a UNP Edge
profile.

Examples
-> unp policy validity-period "Office-Time"
-> no unp policy validity-period "Office-Time"

-> unp policy validity-period "Office-Time" days MONDAY

-> unp policy validity-period "Office-Time" days MONDAY time-zone IST
-> unp policy validity-period "Office-Time" days MONDAY no time-zone
-> unp policy validity-period "Office-Time" no days MONDAY

-> unp policy validity-period "Office-Time" days MONDAY WEDNESDAY

-> unp policy validity-period "Office-Time" days MONDAY WEDNESDAY time-zone PST
-> unp policy validity-period "Office-Time" no days MONDAY TUESDAY

-> unp policy validity-period "Office-Time" hours 9:00 to 17:00

-> unp policy validity-period "Office-Time" hours 9:00 to 17:00 time-zone IST
-> unp policy validity-period "Office-Time" no hours 9:00 to 17:00

-> unp policy validity-period "holiday" months JANUARY

-> unp policy validity-period "holiday" no months JANUARY

-> unp policy validity-period "holiday" months FEBRUARY MARCH time-zone IST
-> unp policy validity-period "holiday" months FEBRUARY no time-zone IST
-> unp policy validity-period "holiday" no months FEBRUARY MARCH

-> unp policy validity-period "Seminar" interval 02/01/13 10:30 to 02/05/13 16:00
-> unp policy validity-period "Seminar" no interval 02/01/13 10:30 to 02/05/13
16:00

-> unp policy validity-period "Seminar" interval 02/01/13 10:30 to 02/05/13 16:00
time-zone PST
-> unp policy validity-period "Seminar" interval 02/01/13 10:30 to 02/05/13 16:00
no time-zone PST
-> unp policy validity-period "Seminar" no interval 02/01/13 10:30 to 02/05/13
16:00

Release History
Release 8.1.1; command introduced.

Related Commands

unp edge-profile period-policy Assigns a UNP period policy to an Edge profile.

show unp policy validity-period Displays information about the UNP period policy configuration.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-169
unp policy validity-period UNP Commands

MIB Objects
alaDaUNPValidityPeriodTable
alaDaUNPValidityPeriodName
alaDaUNPValidityPeriodDays
alaDaUNPValidityPeriodDaysStatus
alaDaUNPValidityPeriodMonths
alaDaUNPValidityPeriodMonthsStatus
alaDaUNPValidityPeriodHour
alaDaUNPValidityPeriodHourStatus
alaDaUNPValidityPeriodEndHour
alaDaUNPValidityPeriodInterval
alaDaUNPValidityPeriodIntervalStatus
alaDaUNPValidityPeriodEndInterval
alaDaUNPValidityPeriodTimezone
alaDaUNPValidityPeriodTimezoneStatus
alaDaUNPValidityPeriodActiveStatus

page 36-170 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp policy validity-location

unp policy validity-location

Configures a UNP validity location policy that defines a specific location from which a device can access
the network. This type of policy is assigned to a UNP Edge profile and applied to devices classified into
the profile. A device must match all of the policy criteria defined.
unp policy validity-location policy_name [port chassis/slot/port[-port2] | linkagg agg_id[-agg_id2]
[system-name system_name] [system-location system_location]
unp policy validity-period name no {days | months | hours | interval | timezone}
no unp policy validity-period name

Syntax Definitions

policy_name The name of the validity period (up to 31 alphanumeric characters).

chassis The chassis identifier.
slot/port[-port2] The slot and port number (3/1) of a UNP Edge port. Use a hyphen to
specify a range of ports (3/1-8).
agg_id[-agg_id2] The link aggregate ID number of a UNP link aggregate. Use a hyphen to
specify a range of link aggregate IDs (10-15).
system_name The configured system name for the switch from which the device can
access the network.
system_location The configured system location for the switch from which the device
can access the network.

Defaults

parameter default
chassis/slot/port no restriction
agg_id no restriction
system_name no restriction
system_location no restriction

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove a UNP location policy from the configuration, or to
remove parameters from a particular location policy.
• Any combination of the port, linkagg, system-name, and system-location parameters is allowed. The
location policy is only in effect when all specified parameters are true.
• Use the unp edge-profile location-policy command to associate a location policy with a UNP Edge
profile.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-171
unp policy validity-location UNP Commands

Examples
-> unp policy validity-location ALU-NA
-> no unp policy validity-location ALU-NA

-> unp policy validity-location ALU-NA port 1/1/10

-> unp policy validity-location ALU-NA no port
-> unp policy validity-location ALU-NA port 1/1/1-5
-> unp policy validity-location ALU-NA no port

-> unp policy validity-location ALU-NA linkagg 10

-> unp policy validity-location ALU-NA no linkagg
-> unp policy validity-location ALU-NA linkagg 1-5
-> unp policy validity-location ALU-NA no linkagg

-> unp policy validity-location ALU-NA system-name OS6860

-> unp policy validity-location ALU-NA no system-name OS6860

-> unp policy validity-location ALU-NA system-location US-West

-> unp policy validity-location ALU-NA no system-location

Release History
Release 8.1.1; command introduced.

Related Commands

unp edge-profile location- Assigns a UNP location policy to an Edge profile.

policy
show unp policy validity- Displays information about the UNP location policy configuration.
location

MIB Objects
alaDaUNPLocationPolicyTable
alaDaUNPLocationPolicyName
alaDaUNPLocationPolicyPort
alaDaUNPLocationPolicyPortHigh
alaDaUNPLocationPolicyPortStatus
alaDaUNPLocationPolicySystemName
alaDaUNPLocationPolicySystemLocation

page 36-172 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp dynamic-vlan-configuration

unp dynamic-vlan-configuration
Configures the UNP status for dynamic VLAN configuration. When this functionality is enabled and the
UNP is created with a VLAN that does not exist, the switch will dynamically create the VLAN at the time
the UNP is created.
unp dynamic-vlan-configuration {enable | disable}

Syntax Definitions

enable Enables dynamic VLAN configuration for UNPs.

disable Disables dynamic VLAN configuration for UNPs.

Defaults
By default, dynamic VLAN configuration is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines

Note. Dynamic VLANs are not saved in the VLAN section of the boot.cfg file. However, the unp
commands to enable dynamic VLAN configuration and create a UNP are saved in the UNP section of the
boot.cfg file. As a result, the VLAN is created again on the next switch bootup.

• When dynamic VLAN configuration is disabled, creating a UNP with a VLAN that does not exist in
the switch configuration is not allowed.
• Dynamic VLAN configuration applies only to VLAN-based profiles; UNP Edge and SPB service
profiles are not supported.
• The VLAN status and other port (non-UNP port) assignments for a dynamic UNP VLAN are
configurable using standard VLAN commands. In addition, the STP status is configurable and enabled
by default when the dynamic VLAN is created.
• A dynamic VLAN cannot be deleted using standard VLAN commands (no vlan vlan_id).

• UNP dynamic VLANs are identified as a separate type of VLAN. The vlan show commands will
display this type with the default name of “UNP-DYN-VLAN” and the designated type as “UNP
Dynamic Vlan”.

Examples
-> unp dynamic-vlan-configuration enable
-> unp dynamic-vlan-configuration disable

Release History
Release 8.2.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-173
unp dynamic-vlan-configuration UNP Commands

Related Commands

unp edge-profile Configures a UNP in the switch configuration.

show unp global configuration Displays the dynamic VLAN configuration status for the switch.

MIB Objects
alaDaUNPGlobalConfiguration
alaDaUNPDynamicVlanConfigFlag

page 36-174 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp dynamic-profile-configuration

unp dynamic-profile-configuration
Configures the UNP status for dynamic profile configuration. When this functionality is enabled, a UNP
VLAN profile is dynamically created based on specific traffic conditions.
unp dynamic-profile-configuration {enable | disable}

Syntax Definitions

enable Enables dynamic profile configuration for UNPs.

disable Disables dynamic profile configuration for UNPs.

Defaults
By default, dynamic profile configuration is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When dynamic profile configuration is enabled, a UNP VLAN profile is dynamically created when the
trust VLAN tag option is enabled on the UNP bridge port or link aggregate and one of the following
conditions occurs:
– A tagged packet received on the UNP bridge port contains a VLAN tag that matches an existing
MVRP VLAN in the switch configuration that is not assigned to a profile.
– There is no matching VLAN in the switch configuration.
• Dynamically created profiles are saved in the boot.cfg file for the switch.

• By default, dynamically created profiles are automatically named dynamic_profile_vlan_id, where the
VLAN ID is the ID of the VLAN contained in the packet tag.
• After the dynamic profile is created, changing the profile name, associated VLAN ID, or the QoS
policy list is allowed. To avoid any confusion, change the profile name if the VLAN ID associated
with the profile has changed.
• If the dynamic profile configuration option is enabled along with the dynamic VLAN configuration
option and a dynamically created profile refers to a VLAN that is an MVRP VLAN, then the MVRP
VLAN is automatically converted to a dynamic UNP VLAN (UNP-DYN-VLAN).

Examples
-> unp dynamic-profile-configuration enable
-> unp dynamic-profile-configuration disable

Release History
Release 8.2.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-175
unp dynamic-profile-configuration UNP Commands

Related Commands

unp vlan-profile Configures a VLAN-based profile in the switch configuration.

unp dynamic-vlan- Configures the status of dynamic VLAN configuration. When enabled,
configuration UNP will create a VLAN at the time a profile is created that specifies a
VLAN ID that does not exist in the switch configuration.
show unp global configuration Displays the dynamic profile configuration status for the switch.

MIB Objects
alaDaUNPGlobalConfiguration
alaDaUNPDynamicProfileConfigFlag

page 36-176 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp auth-server-down

unp auth-server-down
Configures a UNP to which a device is classified if MAC or 802.1X authentication fails because the
RADIUS-capable server is unreachable. This functionality is applied to traffic received on all UNP ports.
unp auth-server-down {edge-profile | vlan-profile} profile_name
no unp auth-server-down {edge-profile | vlan-profile}

Syntax Definitions

edge-profile Assigns an Edge profile as the authentication server down UNP for
devices authenticating on edge ports.
vlan-profile Assigns a VLAN profile as the authentication server down UNP for
devices authenticating on bridge ports.
profile_name The name of an existing UNP Edge or VLAN profile.

Defaults
By default, there is no authentication server down UNP configured.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the authentication server down UNP. Removing this
profile globally disables this functionality for the switch.
• When a device is classified into the specified profile, a configurable authentication down timer is
started for that device. When the timer runs out, the authentication process is performed again. If
authentication fails again, the device is classified back into the authentication server down profile. The
switch will repeat this process until the device authentication is completed.
• When the authentication server down UNP is disabled, the associated timer is also disabled for the
switch.
• Configuring an authentication server down UNP is highly recommended when MAC or 802.1X
authentication is enabled on any UNP port or link aggregate. This is because after a switch reload, the
traffic from devices connected to UNP ports and link aggregates reaches the switch and triggers the
authentication process before route convergence has completed and the server can be reached.
– If an authentication server down UNP is configured, devices are temporarily learned in that profile
and authentication is automatically attempted again after the timeout period expires. This allows
time for the server to become reachable from the switch after a reload.
– If an authentication server down UNP is not configured, devices are learned as filtering and will
remain in that state. There is no further attempt to authenticate these devices again.

Examples
-> unp auth-server-down edge-profile edgeprof-1
-> no unp auth-server-down edge-profile

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-177
unp auth-server-down UNP Commands

-> unp auth-server-down vlan-profile vlanprof-1

-> no unp auth-server-down vlan-profile

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; vlan-profile parameter added.

Related Commands

unp auth-server-down timeout Configures the value for the authentication server down timer.
show unp global configuration Displays the profile designated as the authentication server down UNP
for the switch.

MIB Objects
alaDaUNPGlobalConfiguration
alaDaUNPAuthSrvDownEdgeProfName
alaDaUNPAuthServerDownUnp

page 36-178 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp auth-server-down timeout

unp auth-server-down timeout

Configures the authentication server down timer value. This timer value is applied to each device that is
learned in the authentication server down UNP.
unp auth-server-down {edge-profile | vlan-profile} timeout seconds

Syntax Definitions

edge-profile Configures a timer value for devices assigned to the Edge profile that is
designated as the authentication server down UNP.
vlan-profile Configures a timer value for devices assigned to the VLAN profile that
is designated as the authentication server down UNP.
seconds The number of seconds the authentication server down timer is active.
The valid range is 10 to 1000 seconds.

Defaults
By default, the timeout value is set to 60 seconds.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When the timer runs out for a particular device, the switch clears the device from the authentication
server down UNP and triggers another authentication attempt for that device. If authentication fails
again, the device is classified back into the authentication server down profile. The switch will repeat
this process until the device authentication is completed.
• When the authentication server down UNP is removed, the authentication server down timer is also
cleared.
• If the timeout value is changed, the associated timer for each device in the authentication server down
UNP is reset.

Examples
-> unp auth-server-down edge-profile timeout 500
-> unp auth-server-down vlan-profile timeout 300

Release History
Release 8.1.1; command introduced.
Release 8.2.1; vlan-profile parameter added.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-179
unp auth-server-down timeout UNP Commands

Related Commands

unp auth-server-down Specifies a UNP to which a device is classified if MAC authentication

fails because the RADIUS server is unreachable.
show unp global configuration Displays the authentication server down timeout value for the switch.

MIB Objects
alaDaUNPGlobalConfiguration
alaDaUNPAuthServerDowneEdgeProfTimeout
alaDaUNPAuthServerDownTimeout

page 36-180 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp redirect pause-timer

unp redirect pause-timer

Configures the global pause timer value for the switch. Use this command to configure the amount of time
the switch filters traffic from a non-supplicant (non-802.1X device) on a UNP port. This is done to allow
enough time for the switch to clear the authentication state of the non-supplicant, at which time the device
is re-authenticated.
unp redirect pause-timer seconds
no redirect pause-timer

Syntax Definitions

seconds The pause timer value. The valid range is 60–65535

Defaults
By default, the pause timer is set to zero.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to reset the pause time back to the default (timer no set).

• The pause timer is triggered when a Change of Authorization (COA) request is received that requires a
VLAN change for a non-supplicant (non-802.1X device) and the port bounce action is not triggered for
the device.
• During the pause time period, it is expected that the DHCP lease of the client IP in the old VLAN will
expire and the client device will re-initiate DHCP resulting in new authentication and a UNP VLAN
assignment.
• This command is used when configuring the switch to interact with the ClearPass Policy Manager
(CPPM) as part of the OmniSwitch Bring Your Own Devices (BYOD) solution.

Examples
-> unp redirect pause-timer 180
-> no unp redirect pause-timer

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-181
unp redirect pause-timer UNP Commands

Related Commands

unp redirect port-bounce Configures the port bounce action for a port or globally for the switch.
unp redirect proxy-server-port Configures the HTTP proxy port number to use for redirection.
unp redirect allowed-name Configures a list of additional IP addresses to which a host can access.
unp redirect-server Configures an IP network address to allow HTTP traffic redirection.
show unp global configuration Displays the global UNP parameter settings for the switch.

MIB Objects
alaDaUNPGlobalConfiguration
alaDaUNPRedirectPauseTimer

page 36-182 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp redirect proxy-server-port

unp redirect proxy-server-port

Configures the HTTP proxy port number to use for redirection to the ClearPass Policy Manager (CPPM)
server.
unp redirect proxy-server-port proxy_port
no unp rediret proxy-server-port

Syntax Definitions

proxy_port The HTTP proxy port number. The valid range is 1024–49151.

Defaults
By default, the redirect proxy port number is set to 8080 (traps HTTP 80, 8080, and 443).

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to set the proxy port number back to the default (8080).

• Configuring the switch to interact with the CPPM is done as part of the OmniSwitch implementation of
the Bring Your Own Devices (BYOD) solution.

Examples
-> unp redirect proxy-server-port 8887
-> no unp redirect proxy-server-port

Release History
Release 8.1.1; command was introduced.

Related Commands

unp redirect port-bounce Configures the port bounce action for a port or globally for the switch.
unp redirect pause-timer Configures the global pause timer value for the switch.
unp redirect allowed-name Configures a list of additional IP addresses to which a host can access.
unp redirect-server Configures an IP network address to allow HTTP traffic redirection.
show unp global configuration Displays the global UNP parameter settings for the switch.

MIB Objects
alaDaUNPGlobalConfiguration
alaDaUNPRedirectServerIP

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-183
unp redirect-server UNP Commands

unp redirect-server
Configures an IP network address to allow redirection of HTTP traffic to a ClearPass Policy Manager
(CPPM) server. Specify the address that is associated with the dynamic URL returned from the CPPM
server.
unp redirect-server ip-address ip_address
no unp redirect-server ip-address

Syntax Definitions

ip_address IPv4 network address (e.g., 171.15.0.0).

Defaults
By default, no redirect server IP address is specified.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the redirect server IP from the switch configuration.

• If the redirect server IP address does not match the CPPM server configuration, then redirection to the
URL will not work. This provides additional security.
• Configuring the switch to interact with the CPPM is done as part of the OmniSwitch implementation of
the Bring Your Own Devices (BYOD) solution.

Examples
-> unp redirect-server ip-address 10.0.0.20
-> no unp redirect-server ip-address

Release History
Release 8.1.1; command was introduced.

page 36-184 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp redirect-server

Related Commands

unp redirect port-bounce Configures the port bounce action for a port or globally for the switch.
unp redirect pause-timer Configures the global pause timer value for the switch
unp redirect proxy-server-port Configures the HTTP proxy port number to use for redirection.
unp redirect allowed-name Configures a list of additional IP addresses to which a host can access.
show unp global configuration Displays the global UNP configuration for the switch.

MIB Objects
alaDaUNPGlobalConfiguration
alaDaUNPRedirectServerIP

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-185
unp redirect allowed-name UNP Commands

unp redirect allowed-name

Configures a list of additional IP addresses to which a host can access. This allows traffic to reach
additional subnets other than that of the ClearPass Policy Manager (CPPM) server.
unp redirect allowed-name name ip-address ip_address ip-mask ip_mask
no unp redirect allowed-name name

Syntax Definitions

name Specify a name to assign to the allowed IP network address.

ip_address An IPv4 network address (e.g., 10.0.0.0, 171.15.0.0, 196.190.254.0).
ip_mask The IP subnet mask for the allowed IP network address.

Defaults
By default, no allowed IP addresses are configured.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an IP address from the allowed list.

• Explicitly configure and append the allowed IP list to the built-in "restrictedPolicylist" policy list.

Examples
-> unp redirect allowed-name server2 ip-address 10.0.0.20 ip-mask 255.0.0.0
-> no unp redirect allowed-name server2

Release History
Release 8.1.1; command was introduced.

page 36-186 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp redirect allowed-name

Related Commands

unp redirect port-bounce Configures the port bounce action for a port or globally for the switch.
unp redirect pause-timer Configures the global pause timer value for the switch
unp redirect proxy-server-port Configures the HTTP proxy port number to use for redirection.
unp redirect-server Configures an IP network address to allow HTTP traffic redirection.
show unp global configuration Displays the global UNP configuration for the switch.

MIB Objects
alaDaUNPRedirectAllowedServerTable
alaDaUNPRedirectAllowedServerName
alaDaUNPRedirectAllowedServerIP
alaDaUNPRedirectAllowedMaskIP

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-187
unp edge-user flush UNP Commands

unp edge-user flush

Performs a MAC address flush of Access Guardian users (devices learned on UNP ports) based on the
specified port, link aggregate, authentication type or MAC address.
unp edge-user flush [port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]] [type {mac | 802.1x |
none} [edge-profile profile_name] [mac-address mac_address]

Syntax Definitions

chassis The chassis identifier.

slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-8).
agg_id[-agg_id2] Link aggregate ID number. Use a hyphen to specify a range of link
aggregate IDs (10-15).
mac Flush only MAC authenticated users.
802.1x Flush only 802.1X authenticated users.
none Flush only users that have not been authenticated.
mac_address MAC address (e.g., 00:00:39:59:f1:0c).
profile_name The name of an existing UNP Edge profile.

Defaults
By default, all MAC addresses learned on all UNP edge ports are flushed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the port or linkagg parameter to flush users on a specific port or link aggregate.

• Use the type parameter with the mac, 802.1x, or none options to flush users that were authenticated
(mac or 802.1x) or users that were not authenticated.
• Use the mac-address parameter to flush a specific device.

• Use the edge-profile parameter to flush all users associated with the specified Edge profile name.
Combine this parameter with the mac-address parameter to flush a specific user associated with the
specified Edge profile name.

Examples
-> unp edge-user flush
-> unp edge-user flush port 1/1/6
-> unp edge-user flush linkagg 10
-> unp edge-user flush type mac
-> unp edge-user flush mac-address 00:11:22:33:44:55
-> unp edge-user flush edge-profile EP-1
-> unp edge-user flush edge-profile EP-1 mac-address 00:da:95:11:22:01

page 36-188 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp edge-user flush

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; edge-profile parameter added.

Related Commands

show unp edge-user Displays information about the devices learned on a UNP port.

MIB Objects
alaDaUNPEdgeFlushTable
alaDaUNPEdgeFlushIndex
alaDaUNPEdgeFlushPortLow
alaDaUNPEdgeFlushPortHigh
alaDaUNPEdgeFlushType
alaDaUNPEdgrFlushMac
alaDaUNPEdgeFlushComplete
alaDaUNPEdgeFlushProfile

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-189
unp spb-access-user flush UNP Commands

unp spb-access-user flush

Performs a MAC address flush of Access Guardian users (devices learned on UNP SPB access ports)
based on the specified port, link aggregate, authentication type or MAC address.
unp spb-access-user flush [sap-id [linkagg] sap_id] [service-id service_id] [type {mac | 802.1x | none}
[spb-profile profile_name] [mac-address mac_address]

Syntax Definitions

[linkagg] sap_id Clears users associated with the specified SPB Service Access Point
(SAP) ID. Use the optional linkagg parameter if the SAP ID is for a link
aggregate.
service_id Clears users associated with the specified SPB service ID.
mac Clears MAC authenticated users.
802.1x Clears 802.1X authenticated users.
none Clears users that have not been authenticated.
mac_address MAC address (e.g., 00:00:39:59:f1:0c).
profile_name The name of an existing UNP SPB profile.

Defaults
By default, all MAC addresses learned on all UNP SPB access ports are flushed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• A SAP ID is comprised of a device-facing port or link aggregate (referred to as a service access port)
and an encapsulation value that is used to identify the type of device traffic to map to the associated
service.
• Use the sap-id or service-id parameter to flush users learned on a specific SPB SAP or service.

• Use the type parameter with the mac, 802.1x, or none options to flush users that were authenticated
(mac or 802.1x) or users that were not authenticated.
• Use the mac-address parameter to flush a specific device.

• Use the spb-profile parameter to flush all users associated with the specified SPB profile name.
Combine this parameter with the mac-address parameter to flush a specific user associated with the
specified Edge profile name.
• Combine the sap-id or service-id parameter with the spb-profile parameter option to flush only users
on the SPB SAP or service that are classified into the specified profile.
• Combine the sap-id or service-id parameter with the type parameter option to flush only users on the
SPB SAP or service that were authenticated with the specified authentication type.

page 36-190 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands unp spb-access-user flush

Examples
-> unp spb-user flush
-> unp spb-user flush sap-id 1/1/2:50
-> unp spb-user flush service-id 10
-> unp spb-user flush type mac
-> unp spb-user flush mac-address 00:11:22:33:44:55
-> unp spb-user flush spb-profile SP-1
-> unp spb-user flush spb-profile SP-1 mac-address 00:da:95:11:22:01

Release History
Release 8.2.1; command was introduced.

Related Commands

service spb sap Configures an SPB SAP by associating a SAP ID with an SPB service.
show unp spb-access-user Displays information about the devices learned on UNP SPB access
details ports.

MIB Objects
alaDaUNPSpbFlushTable
alaDaUNPSpbFlushIndex
alaDaUNPSpbFlushComplete
alaDaUNPSpbFlushAuthType
alaDaUNPSpbFlushMacAddress
alaDaUNPSpbFlushSapIDIfIndex
alaDaUNPSpbFlushSapIDEncapVal
alaDaUNPSpbFlushServiceID
alaDaUNPSpbFlushSpbProfile

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-191
show unp global configuration UNP Commands

show unp global configuration

Displays the global Universal Network Profile (UNP) parameter settings for the switch.
show unp global configuration

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
A hyphen, “-”, indicates that a value has not been configured for the global UNP parameter.

Examples
-> show unp global configuration
Mode : Bridge
Dynamic Vlan Configuration = Disabled,
Dynamic Profile Configuration = Disabled,
Auth Server Down UNP = -,
Auth Server Down Timeout = 60,
Auth Server Down VXLAN UNP = -,
Auth Server Down VXLAN Timeout = 60,

Mode : Edge
Auth Server Down UNP = ag_SrvDownPrf,
Auth Server Down Timeout = 60,
Redirect Port Bounce = Enabled,
Redirect Pause Timer = -,
Redirect http proxy-port = 8090,
Redirect Server IP = 10.255.1.1,
Allowed IP = Server2,
10.255.1.2/255.255.0.0,

output definitions
Mode The mode (Bridge and Edge) to which the global parameter values
apply. Bridge mode applies to VLAN profile classification; Edge mode
applies to Edge profile classification.
Dynamic Vlan Configuration The status (Enabled or Disabled) of dynamic VLAN configuration.
Configured through the unp dynamic-vlan-configuration command.
Applies only to VLAN profile classification.

page 36-192 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp global configuration

output definitions
Dynamic Profile The status (Enabled or Disabled) of dynamic VLAN profile
Configuration configuration. Configured through the unp dynamic-profile-
configuration command. Applies only to VLAN profile classification.
Auth Server Down UNP The name of a UNP that a device is assigned to in the event the
RADIUS server is unreachable. Configured through the unp auth-
server-down command.
Auth Server Down Timeout The amount of time, in seconds, that devices remain in the VLAN
associated with the authentication server down UNP. Configured
through the unp auth-server-down timeout command.
Auth Server Down VXLAN Note. This field is not supported in this release.
UNP
Auth Server Down VXLAN Note. This field is not supported in this release.
Timeout
Redirect Port Bounce The status (Enabled or Disabled) of the port bounce operation for non-
supplicant devices. Configured through the unp redirect port-bounce
command. Applies only to Edge profile classification.
Redirect Pause Timer The amount of time, in seconds, the switch pauses to clear all device
authentication states and trigger re-authentication. Configured through
the unp redirect pause-timer command. Applies only to Edge profile
classification.
Redirect http proxy-port The HTTP proxy port number to use for redirection to a server.
Configured through the unp redirect proxy-server-port command.
Applies only to Edge profile classification.
Redirect Server IP The IP network address of a redirection server. Configured through the
unp redirect-server command. Applies only to Edge profile
classification.
Allowed IP A list of IP addresses to which a host can access additional servers.
Configured through the unp redirect allowed-name command.
Applies only to Edge profile classification.

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; Bridge mode output display added.

Related Commands

show unp vlan-profile Displays the VLAN profile configuration for the switch.
show unp edge-profile Displays the Edge profile configuration for the switch.
show unp port Displays the UNP configuration for a port.
show unp edge-user Displays information about the devices learned on a UNP port.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-193
show unp global configuration UNP Commands

MIB Objects
alaDaUNPGlobalConfiguration
alaDaUNPDynamicVlanConfigFlag
alaDaUNPDynamicProfileConfigFlag
alaDaUNPAuthServerDownUnp
alaDaUNPAuthServerDownTimeout
alaDaUNPAuthSrvDownEdgeProfName
alaDaUNPAuthServerDowneEdgeProfTimeout
alaDaUNPRedirectPortBounce
alaDaUNPRedirectPauseTimer
alaDaUNPRedirectProxyServerPort
alaDaUNPRedirectServerIP
alaDaUNPRedirectAllowedServerTable
alaDaUNPRedirectAllowedServerName
alaDaUNPRedirectAllowedServerIP
alaDaUNPRedirectAllowedMaskIP

page 36-194 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp edge-profile

show unp edge-profile

Displays the UNP Edge profile configuration for the switch.
show unp edge-profile [profile_name]

Syntax Definitions

profile_name The name of the UNP to display.

Defaults
By default, the configuration for all Edge profiles is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enter an Edge profile name with this command to display information for a specific profile.

• Use the show unp vlan-mapping command to display the VLAN-to-Edge profile association.

Examples
-> show unp edge-profile
Profile QoS Location Period CP Redirect CP Authen Mobile Ingrs Egrs Ingrs Egrs
Name Policy Policy Policy Profile State State Tag BW BW Depth Depth
-------+------+--------+------+-------+--------+-----+------+------+-----+----+------+------
EP-1 qlist1 llist1 plist1 CP1 Dis Ena Dis Dis
EP-2 qlist2 llist2 plist2 CP2 Ena Dis Dis Dis 10M 10M 10000 10000

Total Edge-Profile Count: 2

-> show unp edge-profile EP-2

Profile QoS Location Period CP Redirect CP Authen Mobile Ingrs Egrs Ingrs Egrs
Name Policy Policy Policy Profile State State Tag BW BW Depth Depth
-------+------+--------+------+-------+--------+-----+------+------+-----+----+------+------
EP-2 qlist2 llist2 plist2 CP2 Ena Dis Dis Dis 10M 10M 10000 10000

output definitions
Profile Name The Edge profile name. Configured through the unp edge-profile
command.
QoS Policy The name of the QoS policy list associated with the Edge profile.
Configured through the unp edge-profile qos-policy-list command.
Location Policy The name of the location policy assigned to the Edge profile.
Configured through the unp edge-profile location-policy command.
Period Policy The name of the period policy assigned to the Edge profile. Configured
through the unp edge-profile period-policy command.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-195
show unp edge-profile UNP Commands

output definitions
Captive-Portal Profile The name of the Captive Portal (CP) profile assigned to the Edge
profile A CP profile defines a CP configuration that is applied to
devices when CP authentication is enabled for the Edge profile.
Configured through the unp edge-profile captive-portal-profile
command.
Redirect State The redirection status (Ena or Dis) for the Edge profile. Indicates
whether the Edge profile is one that is returned through interaction with
the ClearPass Policy Manager (CPPM). Configured through the unp
edge-profile redirect command.
CP State The CP authentication status (Ena or Dis) for the Edge profile.
Indicates whether CP authentication is triggered for devices classified
into the profile. Configured through the unp edge-profile captive-
portal-authentication command.
Authen The authentication flag status (Ena or Dis) for the Edge profile.
Indicates whether only authenticated devices are allowed into the Edge
profile. Configured through the unp edge-profile authentication-flag
command.
Mobile Tag The mobile tag status (Ena or Dis) for the Edge profile. Indicates
whether the UNP port is tagged with the Edge profile VLAN when the
device on that port is classified into the Edge profile. Configured
through the unp edge-profile mobile-tag command.
Ingress-BW The maximum ingress bandwidth setting applied to ports associated
with the profile. Configured through the unp edge-profile maximum-
ingress-bandwidth command.
Egress-BW The maximum egress bandwidth setting applied to ports associated
with the profile. Configured through the unp edge-profile maximum-
egress-bandwidth command.
Ingress-Depth The maximum ingress depth setting applied to ports associated with the
profile. Configured through the unp edge-profile maximum-ingress-
depth command.
Egress-Depth The maximum egress depth setting applied to ports associated with the
profile. Configured through the unp edge-profile maximum-egress-
depth command.

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; ingress-BW, egress-BW, ingress-depth, egress-depth fields added.

Related Commands

show unp classification Displays the UNP classification rule configuration for the switch.
show unp global configuration Displays the UNP global parameter values configured for the switch.
show unp port Displays the UNP configuration for the port.
show unp edge-user Displays information about the devices learned on a UNP port.

page 36-196 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp edge-profile

MIB Objects
alaDaUNPEdgeProfTable
alaDaUNPEdgeProfName
alaDaUNPEdgeProfQosPolicyList
alaDaUNPEdgeProfLocationPolicy
alaDaUNPEdgeProfPeriodPolicy
alaDaUNPEdgeProfCPortalAuth
alaDaUNPEdgeProfAuthStatus
alaDaUNPEdgeProfMobileTag
alaDaUNPEdgeProfCPortalProf
alaDaUNPEdgeProfRedirectStatus
alaDaUNPEdgeProfMaxIngressBw
alaDaUNPEdgeProfMaxEgressBw
alaDaUNPEdgeProfMaxIngressDepth
alaDaUNPEdgeProfMaxEgressDepth

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-197
show unp edge-profile vlan-mapping UNP Commands

show unp edge-profile vlan-mapping

Displays the VLAN ID that is associated with an Edge profile.
show unp edge-profile [profile_name] vlan-mapping

Syntax Definitions

profile_name The name of the UNP to display.

vlan-mapping Displays the VLAN mapping configuration for each Edge profile.

Defaults
By default, the VLAN mapping for all Edge profiles is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enter an Edge profile name with this command to display information for a specific profile.

• Only one VLAN is associated with an Edge profile at any given time.

Examples
-> show unp edge-profile vlan-mapping
Edge Profile Name Vlan
--------------------------------+----
edge1 500
edge2 501
edge3 502

Total Edge-Profile Vlan-Map Count: 3

-> show unp edge-profile edge2 vlan-mapping

Edge Profile Name Vlan
--------------------------------+----
edge2 501

output definitions
Edge Profile Name The name of the Edge profile that is mapped to the VLAN ID.
Configured through the unp edge-profile command.
Vlan The VLAN ID associated with the profile. Configured through the unp
vlan-mapping edge-profile command.

Release History
Release 8.1.1; command was introduced.

page 36-198 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp edge-profile vlan-mapping

Related Commands

unp vlan-mapping edge-profile .Configures the mapping of a standard VLAN to a UNP Edge profile.

MIB Objects
alaDaUNPVlanMapTable
alaDaUNPVlanMapEdgeProf
alaDaUNPVlanMapIdent

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-199
show unp edge-template UNP Commands

show unp edge-template

Displays the Edge port template configuration for the switch.
show unp edge-template [template_name [configured-vlans] | config [template_name]]

Syntax Definitions

template_name The name of the UNP Edge port template to display.

configured-vlans Displays the VLAN IDs that the specified template assigns to a UNP
edge port.
config Displays additional details about the parameter configuration for the
template.

Defaults
By default, displays the configuration information for all Edge templates.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enter a template name with this command to display information for a specific Edge template.

• Use the config option with this command to display the full configuration for each template.

Examples
-> show unp edge-template
Template 802.1x Mac-Auth Redirect
Name 802.1x Pass-Alt Prof Mac-Auth Pass-Alt Prof Port-Bounce Class. Trust-Tag
--------+--------+-------------+--------+-------------+----------+--------+--------
et-1 Enabled 1xPass Disabled - Disabled Disabled Disabled
et-2 Disabled - Disabled - Disabled Enabled Enabled
et-3 Disabled - Enabled MacPass Disabled Enabled Disabled

Total Edge-Template Count: 3

-> show unp edge-template et-2

Template 802.1x Mac-Auth Redirect
Name 802.1x Pass-Alt Prof Mac-Auth Pass-Alt Prof Port-Bounce Class. Trust-Tag
--------+--------+-------------+--------+-------------+----------+--------+--------
et-2 Disabled - Disabled - Disabled Enabled Enabled

page 36-200 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp edge-template

-> show unp edge-template config et-2

Edge Template: et-2
802.1x Authentication = Disabled,
802.1x Pass Alternate Profile = -,
Mac Authentication = Disabled,
Mac-Auth Pass Alternate Profile = -,
Classification = Enabled,
Default Edge Profile = -,
Group-ID = 0,
AAA Profile = -,
Redirect Port Bounce = Enabled,
Port Control Direction = Both,
802.1x Tx-Period = 30,
802.1x Supp-Timeout = 30,
802.1x Max-Req = 2
802.1x Bypass = Disabled
802.1x failure-policy = default
Mac-auth allow-eap = none
Trust-Tag = Enabled

output definitions
Edge Template The name of an Edge port template.
802.1x Authentication The 802.1x authentication status (Enabled or Disabled).
802.1x Pass Alternate Profile The name of an alternate Edge profile for devices that pass 802.1x
authentication.
Mac Authentication The MAC authentication status (Enabled or Disabled).
Mac-Auth Pass Alternate The name of an alternate Edge profile for devices that pass MAC
Profile authentication.
Classification The classification status (Enabled or Disabled).
Default Edge Profile The name of a default Edge profile for devices not classified by any
other classification methods.
Group-ID The Group ID number assignment for the UNP port.
AAA Profile The name of an AAA profile to apply to the port.
Redirect Port Bounce The status of port bounce (Enabled or Disabled) for BYOD
registration and authorization.
Port Control Direction Whether 802.1x access control is applied to ingress and egress traffic
(both) or just ingress traffic (in).
802.1x Tx-Period The amount of time, in seconds, before an EAP Request Identity is
retransmitted.
802.1x Supp-Timeout The amount of time, in seconds, the switch will wait before timing out
an 802.1X user that is attempting to authenticate.
802.1x Max-Req The maximum number of times the switch will retransmit a request for
authentication information.
802.1x Bypass The status of 802.1x bypass (Enabled or Disabled).
802.1x failure-policy Whether the switch attempts subsequent MAC authentication for a
device after the initial 802.1X authentication process fails (default = no
MAC authentication or mac-authentication).

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-201
show unp edge-template UNP Commands

output definitions
Mac-auth allow-eap The conditions under which 802.1x authentication is performed or
bypassed based on the initial MAC authentication process (pass = if
MAC authentication passes, fail = if MAC authentication fails, noauth
= if MAC authentication is not configured, or none = do not attempt
802.1X authentication). This parameter option only applies to UNP
ports on which 802.1X authentication bypass is enabled.
Trust-Tag The trust VLAN ID tag status (Enabled or Disabled).

-> show unp edge-template etemp1 configured-vlans

Template Name Configured Vlans
-------------------------------+----------------
etemp1 503

output definitions
Template Name The name of an Edge port template.
Configured VLANs The VLAN IDs that are assigned to the UNP edge port when the
template is applied to the port.

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; configured-vlans parameter added; Trust-Tag field added.

Related Commands

unp edge-template Configures UNP port parameter values for an Edge port template.
unp port edge-template Assigns an Edge port configuration template to a UNP port.
show unp port Displays the UNP configuration for the port, including the name of an
Edge template associated with the port, if any.

page 36-202 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp edge-template

MIB Objects
alaDaUNPETmplTable
alaDaUNPETmplName
alaDaUNPETmpl8021XAuthStatus
alaDaUNPETmpl8021XTxPeriodStatus
alaDaUNPETmpl8021XTxPeriod
alaDaUNPETmpl8021XSuppTimeoutStatus
alaDaUNPETmpl8021XSuppTimeOut
alaDaUNPETmpl8021XMaxReqStatus
alaDaUNPETmpl8021XMaxReq
alaDaUNPETmpl8021XPassAltEProf
alaDaUNPETmplMacAuthStatus
alaDaUNPETmplMacPassAltEProf
alaDaUNPETmplClassifStatus
alaDaUNPETmplDefEProf
alaDaUNPETmplGroupId
alaDaUNPETmplAaaProf
alaDaUNPETmplRowStatus
alaDaUNPETmplRedirectPortBounce
alaDaUNPETmplFailurePolicy
alaDaUNPETmplBypassStatus
alaDaUNPETmplMacAllowEap
alaDaUNPETmpl8021XAdminControlledDirections
alaDaUNPETmplTrustTagStatus
alaDaUNPETmplVlanTable
alaDaUNPETmplVlanVID
alaDaUNPETmplVlanRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-203
show unp vlan-profile UNP Commands

show unp vlan-profile

Displays the VLAN-based Universal Network Profile (UNP) configuration for the switch.
show unp vlan-profile [profile_name]

Syntax Definitions

profile_name The name of the UNP VLAN profile to display.

Defaults
By default, all VLAN-based profiles are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Enter the name of a UNP VLAN profile with this command to display information for a specific profile.

Examples
-> show unp vlan-profile
Name Vlan Policy Saa Status Mobile MC Conf Ingrs Egrs Ingrs Egrs
List Name Profile Name Tag Status BW BW Depth Depth
----+----+--------+----------+------+------+------+-----+-----+------+------
unp1 500 Active Dis Local 10M 10M 10000 10000
unp2 501 unp2_list Active Dis Local
unp3 100 unp3_list Active Dis Sync 10M 10M 10000 10000
unp4 200 unp4_list Active Dis Sync

-> show unp vlan-profile unp3

Name Vlan Policy Saa Status Mobile MC Conf Ingrs Egrs Ingrs Egrs
List Name Profile Name Tag Status BW BW Depth Depth
----+----+--------+----------+------+------+------+-----+-----+------+------
unp3 100 unp3_list Active Dis Sync 10M 10M 10000 10000

output definitions
Name The name of the UNP VLAN profile. Configured through the unp
vlan-profile command.
Vlan The VLAN ID associated with the profile. Configured through the unp
vlan-profile command.
Policy List Name The name of the QoS policy list associated with the profile. Configured
through the unp vlan-profile qos-policy-list command.
Saa Profile Name Note. This field is not supported in this release.
Status The status of the profile (Active or Inactive). An active profile
indicates devices are assigned to the profile VLAN.

page 36-204 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp vlan-profile

output definitions
Mobile Tag The mobile tagging status (Ena or Dis) applied to egress packets for the
service associated with this UNP. Applies to 802.1X-enabled devices
connected to the UNP port. Configured through the unp vlan-profile
mobile-tag command.
MC Conf Status Note. This field is not supported in this release.
Ingress-BW The maximum ingress bandwidth setting applied to ports associated
with the profile. Configured through the unp vlan-profile maximum-
ingress-bandwidth command.
Egress-BW The maximum egress bandwidth setting applied to ports associated
with the profile. Configured through the unp vlan-profile maximum-
egress-bandwidth command.
Ingress-Depth The maximum ingress depth setting applied to ports associated with the
profile. Configured through the unp vlan-profile maximum-ingress-
depth command.
Egress-Depth The maximum egress depth setting applied to ports associated with the
profile. Configured through the unp vlan-profile maximum-egress-
depth command.

Release History
Release 8.2.1; command was introduced.

Related Commands

show unp classification Displays the UNP classification rule configuration for the switch.
show unp global configuration Displays the UNP global parameter values configured for the switch.
show unp port Displays the UNP configuration for the port.
show unp user Displays information about the devices learned on a UNP port.
show unp saa-profile Displays the SAA profile parameter configuration.

MIB Objects
alaDaUserNetProfileTable
alaDaUserNetProfileName
alaDaUserNetProfileVlanID
alaDaUserNetProfileQosPolicyListName
alaDaUserNetProfileSaaProfileName
alaDaUserNetProfileRowStatus
alaDaUserNetProfileMobileTag

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-205
show unp spb-profile UNP Commands

show unp spb-profile

Displays the Shortest Path Bridging (SPB) service-based UNP configuration for the switch.
show unp spb-profile [profile_name]

Syntax Definitions

profile_name The name of a service UNP to display.

Defaults
By default, all SPB service profiles are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Enter an SPB service profile name with this command to display information for a specific UNP.

Examples
-> show unp spb-profile
Profile Tag Mcast VLAN QOS Mobile
Name Value ISID/bVlan Mode Xlate Policy List Name Tag
------------------+--------+-----------+--------+------+-----------------+---------
spb1 0 2000/4001 Head-end Dis spb1_list Dis
spb2 10:500 1524/4001 Tandem Ena Dis

-> show unp spb-profile spb2

Profile Tag Mcast VLAN QOS Mobile
Name Value ISID/bVlan Mode Xlate Policy List Name Tag
------------------+--------+-----------+--------+------+-----------------+---------
spb2 10:500 1524/4001 Tandem Ena Dis

output definitions
Profile Name The name of the service profile.
Tag Value The VLAN tag values that are used to determine the service access
point (SAP) to which profile traffic is mapped.
ISID/bVlan The SPB service instance identifier (I-SID) and backbone VLAN
(BVLAN) that will be associated with the SAP to carry profile traffic.
Mcast Mode The SPB multicast mode (head-end or tandem) for the SPB service
associated with this profile.
VLAN Xlate The status (Ena or Dis) of egress VLAN translation for the SAP
associated with this profile.

page 36-206 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp spb-profile

output definitions
QoS Policy List Name The name of the QoS policy list associated with the profile.
Mobile Tag The mobile tagging status (Ena or Dis) applied to egress packets for the
service associated with this UNP. Applies to 802.1X-enabled devices
connected to the UNP port.

Release History
Release 8.2.1; command was introduced.

Related Commands

unp spb-profile Configures UNP SPB service-based profiles.

show unp classification Displays the UNP classification rule configuration for the switch.
show unp global configuration Displays the UNP global parameter values configured for the switch.
show unp port Displays the UNP configuration for the port.
show unp spb-access-user Displays information about the devices learned on a UNP SPB access
details port.

MIB Objects
alaDaSpbProfileTable
alaDaSpbProfileName
alaDaSpbProfileEncapVal
alaDaSpbProfileIsid
alaDaSpbProfileBVlan
alaDaSpbProfileMulticastMode
alaDaSpbProfileSapVlanXlation
alaDaSpbProfileQosPolicyListName
alaDaSpbProfileMobileTag
alaDaSpbProfileAFDConfig

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-207
show unp saa-profile UNP Commands

show unp saa-profile

Note: This command is not supported in this release.

Displays the Service Assurance Agent (SAA) performance monitoring profile configuration for the switch.
SAA profiles are assigned to UNP VLAN profiles to specify jitter and latency threshold values for SAA
sessions that apply to the assigned UNP VLAN profile.
show unp saa-profile [profile_name]

Syntax Definitions

profile_name The name of an existing SAA profile to display.

Defaults
By default, all SAA profiles are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enter an SAA profile name with this command to display information for a specific profile.

• This command does not provide the UNP assignment for each SAA profile. To display the assignment
information, use the show unp vlan-profile command.

Examples
-> show unp saa-profile
Profile Latency Jitter MC Conf
Name Threshold Threshold Status
--------------------------------+-----------+------------+----------
unp_saa1 500 100 Local
unp_saa2 0 150 Local
unp_saa3 250 0 Local

output definitions
Profile Name The name of the SAA profile.
Latency Threshold The latency threshold value applied with this profile. A value of “0”
indicates no threshold value is applied.
Jitter Threshold The jitter threshold value applied with this profile. A value of “0”
indicates no threshold value is applied.
MC Conf Status Note. This field is not supported in this release.

Release History
Release 8.2.1; command was introduced.

page 36-208 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp saa-profile

Related Commands

unp saa-profile Configures SAA performance monitoring profiles.

show unp vlan-profile Displays the UNP profile configuration for the switch.

MIB Objects
alaDaSaaProfileTable
alaDaSaaProfileName
alaDaSaaProfileLatencyThreshold
alaDaSaaProfileJitterThreshold
alaDaSaaProfileRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-209
show unp group-id UNP Commands

show unp group-id

Displays the UNP Group ID configuration for the switch. Group IDs are used to group physical UNP ports
or link aggregates into one logical domain.
show unp group-id

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• UNP edge ports are assigned to group IDs to form a logical domain. UNP bridge and service access
ports are assigned to customer domain IDs to form a logical domain.
• Once a port is assigned to a specific Group ID, classification rules associated with the same Group ID
are applied only to UNP ports associated with the same Group ID.

Examples
-> show unp group-id
Group-ID Description
--------+---------------------------
0 Default-Group-ID
1 UNP Group ID 1
2 UNP Group ID 2
10 UNP Group ID 10

Release History
Release 8.1.1; command was introduced.

page 36-210 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp group-id

Related Commands

unp group-id Configures a group ID to which UNP ports and classification rules are
assigned.
unp port group-id Assigns a UNP edge port to a group ID.
show unp port Displays the UNP configuration for the port.

MIB Objects
alaDaUnpGroupIdTable
alaDaUnpGroupId
alaDaUnpGroupDescription

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-211
show unp customer-domain UNP Commands

show unp customer-domain

Displays the UNP customer domain configuration for the switch. Customer domains are used to group
physical UNP ports or link aggregates into one logical domain.
show unp customer-domain

Syntax Definitions

N/A

Defaults
N/A.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• UNP bridge and service access ports are assigned to customer domain IDs to form a logical domain.
UNP edge ports are assigned to group IDs to form a logical domain.
• Once a port is assigned to a specific customer domain, classification rules associated with the same
customer domain ID are applied only to UNP ports associated with the same domain ID.

Examples
-> show unp customer-domain
Customer
Domain Description
--------+------------------------------------
0 Default-Customer-Domain
1 UNP Customer Domain 1

Release History
Release 8.2.1; command was introduced.

page 36-212 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp customer-domain

Related Commands

unp customer-domain Configures a customer domain ID to which UNP ports and classification
rules are assigned.
unp unp-customer-domain Assigns a UNP port to a customer domain ID.
show unp port Displays the UNP configuration for the port.

MIB Objects
alaDaUnpCustomerDomainTable
alaDaUnpCustomerDomainId
alaDaUnpCustomerDomainDesc

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-213
show unp classification UNP Commands

show unp classification

Displays the UNP classification rule configuration for the switch.
show unp classification [edge-profile | vlan-profile | spb-profile] rule_type

Syntax Definitions

rule_type The rule type to display (refer to the table in the “Usage Guidelines”
section of this command page for a list of rule type parameters).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If none of the profile parameters (edge-profile, vlan-profile, or spb-profile) are specified with this
command, then only rules associated with VLAN and SPB profiles are displayed; the edge-profile
parameter is required to display rules configured for Edge profiles.
• Specifying one of the classification rule type parameters is required with this command.The following
table provides a list of the rule type parameters and the UNP profile that supports the configuration of
that rule type:

Rule Type Parameter Edge Profile VLAN Profile SPB Profile

mac-rule Yes Yes Yes
mac-oui-rule Yes No No
mac-range-rule Yes Yes Yes
ip-rule Yes Yes Yes
vlan-tag-rule Yes Yes Yes
port-rule Yes No No
group-id-rule Yes No No
authentication-type-rule Yes No No
lldp-rule Yes No No
mac-port-rule Yes No No
mac-ip-port-rule Yes No No
mac-ip-group-rule Yes No No
mac-group-rule Yes No No
ip-port-rule Yes No No
ip-group-rule Yes No No

page 36-214 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp classification

• Standard classification rule parameters are combined at the time a rule is created to define a binding
classification rule. The parameter combinations provided with this command reflect the allowed
binding rule parameter combinations.
• An extended classification rule defines a list of rules and allows more combinations of standard rules
than the binding rule configuration (see the show unp classification-rule command).

Examples
-> show unp classification mac-rule
Customer Vlan Profile SPB Profile Vlan
Domain MAC Address Name Name Tag
--------+-----------------+------------------------+------------------------+------
0 00:00:5e:2a:95:11 VNP-10 - 0
1 00:0f:b5:46:d7:56 - SLA-20 20
2 00:2a:95:57:e1:67 ServerA-VMs - 0

-> show unp classification vlan-tag-rule

Customer VLAN Vlan Profile SPB Profile Tag
Domain Tag Name Name Position
--------+----+--------------------------------+---------------------------+--------
0 1 CustB - ServerB-VMs Inner
0 2 - SLA-2 Inner

-> show unp classification edge-profile mac-rule

MAC Address VLAN Tag Edge Profile Name
------------------+---------+--------------------------------
00:11:22:33:44:11 - Sales1
00:11:22:33:44:22 100 Sales2
00:11:22:33:44:55 - Sales3

Total Mac Rule Count: 3

-> show unp classification edge-profile ip-group-rule

Group-ID IP VLAN Tag Edge-Profile
---------+---------------+---------+--------------------------------
1 10.255.1.4 - CustA

Total IP-Group-ID Binding Rule Count: 1

-> show unp classification vlan-profile mac-rule

Customer
Domain Mac Address Vlan Profile VLAN Tag
--------+-----------------+--------------------------------+---------
0 00:00:5e:2a:95:11 VNP-10 0

-> show unp classification spb-profile vlan-tag-rule

Customer Domain VLAN Tag SPB-Profile Tag Position
---------------+--------+------------------------------+------------
0 2 SLA-2 Inner

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; vlan-profile and spb-profile parameters and fields added.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-215
show unp classification UNP Commands

Related Commands

show unp classification-rule Displays the extended classification rule configuration for the switch.
show unp edge-profile Displays the Edge profile configuration for the switch.
show unp vlan-profile Displays the VLAN profile configuration for the switch.
show unp spb-profile Displays the SPB profile configuration for the switch.

MIB Objects
N/A

page 36-216 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp classification-rule

show unp classification-rule

Displays the UNP extended classification rule configuration for the switch. An extended classification rule
defines a list of rule conditions, all of which a device must match to be classified into the Edge profile
associated with the extended rule name. A name and precedence value is also assigned to the list of rule
conditions.
show unp classification-rule [rule-name]

Syntax Definitions

rule_name The name of an existing extended classification rule.

Defaults
By default, the configuration for all extended rules is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enter the name of an extended classification rule to display information for a specific rule.

• An extended classification rule defines a list of rules and allows more combinations of standard rules
than the binding rule configuration.
• An extended classification rule is associated with an Edge profile and applied to traffic learned on UNP
edge ports. This type of rule is not configurable for VLAN and SPB service profiles.

Examples
-> show unp classification-rule
Rule Name: “ext_rule1”
Precedence = 10
Edge-Profile = usr_emp
Conditions:
Authenticaton-Type = 802.1x
Rule Name: "ext-rule2"
Precedence = 20,
Edge-Profile = usr_mgr,
Conditions:
IP-Address = 10.1.1.2,
IP-Address Mask = 255.255.255.0,
VLAN Tag = 20

-> show unp classification-rule ext_rule1

Rule Name: "ext-rule2"
Precedence = 20,
Edge-Profile = usr_mgr,
Conditions:
IP-Address = 10.1.1.2,
IP-Address Mask = 255.255.255.0,
VLAN Tag = 20

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-217
show unp classification-rule UNP Commands

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; VLAN Tag field added.

Related Commands

unp classification-rule Configures an extended classification rule.

show unp classification Displays the standard classification rule configuration for the switch.
show unp edge-profile Displays the Edge profile configuration for the switch.

MIB Objects
alaDaUNPClassifRuleTable
alaDaUNPClassifRuleName
alaDaUNPClassifRulePrecedenceNum
alaDaUNPClassifRuleEdgeProfile
alaDaUNPClassifRulePort
alaDaUNPClassifRulePortHigh
alaDaUNPClassifRuleGroupId
alaDaUNPClassifRuleMacAddr
alaDaUNPClassifRuleMacRngLoaddr
alaDaUNPClassifRuleMacRngHiaddr
alaDaUNPClassifRuleMacOuiAddr
alaDaUNPClassifRuleEndPoin
alaDaUNPClassifRuleAuthType
alaDaUNPClassifRuleIpAddressType
alaDaUNPClassifRuleIpAddress
alaDaUNPClassifRuleIpMaskType
alaDaUNPClassifRuleIpMask
alaDaUNPClassifRuleVlanTag

page 36-218 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp user-role

show unp user-role

Displays the user-defined role configuration for the switch.
show unp user-role [role_name]

Syntax Definitions

role_name The name of an existing user-defined role.

Defaults
By default, all user-defined role are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Enter a user-defined role name with this command to display information for a specific role.

Examples
-> show unp user-role
Role Name: ur1
Qos Policy List : qlist1
Priority : 1
Conditions:
Edge-Profile : edge1
Authentication-Type : Mac
CP Status : Enabled

Role Name: ur2

Qos Policy List : qlist-allow
Priority : 1
Conditions:
Edge-Profile : -
Authentication-Type : 802.1x Fail
CP Status : Disabled

Total User Role Derivation Rule Count: 2

output definitions
Role Name The name of the user-defined role. Configured through the unp user-
role command.
Qos Policy List The name of the QoS policy list associated with the role name. The
specified list defines the user role for the device. Configured through
the unp user-role policy-list command.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-219
show unp user-role UNP Commands

output definitions
Priority The role precedence, which assigns a priority value to the user-defined
role. This value determines which role to apply if a device matches the
conditions of more than one user-defined role. Configured through the
unp user-role command.
Edge-Profile The name of an Edge profile. The user-defined role is only applied to
devices classified into the specified profile name. Configured through
the unp user-role edge-profile command.
Authentication-Type The type of authentication applied to a device (none, mac, or 802.1x).
The user-defined role is only applied to devices authenticated with the
specified type. Configured through the unp user-role authentication-
type command.
CP Status The Captive Portal post login status. If enabled, the role is only applied
to devices in this state. Configured through the unp user-role cp-
status-post-login command.

Release History
Release 8.1.1; command was introduced.

Related Commands

unp user-role Configures a user-defined role.

show unp edge-user Displays information about devices learned on UNP ports.

MIB Objects
alaDaUNPUserRoleTable
alaDaUNPUserRoleName
alaDaUNPUserRolePrecedenceNum
alaDaUNPUserRolePolicyList
alaDaUNPUserRoleEdgeProfile
alaDaUNPUserRoleAuthType
alaDaUNPUserRolePostLoginStatus

page 36-220 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp restricted-role

show unp restricted-role

Displays the names of the explicit QoS policy lists assigned to the built-in restricted role states (Captive
Portal pre-login, Unauthorized, and QMR) used by the switch.
show unp restricted-role

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
An explicit QoS policy list overrides the built-in policy list associated with the restricted role state. When
the explicit policy list assignment is removed, the switch reverts back to using the built-in policy list
associated with the restricted role state.

Examples
-> show unp restricted-role
Role name Qos Policy List Name
------------+------------------------
UNAUTHORIZED qlist-bad
QMR qlist-qmr
CP PRE-LOGIN qlist-cp

Total Restricted Role Count: 3

output definitions
Role Name The restricted role name.
Qos Policy List The name of the QoS policy list associated with the restricted role
name.

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-221
show unp restricted-role UNP Commands

Related Commands

unp restricted-role policy-list Configures a user-defined role.

show unp edge-user Displays information about devices learned on UNP ports.

MIB Objects
alaDaUNPRstrctedRoleTable
alaDaUNPRstrctedRoleType
alaDaUNPRstrctedRolePolicyList

page 36-222 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp port

show unp port

Displays the UNP configuration for the port. Includes only UNP-enabled ports and link aggregates.
show unp {port [chassis/slot/port1[-port2]] | linkagg [agg_id[-agg_id2]} [config]

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] Link aggregate ID. Use a hyphen to specify a range of link aggregate
IDs (10-15).
config Displays additional configuration details the UNP port or link
aggregate.

Defaults
By default, information for all ports or link aggregates is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the port or linkagg parameter to display information for a specific port or link aggregate ID.

• Use the config parameter to display additional configuration information for the port or link aggregate.

Examples
-> show unp port
Port Grp-ID/ Type 802.1x Mac Class. Default 802.1X MAC
CDomain Auth Auth Pass-Alt Pass-Alt
------+-------+----------+--------+--------+--------+----------+--------+----------
1/1/6 0 Edge Disabled Disabled Enabled EdgeDef-1 - -
1/1/7 0 Edge Enabled Disabled Disabled EdgeDef-1 - -
1/1/8 0 Bridge Enabled Disabled Disabled - - -
1/1/9 0 SPB Access Enabled Enabled Disabled - 1xPass MacPass
1/1/15 0 Edge Disabled Disabled Disabled EdgeDef-1 - -

-> show unp port 1/1/9

Port Grp-ID/ Type 802.1x Mac Class. Default 802.1X MAC
CDomain Auth Auth Pass-Alt Pass-Alt
------+-------+----------+--------+--------+--------+----------+--------+----------
1/1/9 0 SPB Access Enabled Enabled Disabled - 1xPass MacPass

-> show unp linkagg

Port Grp-ID/ Type 802.1x Mac Class. Default 802.1X MAC
CDomain Auth Auth Pass-Alt Pass-Alt
------+-------+----------+--------+--------+--------+----------+--------+----------
0/10 0 Edge Disabled Disabled Disabled - - -
0/11 2 Bridge Disabled Disabled Disabled - - -
0/12 2 SPB Access Disabled Disabled Disabled - - -

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-223
show unp port UNP Commands

-> show unp linkagg 11

Port Grp-ID/ Type 802.1x Mac Class. Default 802.1X MAC
CDomain Auth Auth Pass-Alt Pass-Alt
------+-------+----------+--------+--------+--------+----------+--------+----------
0/11 2 Bridge Disabled Disabled Disabled - - -

output definitions
Port The port or link aggregate on which UNP is enabled. Configured
through the unp port command. A “0” indicates the port is a link
aggregate (for example, 0/11 is link aggregate ID 11).
Grp-ID/CDomain The group ID or customer domain ID assigned to the UNP port or link
aggregate. A group ID is assigned to UNP edge ports; a customer
domain ID is assigned to UNP bridge and access ports. Configured
through the unp port group-id command or the unp unp-customer-
domain command depending on the port type.
Type The type of UNP port (Edge, Bridge, or SPB Access). Configured
through the unp port command.
802.1x Auth The 802.1X authentication status (Enabled or Disabled) for the UNP
port or link aggregate. Configured through the unp 802.1x-
authentication command.
Mac-Auth The MAC authentication status (Enabled or Disabled) for the UNP
port or link aggregate. Configured through the unp mac-
authentication command.
Class. The classification status (Enabled or Disabled) for the UNP port or
link aggregate. Configured through the unp classification command.
Default The name of the default UNP Edge profile assigned to the port or link
aggregate. Configured through the unp default-edge-profile
command.
802.1x Pass-Alt The name of the 802.1x authentication pass alternate Edge profile
assigned to the port or link aggregate. Configured through the unp
802.1x-authentication pass-alternate command.
Mac Pass-Alt The name of the MAC authentication pass alternate Edge profile
assigned to the port or link aggregate. Configured through the unp
mac-authentication pass-alternate command.

-> show unp port 1/1/6 config

Port 1/1/6
Port-Type : Edge,
Redirect Port Bounce : Enabled,
802.1x authentication : Disabled,
802.1x Pass Alternate Profile : -,
802.1x Bypass : Disabled,
802.1x failure-policy : default,
Mac-auth allow-eap : none,
Mac authentication : Disabled,
Mac Pass Alternate Profile : -,
Classification : Disabled,
Default Profile : -,
Group-ID : 0,
AAA Profile : -,
Edge Template : et-1,
Port Control Direction : both,

page 36-224 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp port

Egress Flooding : Not Allowed,

Trust-tag Status = Disabled,
802.1x Parameters:
Tx-Period : 30,
Supp-Timeout : 30,
Max-req : 2

output definitions
Port The port or link aggregate on which UNP is enabled. Configured
through the unp port command. A “0” indicates the port is a link
aggregate (for example, 0/11 is link aggregate ID 11).
Port Type The type of UNP port (Edge, Bridge, or SPB Access). Configured
through the unp port command. The fields displayed with the show
unp port config command may vary based on port type.
Redirect Port Bounce The status of the port bounce operation (Enabled or Disabled) for the
UNP port or link aggregate. Configured through the unp redirect port-
bounce command.
802.1x Authentication The 802.1x authentication status (Enabled or Disabled) for the UNP
port or link aggregate. Configured through the unp 802.1x-
authentication command.
802.1x Pass Alternate Profile The name of the 802.1x authentication pass alternate Edge profile
assigned to the port or link aggregate. Configured through the unp
802.1x-authentication pass-alternate command
802.1x Bypass The status of 802.1x bypass (Enabled or Disabled).
802.1x failure-policy Whether the switch attempts subsequent MAC authentication for a
device after the initial 802.1X authentication process fails (default = no
MAC authentication or mac-authentication).
Mac-auth allow-eap Indicates the conditions under which 802.1x authentication is
performed or bypassed based on the initial MAC authentication process
(pass = MAC authentication passes, fail = if MAC authentication fails,
noauth = no MAC authentication, or none = do not attempt 802.1X
authentication). This parameter option only applies to a UNP port or
link aggregate on which 802.1X authentication bypass is enabled.
Configured through the unp mac-authentication allow-eap command.
Mac Authentication The MAC authentication status (Enabled or Disabled) for the UNP
port or link aggregate. Configured through the unp mac-
authentication command.
Mac Pass Alternate Profile The name of the MAC authentication pass alternate Edge profile
assigned to the port or link aggregate. Configured through the unp
mac-authentication pass-alternate command.
Classification The classification status (Enabled or Disabled) for the UNP port or
link aggregate. Configured through the unp classification command.
Default Profile The name of the default UNP Edge profile assigned to the UNP port or
link aggregate. Configured through the unp default-edge-profile
command.
Group-ID The Group ID number assigned to the UNP port or link aggregate.
Configured through the unp port group-id command.
AAA Profile The name of an AAA profile assigned to the UNP port or link
aggregate. Configured through the unp aaa-profile command.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-225
show unp port UNP Commands

output definitions
Edge Template The name of an Edge port template assigned to the UNP port or link
aggregate. Configured through the unp port edge-template command.
Port Control Direction Whether 802.1x access control is applied to ingress and egress traffic
(both) or just ingress traffic (in). Configured through the unp direction
command.
Egress Flooding Indicates whether egress broadcast, unknown unicast, and multicast
traffic is blocked (Not Allowed) or unblocked (Allowed) on the UNP
port. The value displayed in this field is based on the port control
direction setting for the port (both = Not Allowed; in = Allowed).
Trust-tag Status The trust the VLAN ID tag status (Enabled or Disabled) for the UNP
port or link aggregate. Configured through the unp trust-tag
command.
802.1x Tx-Period The amount of time, in seconds, before an EAP Request Identity is
retransmitted. Configured through the unp 802.1x-authentication tx-
period command.
802.1x Supp-Timeout The amount of time, in seconds, the switch waits before timing out an
802.1X user (supplicant) that is attempting to authenticate. Configured
through the unp 802.1x-authentication supp-timeout command.
802.1x Max-Req The maximum number of times the switch will retransmit a request for
authentication information. Configured through the unp 802.1x-
authentication max-req command.

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; Trust-tag Status field added.

Related Commands

show unp edge-template Displays the Edge port template configuration for the switch.
show unp edge-profile Displays the UNP configuration for the switch.
show unp edge-user Displays information about the devices learned on a UNP port.

MIB Objects
alaDaUNPPortTable
alaDaUNPPortIfIndex
alaDaUNPPortDefaultProfileName
alaDaUNPPortPassAltProfileName
alaDaUNPPortRowStatus
alaDaUNPPortMacAuthFlag
alaDaUNPPortClassificationFlag
alaDaUNPPortType
alaDaUNPPortDefaultEdgeProfName
alaDaUNPPortMacPassEdgeProfName
alaDaUNPPort8021XEdgeProfName
alaDaUNPPort8021XAuthStatus
alaDaUNPPort8021XTxPeriodStatus
alaDaUNPPort8021XTxPeriod
alaDaUNPPort8021XSuppTimeoutStatus

page 36-226 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp port

alaDaUNPPort8021XSuppTimeOut
alaDaUNPPort8021XMaxReqStatus
alaDaUNPPort8021XMaxReq
alaDaUNPPortGroupId
alaDaUNPPortAaaProfile
alaDaUNPPortEdgeTemplate
alaDaUNPPortRedirectPortBounce
alaDaUNPPort8021XFailurePolicy
alaDaUNPPort8021XBypassStatus
alaDaUNPPortMacAllowEap
alaDaUNPPort8021XAdminControlledDirections

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-227
show unp port bandwidth UNP Commands

show unp port bandwidth

Displays the maximum ingress bandwidth, maximum egress bandwidth, and maximum depth
configuration for the UNP port. These values are optionally assigned through the Edge and VLAN profiles
to which a UNP port is associated.
show unp {port chassis/slot/port1[-port2] | linkagg agg_id[-agg_id2]} bandwidth

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] Link aggregate ID. Use a hyphen to specify a range of link aggregate
IDs (10-15).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the port or linkagg parameter to display information for a specific port or link aggregate ID.

• The optional bandwidth parameter values are applied when a UNP port is classified into a UNP Edge
or VLAN profile. The Edge or VLAN profile is obtained through local classification or returned from
the RADIUS server.
• The source from which the bandwidth parameter values were last updated is also included in the
display information. The source updates are based on the following conditions:
– The UNP Edge or VLAN profile applies the bandwidth values at the time the UNP port is classified
into the profile. This overrides any existing QoS bandwidth policies configured on the physical port.
– QoS bandwidth policies defined in a QoS policy list associated with the Edge or VLAN profile are
applied after the port is classified into the profile. This overrides the profile bandwidth values
initially applied.
– User configured QoS bandwidth policies are applied after the port is classified into the profile.
• Configuring the bandwidth parameter values is an option provided only through UNP Edge and VLAN
profiles. UNP SPB service profiles do not provide this option.

Examples
-> show unp port 1/1/10 bandwidth
Port Grp-ID/ Type Max Ingr Ingr Max Egress Egress Max Max
CDomain Ingress BW BW Egress BW BW Def Depth
Bandwidth Source Profile Bandwidth Source Profile Depth Source
------+-------+----+---------+------+-------+---------+------+-------+------+------
1/1/10 0 Edge - -

page 36-228 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp port bandwidth

output definitions
Port The port or link aggregate on which UNP is enabled. A “0” indicates
the port is a link aggregate (for example, 0/11 is link aggregate ID 11).
Grp-ID/CDomain The group ID or customer domain ID assigned to the UNP port or link
aggregate. A group ID is assigned to UNP edge ports; a customer
domain ID is assigned to UNP bridge ports.
Type The type of UNP port (Edge or Bridge).
Max Ingress Bandwidth The maximum ingress bandwidth value applied to the UNP port.
Ingr BW Source The source from which the maximum ingress bandwidth value was
updated on the port (UNP or QoS).
Ingr BW Profile The name of the UNP profile responsible for setting the maximum
ingress bandwidth value on the UNP port. This field is only applicable
when UNP classification applies the bandwidth setting on the port.
Max Egress Bandwidth The maximum egress bandwidth value applied to the UNP port.
Egress BW Source The source from which the maximum egress bandwidth value was
updated on the port (UNP or QoS).
Egress BW Profile The name of the UNP profile responsible for setting the maximum
egress bandwidth value on the UNP port. This field is only applicable
when UNP classification applies the bandwidth setting on the port.
Max Default Depth The maximum default depth (bucket size) value applied to the UNP
port.
Max Depth Source The source from which the maximum depth value was updated on the
port (UNP or QoS).

Release History
Release 8.2.1; command was introduced.

Related Commands

unp port Configures UNP functionality on a port or link aggregate.

unp port group-id Assigns a UNP edge port or link aggregate to a group ID.
unp unp-customer-domain Assigns a UNP port or link aggregate to a customer domain (UNP
group). Applies only to UNP bridge and service access ports.
unp edge-profile Configures the optional bandwidth parameters for an Edge profile.
unp vlan-profile Configures the optional bandwidth parameters for a VLAN profile.
show unp edge-profile Displays the Edge profile configuration for the switch.
show unp vlan-profile Displays VLAN profile configuration for the switch.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-229
show unp port bandwidth UNP Commands

MIB Objects
alaDaUNPPortTable
alaDaUNPPortIfIndex
alaDaUNPPortGroupId
alaDaUNPPortCustomerDomainId
alaDaUNPPortType
alaDaUNPPortMaxIngressBw
alaDaUNPPortMaxIngressBwSource
alaDaUNPPortMaxEgressBw
alaDaUNPPortMaxEgressBwSource
alaDaUNPPortMaxDefaultDepth
alaDaUNPPortMaxDefaultDepthBwSource
alaDaUNPPortIngressSourceProfile
alaDaUNPPortEgressSourceProfile
alaDaUNPEdgeProfTable
alaDaUNPEdgeProfMaxIngressBw
alaDaUNPEdgeProfMaxEgressBw
alaDaUNPEdgeProfMaxDefaultDepth
alaDaUserNetProfileTable
alaDaUserNetProfileMaxIngressBw
alaDaUserNetProfileMaxEgressBw
alaDaUserNetProfileMaxDefaultDepth

page 36-230 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp port 802.1x statistics

show unp port 802.1x statistics

Displays 802.1X statistics for a UNP port or link aggregate on which 802.1X authentication is enabled.
show unp {port chassis/slot/port1[-port2] | linkagg agg_id} 802.1x statistics

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id Link aggregate ID.

Defaults
By default, this command displays statistics for all ports and link aggregates on which 802.1X
authentication is enabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the port or linkagg parameter to display information for a specific port or link aggregate ID.

Examples
-> show unp port 1/1/13 802.1x statistics
Port 1/1
Mac-address=00:00:00:00:00:01,
Vlan=0,
Rx EAP Frames=0,
Tx EAP Frames=0,
Rx EAP Logoff Frames=0,
Tx EAP Request Frames=0,
Tx EAP Request ID Frames=0,
Rx EAP Response Frames=0,
Rx EAP Response ID Frames=0,
Rx EAP Start Frames=0,
Rx Invalid EAP Frames=0,
Rx Length Error EAP Frames=0,
Last EAP Frame Version=0,
Last EAP Frame Version=0,
Last EAP Source=00:00:00:00:00:00

-> show unp linkagg 20 802.1x statistics

Linkagg ID 0/10
Mac-address=00:00:00:00:00:01,
Vlan=0,
Rx EAP Frames=0,
Tx EAP Frames=0,
Rx EAP Logoff Frames=0,
Tx EAP Request Frames=0,
Tx EAP Request ID Frames=0,

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-231
show unp port 802.1x statistics UNP Commands

Rx EAP Response Frames=0,

Rx EAP Response ID Frames=0,
Rx EAP Start Frames=0,
Rx Invalid EAP Frames=0,
Rx Length Error EAP Frames=0,
Last EAP Frame Version=0,
Last EAP Frame Version=0,
Last EAP Source=00:00:00:00:00:00

Release History
Release 8.1.1; command was introduced.

Related Commands

show unp port Displays the UNP port configuration for the switch.
show unp edge-user Displays information about the devices learned on a UNP port.

MIB Objects
N/A

page 36-232 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp port configured-vlans

show unp port configured-vlans

Displays the VLANs assigned to UNP edge and bridge ports or link aggregates.
show unp {port [chassis/slot/port1[-port2]] | linkagg agg_id[-agg_id2]} configured-vlans

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific UNP edge or
bridge port. Use a hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] Link aggregate ID for a specific UNP edge or bridge link aggregate. Use
a hyphen to specify a range of link aggregate IDs (10-15).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the port or linkagg parameter to display information for a specific UNP edge and bridge port or
link aggregate ID.
• If the port parameter is used without specifying an individual port or a range of ports, then the
configured VLAN information for all UNP ports and link aggregates is displayed.

Examples
-> show unp port configured-vlans
Port Configured Vlans
-------+----------------
0/10 500
0/10 501
1/1/10 500
1/1/11 501
1/1/11 502
1/1/11 503

-> show unp port 1/1/11 configured-vlans

Port Configured Vlans
-------+----------------
1/1/11 501
1/1/11 502
1/1/11 503

-> show unp linkagg 10 configured-vlans

LagID Configured Vlans
-------+----------------
0/10 500
0/10 501

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-233
show unp port configured-vlans UNP Commands

Release History
Release 8.2.1; command was introduced.

Related Commands

unp vlan Configures VLAN assignments for UNP edge and bridge ports.
show unp port Displays the UNP port and link aggregate configuration for the switch.

MIB Objects
alaDaUNPPortVlanTable
alaDaUNPPortVlanVID

page 36-234 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp user

show unp user

Displays information about the MAC addresses learned on a UNP port or link aggregate.
show unp user [mac_address] [chassis_id/slot/port[-port2] | linkagg agg_id[agg_id2]] [count]

Syntax Definitions

mac_address The device MAC address.

chassis_id The chassis identifier.
slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-8).
agg_id[-agg_id2] Link aggregate ID. Use a hyphen to specify a range of link aggregate
IDs (10-15).
count Displays the number of UNP users.

Defaults
By default, information is displayed for all learned devices on all UNP ports and link aggregates.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The count parameter is used on its own or in combination with a specified port or link aggregate ID
number.
• Enter a chassis, slot, and port number to display devices learned on a specific port.

• Use the linkagg parameter and an aggregate ID number to display devices learned on a specific link
aggregate.
• A zero is displayed instead of a slot number to designate a link aggregate. For example “0/10” specifies
the device was learned on aggregate ID number 10.

Examples
-> show unp user
User Learning
Port Username Mac address IP Vlan Profile Type Status Source
-----+-----------------+-----------------+-------+----+--------+------+------+-----
0/100 00:00:00:00:00:03 00:00:00:00:00:03 1.1.1.3 12 Profile3 Bridge Active Local
1/1/1 00:00:00:00:00:01 00:00:00:00:00:01 1.1.1.1 10 Profile1 Access Active Local
1/1/2 00:00:00:00:00:02 00:00:00:00:00:02 1.1.1.2 11 Profile2 Bridge Active Local

Total users : 3

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-235
show unp user UNP Commands

-> show unp user 1/1/2

User Learning
Port Username Mac address IP Vlan Profile Type Status Source
-----+-----------------+-----------------+-------+----+--------+------+------+-----
1/1/2 00:00:00:00:00:02 00:00:00:00:00:02 1.1.1.2 11 Profile2 Bridge Active Local

Total users : 1

-> show unp user linkagg 100

User Learning
Port Username Mac address IP Vlan Profile Type Status Source
-----+-----------------+-----------------+-------+----+--------+------+------+-----
0/100 00:00:00:00:00:03 00:00:00:00:00:03 1.1.1.3 12 Profile3 Bridge Active Local

Total users : 1

output definitions
Port The port or link aggregate on which the MAC address was learned.
Username The user name of the device (or the MAC address of the device).
Mac address The MAC address of the device. This field and the Username field
may contain the same MAC address.
User IP The IP network address of the device.
Vlan The UNP VLAN ID to which the device was classified.
Profile The name of the UNP to which the device was assigned.
Type The type of UNP port on which the device was learned (Bridge or
Access).
Status The status of the device (Active or Blocked)
Learning Source Note. This field is not supported in this release.

-> show unp user 00:00:00:00:00:01

Vlan 10:
Port : 1/1/1,
Mac-address : 00:00:00:00:00:01,
IP : 1.1.1.1,
UNP-Profile : Profile1,
Login Timestamp : 03/23/2015 18:45:26,
Authentication Type : Mac-Authentication,
Authentication Status : Authenticated,
Classification Source : RADIUS - Server UNP
Learning Source : Local

-> show unp user count

Total users: 3

-> show unp user 1/1-5 count

Total users: 3

-> show unp user linkagg 11 count

Total users: 2

page 36-236 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp user

output definitions
Port The port or link aggregate on which the MAC address was learned.
Mac-address The MAC address of the device.
IP The IP network address of the device.
UNP-Profile The name of the UNP to which the device was assigned.
Login Timestamp The date and time the device was learned.
Authentication Type The type of authentication used (Mac-Authentication or 802.1x-
Authentication).
Authentication Status The status of the authentication process (blank “–”, Authenticated,
Failed, or In Progress).
Classification Source Indicates how the device was classified (see list of possible
classification source values below).
Role Applied The name of the QoS policy list applied to this user for network access
control.
Learning Source Note. This field is not supported in this release.

The following is a list of possible values for the “Classification Source” field:
– Pass alternate UNP
– Pass alternate UNP - Blocked
– Default UNP
– Default UNP - Blocked
– Server UNP
– Server UNP - Blocked
– Auth Fail - Default UNP
– Auth Fail - Default UNP - Blocked
– Auth Fail - MAC Rule UNP
– Auth Fail - MAC Rule UNP - Blocked
– Auth Fail - MAC Range Rule UNP
– Auth Fail - MAC Range Rule UNP - Blocked
– Auth Fail - IP Rule UNP
– Auth Fail - IP Rule UNP - Blocked
– MAC Rule UNP
– MAC Rule UNP - Blocked
– MAC + Vlan Tag UNP
– MAC + Vlan Tag UNP - Blocked
– MAC Range rule UNP
– MAC Range rule UNP - Blocked
– MAC Range + Vlan Tag UNP
– MAC Range + Vlan Tag UNP - Blocked
– IP Rule UNP

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-237
show unp user UNP Commands

– IP Rule UNP - Blocked

– IP + Vlan Tag UNP
– IP + Vlan Tag UNP - Blocked
– Vlan Tag Rule UNP
– Vlan Tag Rule UNP - Blocked
– Trust Tag
– No UNP Match – Blocked
– Auth-Server Down UNP
– Auth-Server Down UNP – Blocked.
– LPS - Blocked.

Release History
Release 8.2.1; command was introduced.

Related Commands

show unp edge-user Displays additional details about MAC addresses learned on UNP edge
ports.
show unp vlan-user details Displays additional details about MAC addresses learned on UNP
bridge ports.
show unp spb-access-user Displays additional details about MAC addresses learned on UNP SPB
details access ports.
show unp edge-profile Displays the UNP Edge profile configuration for the switch.
show unp vlan-profile Displays the UNP VLAN profile configuration for the switch.
show unp spb-profile Displays the UNP SPB profile configuration for the switch.
show unp port Displays the UNP configuration for the port.

MIB Objects
N/A

page 36-238 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp edge-user

show unp edge-user

Displays information about the MAC addresses learned on a UNP Edge port or link aggregate.
show unp edge-user {port chassis/slot/port[-port2] | linkagg agg_id[-agg_id2] [edge-profile
profile_name] [authentication-type {none | mac | 802.1x}]}

Syntax Definitions

chassis The chassis identifier.

slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-8).
agg_id[-agg_id2] Link aggregate ID. Use a hyphen to specify a range of link aggregate
IDs (10-15).
profile_name The name of an existing Edge profile.
none Displays users that did not undergo the authentication process.
mac Displays users that were authenticated through MAC authentication.
802.1x Displays users that were authenticated through 802.1X authentication.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the port or linkagg parameter to display users learned on a specific port or link aggregate.

• Use the edge-profile parameter to display users classified into a specific Edge profile.

• Combine the port or linkagg parameter with the edge-profile parameter option to display only users on
the port or link aggregate that are classified into the specified profile.
• Combine the port or linkagg parameter with the authentication-type parameter option to display users
on the port or link aggregate that were authenticated with the specified authentication type.

Examples
-> show unp edge-user port 1/1/6
User
Port Username Mac address IP Vlan Profile Auth Role
------+------------------+-----------------+-------+-----+-----------+------+------
1/1/6 test_user 00:00:00:00:00:06 1.1.1.6 1 Block - -

Total users : 1

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-239
show unp edge-user UNP Commands

-> show unp edge-user linkagg 100

User
Port Username Mac address IP Vlan Profile Auth Role
------+-----------------+-----------------+-------+-----+-----------+-----+--------
0/100 Employee-001 00:00:00:00:00:04 1.1.1.4 10 Profile6 8021X Employee

Total users : 1

-> show unp edge-user edge-profile Profile6

User
Port Username Mac address IP Vlan Profile Auth Role
------+-----------------+-----------------+-------+-----+-----------+-----+--------
0/100 Employee-001 00:00:00:00:00:04 1.1.1.4 10 Profile6 8021X Employee

Total users : 1

-> show unp edge-user authentication-type MAC

User
Port Username Mac address IP Vlan Profile Auth Role
------+-----------------+-----------------+-------+-----+-----------+-----+--------
1/1/7 00:00:00:00:00:07 00:00:00:00:00:07 1.1.1.7 11 Profile4 MAC Limited
0/120 00:00:00:00:00:14 00:00:00:00:00:14 1.1.2.4 20 Profile7 MAC Employee

Total users : 2

output definitions
Port The port or link aggregate on which the MAC address was learned. A
“0” indicates the UNP port is a link aggregate (e.g., 0/10 refers to link
aggregate ID 10).
Username Displays the user name entered through 802.1x or captive-portal
authentication for an 802.1X user or a Captive-Portal-passed user. If
the user undergoes 802.1x authentication and later undergoes
successful Captive Portal authentication, then the user name entered
during the Captive Portal authentication is displayed.
MAC address The MAC address of the user device.
User IP The IP network address of the user device.
Vlan The UNP VLAN ID to which the user device was assigned.
Profile The name of the UNP to which the user device was assigned.
Auth The type of authentication applied to the user (none, mac, or 802.1X).
Role The user role (policy list) applied to the user device.

Release History
Release 8.1.1; command was introduced.

page 36-240 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp edge-user

Related Commands

show unp edge-user status Displays information about the authentication and validation status of
users learned on UNP ports.
show unp edge-user details Displays detailed information about users learned on UNP ports.
unp edge-user flush Performs a MAC address flush of Access Guardian users (devices
learned on UNP edge ports).
show unp edge-profile Displays the UNP configuration for the switch.
show unp port Displays the UNP configuration for the port.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-241
show unp edge-user status UNP Commands

show unp edge-user status

Displays the status of the authentication and validation process for MAC addresses learned on a UNP
Edge port or link aggregate.
show unp edge-user status [port chassis/slot/port[-port2] | linkagg agg_id[-agg_id2] [edge-profile
profile_name] [authentication-type {none | mac | 802.1x}] [mac-address mac_address]

Syntax Definitions

chassis The chassis identifier.

slot/port[-port2] The slot and port number (3/1). Use a hyphen to specify a range of ports
(3/1-8).
agg_id[-agg_id2] Link aggregate ID. Use a hyphen to specify a range of link aggregate
IDs (10-15).
profile_name The name of an existing Edge profile.
none Displays users that did not undergo the authentication process.
mac Displays users that were authenticated through MAC authentication.
802.1x Displays users that were authenticated through 802.1X authentication.
mac_address The user device MAC address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the port or linkagg parameter to display users learned on a specific port or link aggregate.

• Use the edge-profile parameter to display users classified into a specific Edge profile.

• Combine the port or linkagg parameter with the edge-profile parameter option to display only users on
the port or link aggregate that are classified into the specified profile.
• Combine the port or linkagg parameter with the authentication-type parameter option to display users
on the port or link aggregate that were authenticated with the specified authentication type.

Examples
-> show unp edge-user status port 1/1/1
Profile Profile Authentication Role Role Restricted
Port Mac address Name Source Type Status Name Source CP Redirect Access
-----+-----------------+--------+--------+------+-------+----+-------+--+--------+------
1/1/1 00:00:00:00:00:05 Prf1 Radius 8021x Passed emp1 Profile Y - -

Total users : 1

page 36-242 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp edge-user status

-> show unp edge-user status linkagg 100

Profile Profile Authentication Role Role Restricted
Port Mac address Name Source Type Status Name Source CP Redirect Access
-----+-----------------+--------+--------+------+-------+----+-------+--+--------+------
0/100 00:00:00:00:00:06 Prf3 Radius 8021x Passed emp1 Profile Y - -

Total users : 1

-> show unp edge-user status authentication type MAC

Profile Profile Authentication Role Role Restricted
Port Mac address Name Source Type Status Name Source CP Redirect Access
-----+-----------------+--------+--------+------+-------+----+-------+--+--------+------
1/1/2 00:00:00:00:00:15 Prf2 Alt MAC Passed emp2 Profile Y - -

Total users : 1

output definitions
Port The port or link aggregate on which the MAC address was learned. A
“0” indicates the UNP port is a link aggregate (e.g., 0/10 refers to link
aggregate ID 10).
MAC address The MAC address of the user device.
Profile Name The name of the UNP to which the user device was assigned.
Profile Source The source of the profile assignment (e.g., Radius, Alt).
Authentication Type The type of authentication applied to the user (none, mac, or 802.1X).
Authentication Status The authentication status for the device.
Role Name The name of the user role applied to the user device.
Role Source The source of the user role applied to the user device.
CP Indicates if the device was authenticated through Captive Portal.
Redirect The redirection status.
Restricted Access Whether or not access is restricted for the user.

Release History
Release 8.1.1; command was introduced.

Related Commands

show unp edge-user Displays information about users learned on a UNP Edge ports.
show unp edge-user details Displays detailed information about users learned on a UNP Edge ports.
show unp edge-profile Displays the UNP configuration for the switch.
show unp port Displays the UNP configuration for the port.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-243
show unp edge-user details UNP Commands

show unp edge-user details

Displays detailed information about MAC addresses learned on a UNP Edge port or link aggregate.
show unp edge-user details [port chassis/slot/port[-port2] | linkagg agg_id[-agg_id2] [edge-profile
profile_name] [authentication-type {none | mac | 802.1x}] [mac-address mac_address]

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] Link aggregate ID. Use a hyphen to specify a range of link aggregate
IDs (10-15).
profile_name The name of an existing Edge profile.
none Displays users that did not undergo the authentication process.
mac Displays users that were authenticated through MAC authentication.
802.1x Displays users that were authenticated through 802.1X authentication.
mac_address The user device MAC address.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the port or linkagg parameter to display users learned on a specific port or link aggregate.

• Use the edge-profile parameter to display users classified into a specific Edge profile.

• Combine the port or linkagg parameter with the edge-profile parameter option to display only users on
the port or link aggregate that are classified into the specified profile.
• Combine the port or linkagg parameter with the authentication-type parameter option to display users
on the port or link aggregate that were authenticated with the specified authentication type.
• The “User Name” field displays the user name entered through 802.1x or Captive Portal authentication
for an 802.1X user or a Captive Portal-passed user. If the user undergoes 802.1x authentication and
later undergoes successful Captive Portal authentication, then the user name entered during the Captive
Portal authentication process is displayed.

page 36-244 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp edge-user details

Examples
-> show unp edge-user details port 1/1/10
Port: 1/1/10
MAC-Address: 00:00:00:00:00:01
Access Timestamp : 04/01/1970 18:45:26,
User Name : guest1,
IP-address : 10.0.0.1,
Vlan : 10,
Authentication Type : 802.1X,
Authentication Status : Authenticated,
Authentication Failure Reason : -,
Authentication Retry Count : -,
Authentication Server IP Used = 10.135.62.129,
Authentication Server Used = rad1,
Server Reply-Message = -,
Profile : Employee,
Profile Source : RADIUS Server Profile,
Classification profile rule : -,
Role : Employee,
Role Source : Profile,
User role rule : -,
Restricted Access : No,
Location Policy Status : Passed,
Time Policy Status : Passed,
Captive-Portal Status : -,
QMR Status : Passed,
Redirect Url : -,
SIP Call Type = Not in a call,
SIP Media Type = None,
Applications = None

MAC-Address: 00:00:00:00:00:02
Access Timestamp : 06/01/1989 20:45:26,
User Name : guest2,
IP-address : 20.0.0.1,
Vlan : 20,
Authentication Type : MAC,
Authentication Status : Authenticated,
Authentication Failure Reason : -,
Authentication Retry Count : -,
Authentication Server IP Used = 10.135.62.129,
Authentication Server Used = rad1,
Server Reply-Message = -,
Profile : Contractor,
Profile Source : RADIUS Server Profile,
Classification profile rule : -,
Role : Contractor,
Role Source : Profile,
User role rule : -,
Restricted Access : No,
Location Policy Status : Passed,
Time Policy Status : Passed,
Captive-Portal Status : Passed,
QMR Status : -,
Redirect Url : -,
SIP Call Type = Normal Call,
SIP Media Type = Video,
Applications = None

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-245
show unp edge-user details UNP Commands

-> show unp edge-user details linkagg 100

Port: 0/100
MAC-Address: 00:00:00:00:00:03
Access Timestamp : 02/01/2013 20:45:26,
User Name : guest3,
IP-address : 30.0.0.1,
Vlan : 30,
Authentication Type : MAC,
Authentication Status : Authenticated,
Authentication Failure Reason : -,
Authentication Retry Count : -,
Authentication Server IP Used = 10.135.62.129,
Authentication Server Used = rad1,
Server Reply-Message = -,
Profile : Employee,
Profile Source : RADIUS Server Profile,
Classification profile rule : -,
Role : Contractor,
Role Source : Profile,
User role rule : -,
Restricted Access : No,
Location Policy Status : Passed,
Time Policy Status : Passed,
Captive-Portal Status : Passed,
QMR Status : -,
Redirect Url : -,
SIP Call Type = Not in a call,
SIP Media Type = None,
Applications = ;Facebook;rediff;

output definitions
Port The UNP bridge port or link aggregate on which the device was
learned.
Mac-address The MAC address of the device.
Access Timestamp The date and time the device was learned.
User Name The MAC address of the user.
IP-Address The IP network address of the device.
Vlan The VLAN ID number for the VLAN in which the device was learned.
Authentication Type The type of authentication used (Mac-Authentication or 802.1x-
Authentication).
Authentication Status The status of the authentication process (blank “–”, Authenticated,
Failed, or In Progress).
Authentication Failure Reason The reason authentication failed.
Authentication Retry Count The number of times authentication has been attempted.
Authentication Server IP Used The IP address of the authentication server.
Authentication Server Used The name of the authentication server used.
Server Reply-Message Reply message from the authentication server.
Profile The name of the VLAN profile to which the user was assigned.
Profile Source The source of the profile (returned from the server or assigned through
the UNP process on the switch).

page 36-246 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp edge-user details

output definitions
Profile From Auth Server The name of the VLAN profile returned from the authentication server.
Classification profile rule The rule that resulted in the device classification into the profile
VLAN.
QMR Status The Quarantine Manager Remediation status for the device.
Redirect Url The URL to which the device is redirected upon classification.
SIP Call Type The Session Initiation Protocol (SIP) call type status for a non-
supplicant (non-802.1x) device.
SIP Media Type The SIP media type status for a non-supplicant device.
Applications The applications a non-supplicant device is running.

Release History
Release 8.1.1; command was introduced.

Related Commands

unp edge-user flush Performs a MAC address flush of Access Guardian users (devices
learned on UNP edge ports).
show unp edge-user Displays information about users learned on a UNP Edge ports.
show unp edge-user status Displays information about the authentication and validation status of
users learned on UNP ports.
show unp edge-profile Displays the UNP configuration for the switch.
show unp port Displays the UNP configuration for the port.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-247
show unp vlan-user details UNP Commands

show unp vlan-user details

Displays information about the MAC addresses learned on UNP bridge ports or link aggregates.
show unp vlan-user details [port chassis/slot/port[-port2] | linkagg agg_id[-agg_id2] [vlan-profile
profile_name] [type {802.1x | mac | none}] [mac-address mac_address]

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] Link aggregate ID. Use a hyphen to specify a range of link aggregate
IDs (10-15).
profile_name Displays only users associated with the specified VLAN profile name.
802.1x Displays only 802.1X authenticated users.
mac Displays only MAC authenticated users.
none Displays only users that were not authenticated.
mac_address Displays only users with the specified source MAC address.

Defaults
By default, information is displayed for all learned VLAN users on all UNP bridge ports and link
aggregates.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the optional parameters provided with this command to filter the output display results.

Examples
-> show unp vlan-user details linkagg 100
Port: 0/100
MAC-Address: 00:00:00:00:00:03
Access Timestamp : 02/01/2013 20:45:26,
User Name : guest3,
IP-address : 30.0.0.1,
Vlan : 30,
Authentication Type : MAC,
Authentication Status : Authenticated,
Authentication Failure Reason : -,
Authentication Retry Count : -,
Authentication Server IP Used = 10.135.62.129,
Authentication Server Used = rad1,
Server Reply-Message = -,
Profile : Contractor,
Profile Source : Auth - Pass - Default UNP,
Profile From Auth Server : Employee [Not Configured],

page 36-248 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp vlan-user details

Classification profile rule : -,

QMR Status : -,
Redirect Url : -,
SIP Call Type = Not in a call,
SIP Media Type = None,
Applications = ;Facebook;rediff;

output definitions
Port The UNP bridge port or link aggregate on which the device was
learned.
Mac-address The MAC address of the device.
Access Timestamp The date and time the device was learned.
User Name The MAC address of the user.
IP-Address The IP network address of the device.
Vlan The VLAN ID number for the VLAN in which the device was learned.
Authentication Type The type of authentication used (Mac-Authentication or 802.1x-
Authentication).
Authentication Status The status of the authentication process (blank “–”, Authenticated,
Failed, or In Progress).
Authentication Failure Reason The reason authentication failed.
Authentication Retry Count The number of times authentication has been attempted.
Authentication Server IP Used The IP address of the authentication server.
Authentication Server Used The name of the authentication server used.
Server Reply-Message Reply message from the authentication server.
Profile The name of the VLAN profile to which the user was assigned.
Profile Source The source of the profile (returned from the server or assigned through
the UNP process on the switch).
Profile From Auth Server The name of the VLAN profile returned from the authentication server.
Classification profile rule The rule that resulted in the device classification into the profile
VLAN.
QMR Status The Quarantine Manager Remediation status for the device.
Redirect Url The URL to which the device is redirected upon classification.
SIP Call Type The Session Initiation Protocol (SIP) call type status for a non-
supplicant (non-802.1x) device.
SIP Media Type The SIP media type status for a non-supplicant device.
Applications The applications a non-supplicant device is running.

Release History
Release 8.2.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-249
show unp vlan-user details UNP Commands

Related Commands

show unp vlan-profile Displays the UNP SPB profile configuration for the switch.
show unp port Displays the UNP configuration for a port or link aggregate.

MIB Objects
N/A

page 36-250 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp spb-access-user details

show unp spb-access-user details

Displays information about the MAC addresses learned on UNP Shortest Path Bridging (SPB) access
ports or link aggregates.
show unp spb-access-user details [mac-address mac_address] [sap-id sap_id] [service-id service_id]
[spb-profile profile_name] [type {802.1x | mac | none}]

Syntax Definitions

mac_address Displays only users with the specified source MAC address.
sap_id Displays only users associated with the specified SPB Service Access
Point (SAP) ID.
service_id Displays only users associated with the specified SPB service ID.
profile_name Displays only users associated with the specified SPB profile name.
802.1x Displays only 802.1X authenticated users.
mac Displays only MAC authenticated users.
none Displays only users that were not authenticated.

Defaults
By default, information is displayed for all learned SPB users on all UNP SPB access ports and link
aggregates.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the sap-id or service-id parameter to display users learned on a specific SPB SAP or service.

• Use the spb-profile parameter to display users classified into a specific SPB profile.

• Combine the sap-id or service-id parameter with the spb-profile parameter option to display only
users on the SPB SAP or service that are classified into the specified profile.
• Combine the sap-id or service-id parameter with the type parameter option to display users on the
SPB SAP or service that were authenticated with the specified authentication type.

Examples
-> show unp spb-access-user details
SAP = 0/1:1000
MAC-Address: 00:00:00:00:00:01
Service ID = 32768,
ISID = 10000000,
CVlan = 1000,
Access Timestamp = 01/21/2014 16:02:55,
User Name = 00:00:00:00:00:01,
IP-Address = -,
Authentication Type = -,

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-251
show unp spb-access-user details UNP Commands

Authentication Status = -,
Authentication Failure Reason = -,
Authentication Retry Count = 0,
Authentication Server IP Used = -,
Authentication Server Used = -,
Server Reply-Message = -,
Profile = System Default,
Profile Source = System Default SPB,
Profile From Auth Server = -
SIP Call Type = Not in a call,
SIP Media Type = None,
Applications = ;Facebook;rediff;

Total users : 1

output definitions
SAP The port or link aggregate and encapsulation value for an SPB Service
Access Point (SAP).
Mac-address The MAC address of the device.
Service ID The SPB service ID number.
ISID The SPB service instance identifier. This value is associated with the
SPB service ID.
CVlan The customer VLAN identified through the SAP encapsulation.
Access Timestamp The date and time the device was learned.
User Name The MAC address of the user.
IP-Address The IP network address of the device.
Authentication Type The type of authentication used (Mac-Authentication or 802.1x-
Authentication).
Authentication Status The status of the authentication process (blank “–”, Authenticated,
Failed, or In Progress).
Authentication Failure Reason The reason authentication failed.
Authentication Retry Count The number of times authentication has been attempted.
Authentication Server IP Used The IP address of the authentication server.
Authentication Server Used The name of the authentication server used.
Server Reply-Message Reply message from the authentication server.
Profile The name of the SPB profile to which the user was assigned.
Profile Source The source of the profile (returned from the server or assigned through
the UNP process on the switch).
Profile From Auth Server The name of the SPB profile returned from the authentication server.
SIP Call Type The Session Initiation Protocol (SIP) call type status for a non-
supplicant (non-802.1x) device.
SIP Media Type The SIP media type status for a non-supplicant device.
Applications The applications a non-supplicant device is running.

Release History
Release 8.2.1; command was introduced.

page 36-252 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp spb-access-user details

Related Commands

unp spb-access-user flush Performs a MAC address flush of Access Guardian users (devices
learned on UNP SPB access ports).
show unp spb-profile Displays the UNP SPB profile configuration for the switch.
show unp port Displays the UNP configuration for a port or link aggregate.

MIB Objects
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-253
show unp policy validity-period UNP Commands

show unp policy validity-period

Displays the UNP period policy configuration for the switch. This type of policy is assigned to a UNP
Edge profile and applied to devices classified into the profile.
show unp policy validity-period [policy_name]

Syntax Definitions

policy_name The name of an existing UNP period policy.

Defaults
By default, all UNP period policies are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Enter a UNP period policy name to display information about a specific policy.

Examples
-> show unp policy validity-period
Policy Days Months Hours Interval TZ Active
------+-------+------------+-------------+-------------------------------+---+----
tp1 SMTWTFS JFMAMJJASOND 08:00 - 17:00 - - - - NO
tp2 ------- ------------ - - - 01/01/13 00:00 - 01/02/13 00:00 CST NO

Total Period Policy Count: 2

-> show unp policy validity-period tp1

Policy Days Months Hours Interval TZ Active
------+-------+------------+-------------+-------------------------------+---+----
tp1 SMTWTFS JFMAMJJASOND 08:00 - 17:00 - - - - NO

Release History
Release 8.1.1; command introduced.

Related Commands

unp policy validity-period Configures a UNP period policy.

unp edge-profile period-policy Assigns a UNP period policy to an Edge profile.

page 36-254 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show unp policy validity-period

MIB Objects
alaDaUNPValidityPeriodTable
alaDaUNPValidityPeriodName
alaDaUNPValidityPeriodDays
alaDaUNPValidityPeriodDaysStatus
alaDaUNPValidityPeriodMonths
alaDaUNPValidityPeriodMonthsStatus
alaDaUNPValidityPeriodHour
alaDaUNPValidityPeriodHourStatus
alaDaUNPValidityPeriodEndHour
alaDaUNPValidityPeriodInterval
alaDaUNPValidityPeriodIntervalStatus
alaDaUNPValidityPeriodEndInterval
alaDaUNPValidityPeriodTimezone
alaDaUNPValidityPeriodTimezoneStatus
alaDaUNPValidityPeriodActiveStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-255
show unp policy validity-location UNP Commands

show unp policy validity-location

Displays the UNP location policy configuration for the switch. This type of policy is assigned to a UNP
Edge profile and applied to devices classified into the profile.
show unp policy validity-location [policy_name]

Syntax Definitions

policy_name The name of an existing UNP location policy.

Defaults
By default, all UNP location policies are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Enter a location policy name to display information about a specific policy.

Examples
-> show unp policy validity location
Policy: l1
Port = 1/1
System Name = shasta
System Location = Bangalore

Total Location Policy Count: 1

Release History
Release 8.1.1; command introduced.

Related Commands

unp policy validity-location Configures a UNP location policy.

unp edge-profile location- Assigns a UNP location policy to an Edge profile.
policy

MIB Objects
alaDaUNPLocationPolicyTable
alaDaUNPLocationPolicyName
alaDaUNPLocationPolicyPort
alaDaUNPLocationPolicySystemName
alaDaUNPLocationPolicySystemLocation

page 36-256 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands captive-portal name

captive-portal name
Configures the name of the redirect URL to use for Captive Portal.
captive-portal name cp_url_name
no captive-portal name cp_url_name

Syntax Definitions

cp_url_name The Captive Portal redirect URL.

Defaults
By default, the Captive Portal redirect name is set to “captive-portal.com”.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to revert the URL name back to the default, “captive-portal.com”.

• Use this command to change the Captive Portal redirect URL name to match the common name (cn)
used by the public certificate on the switch. Matching these two names prevents a certificate warning
message caused when these names do not match.
• When a device is classified into an Edge profile that has the Captive Portal authentication attribute
enabled, the device is placed into a Captive Portal pre-login state. In this state, the device can contact a
DHCP server to get an IP address and get the DNS server address.
• Initial HTTP requests received from a user device are responded to with the Captive Portal redirect
name. The user device contacts the DNS server to resolve the redirect name and receives the Captive
Portal IP address. Requests are then sent to the Captive Portal IP address that is mapped internally to
the OmniSwitch web server, which then presents login Web pages to the user device.
• Make sure the DNS server configuration reflects the same Captive Portal name and IP address that is
configured for the OmniSwitch.

Examples
-> captive-portal name cert-name
-> no captive-portal name

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-257
captive-portal name UNP Commands

Related Commands

captive-portal ip-address Configures the internal Captive Portal IP address for the switch.
show captive-portal Displays the global Captive Portal configuration for the switch.
configuration

MIB Objects
alaDaCPortalGlobalConfig
alaDaCPortalRedirectUrlName

page 36-258 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands captive-portal ip-address

captive-portal ip-address
Configures the internal Captive Portal IP address for the switch.
captive-portal ip-address ip_address
no captive-portal ip-address

Syntax Definitions

ip_address IPv4 network address (e.g., 10.0.0.0, 171.15.0.0, 196.190.254.0).

Defaults
By default, no Captive Portal IP address is set for the switch.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the internal IP address from the Captive Portal global
configuration.
• When a device is classified into an Edge profile that has the Captive Portal authentication attribute
enabled, the device is placed into a Captive Portal pre-login role. In this state, the device can contact a
DHCP server to get an IP address and get the DNS server address.
• Initial HTTP requests received from a user device are responded to with the Captive Portal redirect
name. The user device contacts the DNS server to resolve the redirect URL name and receives the
Captive Portal IP address. Requests are then sent to the Captive Portal IP address that is mapped
internally to the OmniSwitch web server, which then presents login web pages to the user device.
• Make sure the DNS server configuration reflects the same Captive Portal name and IP address that is
configured for the OmniSwitch.

Examples
-> captive-portal ip-address 10.255.0.20
-> no captive-portal ip-address

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-259
captive-portal ip-address UNP Commands

Related Commands

captive-portal name Configures the name of the redirect URL that is used for accessing a
public certificate.
show captive-portal Displays the global Captive Portal configuration for the switch.
configuration

MIB Objects
alaDaCPortalGlobalConfig
alaDaCPortalIpAddress

page 36-260 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands captive-portal success-redirect-url

captive-portal success-redirect-url
Configures the URL of a specific site to which a user is redirected after a successful Captive Portal
authentication.
captive-portal success-redirect-url redirect_url
no captive-portal success-redirect-url

Syntax Definitions

redirect_url The redirect URL (up to 63 characters).

Defaults
By default, no success redirect URL is configured.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to remove the success redirect URL from the Captive Portal global
configuration.

Examples
-> captive-portal success-redirect-url http://server-1.com/pass.html
-> no captive-portal success-redirect-url

Release History
Release 8.1.1; command was introduced.

Related Commands

show captive-portal Displays the global Captive Portal configuration for the switch.
configuration

MIB Objects
alaDaCPortalGlobalConfig
alaDaCPortalSuccRedirectUrl

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-261
captive-portal proxy-server-port UNP Commands

captive-portal proxy-server-port
Configures the proxy server port to use for Captive Portal.
captive-portal proxy-server-port proxy_port
no captive-portal proxy-server-port

Syntax Definitions

proxy_port The HTTP proxy port number. The valid range is 1024–49151.

Defaults
By default, the proxy port number is set to 8080.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to set the proxy port number back to the default (8080).

• This command overwrites the existing proxy port number for the switch.

• The proxy port number only requires changing if the proxy port used is not 80 or 8080.

Examples
-> captive-portal proxy-server-port 1200
-> no captive-portal proxy-server-port

Release History
Release 8.1.1; command was introduced.

Related Commands

show captive-portal Displays the global Captive Portal configuration for the switch.
configuration

MIB Objects
alaDaCPortalGlobalConfig
alaDaCPortalProxyPort

page 36-262 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands captive-portal retry-count

captive-portal retry-count
Configures the number of times a device can try to login before Captive Portal determines that
authentication for that device has failed.
captive-portal retry-count retries
no captive-portal retry-count

Syntax Definitions

retries The number of login attempts allowed. The valid range is 1–99.

Defaults
By default, the retry count is set to 3.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to set the number of login retries back to the default (3).

• No access page is sent to devices that exceed the number of login retries allowed.

Examples
-> captive-portal retry-count 5
-> no captive-portal retry-count

Release History
Release 8.1.1; command was introduced.

Related Commands

show captive-portal Displays the global Captive Portal configuration for the switch.
configuration

MIB Objects
alaDaCPortalGlobalConfig
alaDaCPortalRetryCnt

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-263
captive-portal authentication-pass UNP Commands

captive-portal authentication-pass
Configures the name of a QoS policy list or UNP Edge profile for the global Captive Portal configuration.
The specified list or Edge profile is applied to each device that passes Captive Portal authentication.
captive-portal authentication-pass [realm {prefix | suffix} domain domain_name] {policy-list
list_name | edge-profile profile_name | edge-profile-change {enable | disable}}
no captive-portal authentication-pass [realm {prefix | suffix} domain domain_name] {policy-list |
edge-profile}

Syntax Definitions

prefix Specifies a prefix domain name (e.g., domain_name/user).

suffix Specifies a suffix domain name (e.g., user@domain_name)
domain_name The domain name for the user device.
list_name The name of a QoS policy list to apply to the authenticated user device.
profile_name The name of an existing UNP Edge profile.
enable Applies the policy list specified in the Edge profile.
disable Does not apply the policy list specified in the Edge profile.

Defaults
By default, no policy list name or UNP Edge profile name is specified for the global Captive Portal
configuration. The Edge profile change parameter is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the Captive Portal authentication pass policy from the
global Captive Portal configuration.
• Use the optional realm prefix domain or realm suffix domain parameter to apply the authentication
policy list or UNP Edge profile based on the domain name of the Captive Portal authenticated user
device.
• If none of the optional parameters (realm prefix domain or realm suffix domain) are specified with
this command, then the policy list or UNP Edge profile is applied to all Captive Portal authenticated
user devices.
• If the edge-profile-change parameter is enabled, the Edge profile initially assigned to the Captive
Portal users is changed to the profile derived through successful Captive Portal authentication. The
QoS policy list specified in the new Edge profile is then applied to the authenticated users.
• When an Edge profile change occurs, the new profile may assign a different VLAN to the authenticated
device. If so, a port bounce or pause timer operation is triggered to learn the device in the new VLAN.
• The initial Edge profile assignment for a user device is not changed to the new Edge profile (a profile
derived through successful Captive Portal authentication) unless the edge-profile-change parameter is

page 36-264 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands captive-portal authentication-pass

enabled. When an Edge profile change is triggered, the new profile may assign a different VLAN to the
user device. If so, a port bounce or pause timer operation will occur to learn the device in the new
VLAN.
• If the new Edge profile assigned also has Captive Portal authentication enabled, the process is not
started again. The results from the initial Captive Portal authentication process are used instead.
• If the edge-profile-change parameter is disabled, then the QoS policy list name returned from the
RADIUS server or the list name specified with this command is applied instead.
• The QoS policy list to apply to Captive Portal authenticated devices is derived through one of the
following methods:
– The policy list name returned from the RADIUS server.
– The policy list name specified with this command for the global Captive Portal configuration.
– The policy list name specified in the UNP Edge profile returned from the RADIUS server.
– The policy list name specified in the UNP Edge profile specified with this command for the global
Captive Portal configuration.
• Devices connected to UNP ports initially undergo Layer 2 authentication and/or classification at the
port level to determine an initial UNP Edge profile assignment. Then, based on the Edge profile
settings, the user may be redirected for secondary authentication through the Captive Portal
mechanism. Successful Captive Portal authentication can result in one of the following:
– A QoS policy list name returned from the RADIUS server is applied.
– If a policy list name is not returned from the server, the list name specified with this command is
applied.
– A UNP Edge profile name returned from the RADIUS server is applied.
– If an Edge profile name is not returned from the server, the profile name specified through this
command is applied.
• An Edge profile name returned from the RADIUS server takes precedence over the Edge profile name
configured through this command.
• A successful Captive Portal authentication could result in the assignment of a new Edge profile, which
may designate a different VLAN. This new VLAN assignment is functional only after a port bounce or
pause timer operation is completed. Existing BYOD global commands are leveraged to configure port-
bounce or pause-timer. The usage example is as given below.

Examples
-> captive-portal authentication-pass policy-list list1
-> captive-portal authentication-pass edge-profile edge1
-> captive-portal authentication-pass realm prefix domain asia-pacific policy-list
list2
-> captive-portal authentication-pass realm suffix domain north-america edge-
profile edge2
-> captive-portal authentication-pass edge-profile-change enable
-> captive-portal authentication-pass edge-profile-change disable
-> no captive-portal authentication-pass policy-list
-> no captive-portal authentication-pass edge-profile
-> no captive-portal authentication-pass realm suffix domain north-america

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-265
captive-portal authentication-pass UNP Commands

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; edge-profile and edge-profile-change parameters added.

Related Commands

show captive-portal Displays the global Captive Portal configuration for the switch.
configuration

MIB Objects
alaDaCPortalGlobalConfig
alaDaCPortalPolicyListName
alaDaCPortalUNPProfile
alaDaCPortalUNPProfileChange

page 36-266 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands captive-portal-profile

captive-portal-profile
Configures a Captive Portal profile that is used to define and apply a specific configuration to devices
classified into an Edge profile to which the Captive Portal profile is assigned. This section describes the
base command (captive-portal-profile profile_name) along with the other command keywords that are
used to configure profile attributes that are applied when the Captive Portal profile is assigned to an Edge
profile.
captive-portal-profile profile_name
[aaa-profile aaa_profile_name]
[success-redirect-url redirect_url]
[retry-count retries]
[authentication-pass [realm {prefix | suffix} domain domain_name] {policy-list list_name | edge-
profile profile_name | edge-profile-change {enable | disable}}]
no captive-portal-profile profile_name

Syntax Definitions

profile_name The name to assign to the Captive Portal profile (up to 32 characters).
aaa_profile_name The name of an authentication, authorization, and accounting (AAA)
profile to associate with the Captive Portal profile.
redirect_url A URL (up to 63 characters) to which user devices are redirected after
successful Captive Portal authentication.
retries The number of login attempts allowed. The range is 1–99.
realm prefix Specifies a prefix domain name (e.g., domain_name/user).
realm suffix Specifies a suffix domain name (e.g., user@domain_name).
domain_name The domain name for the user device.
list_name The name of a QoS policy list to apply to the authenticated user device.
profile_name The name of an existing UNP Edge profile.
enable Applies the QoS policy list specified in the Edge profile to the user
device.
disable Does not apply the QoS policy list specified in the Edge profile.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-267
captive-portal-profile UNP Commands

Defaults

parameter default
aaa_profile_name none
redirect_url none
retries 3
realm prefix | suffix none
domain_name none
list_name none
profile_name none
enable | disable disabled

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the Captive Portal profile from the switch configuration.

• Creating a Captive Portal profile name with the base command (captive-portal-profile profile_name)
is not required to configure a profile attribute value. If the profile name does not exist, the switch will
automatically create the name specified when the attribute is configured. For example, the unp
captive-portal-profile cp-prof1 retry-count 5 command will create the “cp-prof1” profile if it does
not already exist in the switch configuration.
• When a Captive Portal profile is applied to a UNP Edge profile, the parameter values defined in the
profile override the global Captive Portal parameter values configured for the switch.
• A Captive Portal profile is only applied when Captive Portal authentication is enabled for the UNP
Edge profile. If there is no Captive Portal profile associated with an Edge profile, then the global
Captive Portal configuration is applied.
• Assigning an AAA profile to a Captive Portal profile defines specific AAA configuration options (such
as RADIUS servers and RADIUS client attributes) that are used for Captive Portal authentication. If
there is no AAA profile assigned, then the global AAA configuration is used.
• AAA profiles are configured using the aaa profile command. See the “AAA Commands” chapter in
the OmniSwitch AOS Release 8 CLI Reference Guide for more information.

Examples
-> captive-portal-profile cp-p1
-> captive-portal-profile cp-p1 aaa-profile aaa_p1
-> captive-portal-profile cp-p1 authentication-pass realm prefix domain asia-
pacific policy-list list1
-> no captive-portal-profile cp-p1 aaa-profile aaa_p1
-> no captive-portal-profile cp-p1

-> captive-portal-profile cp-p2 retry-count 5

-> captive-portal-profile cp-p2 authentication-pass edge-profile ep-1
-> captive-portal-profile cp-p2 authentication-pass edge-profile-change enable

page 36-268 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands captive-portal-profile

-> captive-portal-profile cp-p2 success-redirect-url http://server-1.com/pass.html

-> captive-portal-profile cp-p2 authentication-pass edge-profile-change disable
-> no captive-portal-profile cp-p2 authentication-pass edge-profile
-> no captive-portal-profile cp-p2

Release History
Release 8.1.1; command was introduced.
Release 8.2.1; edge-profile and edge-profile-change parameters added.

Related Commands

unp edge-profile captive- Assigns a Captive Portal profile to a UNP Edge profile.
portal-profile
aaa profile Configures an AAA configuration profile.
show captive-portal profile- Displays the Captive Portal profile configuration for the switch.
name

MIB Objects
alaDaCPortalProfTable
alaDaCPortalProfName
alaDaCPortalProfSuccRedirectUrl
alaDaCPortalProfRetryCnt
alaDaCPortalProfAuthPolicyListName
alaDaCPortalProfUNPProfile
alaDaCPortalProfUNPProfileChange
alaDaCPortalProfAaaProf
alaDaCPortalProfDomainTable
alaDaCPortalProfDomainAuthRealm
alaDaCPortalProfDomainAuthPolicyListName
alaDaCPortalProfDomainUNPProfile

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-269
captive-portal customization UNP Commands

captive-portal customization
Enables or disables the use of custom Web pages for Captive Portal authentication. When customization is
enabled, Captive Portal presents Web pages stored in the “/flash/switch/captive_portal/custom_files/”
directory on the switch. When customization is disabled, Captive Portal presents Web pages stored in the
“/flash/switch/captive_portal/release_files/” directory on the switch.
captive-portal customization {enable | disable}

Syntax Definitions

enable Displays custom web pages for Captive Portal authentication.

disable Displays default web pages for Captive Portal authentication.

Defaults
By default, the web pages provided on the switch are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• To create custom Web pages, create a folder in the same path as the “release_files” folder and name the
new folder “custom_files” (for example “/flash/switch/captive_portal/custom_files/”). Next, copy the
“assets” and “templates” folders found under “/flash/switch/captive_portal/release_files/” to the
“custom_files” folder. Modify the contents in the copied folders to create custom Web pages.
• The “release_files” folder is overwritten each time the switch reboots, so DO NOT modify the files in
this folder for custom use.
• The folders "assets" and "templates" under the /flash/switch/captive_portal/custom_files/ directory are
used to create and display Web pages to Captive Portal users when the switch reboots or at runtime
when Captive Portal customization is enabled for the switch, if the “custom_files” folder exists.
• Anything in the custom "assets" folder is statically served by the internal Web server on the switch
whenever they are requested. These pages are typically .css files, javascript files, or the acceptable use
policy and are linked to files in the custom "templates" folder.
• The custom "templates" folder contains the Web pages that are dynamically served to users depending
on the Captive Portal state of each user. The file names in this folder must not be changed. The login
form field names and form action in these pages must not be changed. The variables in these pages, as
denoted by "<?=$(name)?>”, are substituted in place by the internal Web server.

Examples
-> captive-portal customization enable
-> captive-portal customization disable

Release History
Release 8.1.1; command was introduced.

page 36-270 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands captive-portal customization

Related Commands

show captive-portal Displays the global Captive Portal configuration for the switch.
configuration

MIB Objects
alaDaCPortalGlobalConfig
alaDaCPortalCustomization

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-271
show captive-portal configuration UNP Commands

show captive-portal configuration

Displays the global Captive Portal parameter settings configured for the switch.
show captive-portal configuration

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Currently only the internal (Web server on the switch) Captive Portal mode is configurable for the
switch. An external Captive Portal operation is provided through interaction with the ClearPass Policy
Manager (CPPM) as part of the OmniSwitch BYOD solution.
• The parameter values configured and applied through a Captive Portal profile override any values set
through the global Captive Portal configuration. A Captive Portal profile is associated with a UNP
Edge profile and is applied to devices classified into that profile.

Examples
-> show captive-portal configuration

Captive Portal Global Configuration:

Captive Portal Mode = Internal

Captive Portal IP address = 1.1.1.3
Captive Portal Redirect String = captive-portal.com
Captive Portal Success Redirect URL =
Captive Portal Proxy Server Port = 8080
Captive Portal Retry Count = 3
Captive Portal Global Auth Policy List=
Captive Portal Page Customization = Disable
Captive Portal Edge Profile Name =
Captive Portal Edge Profile Change = Disable
Domain Specific Policy Lists:
Domain | Realm | Policy List
--------------------------------|--------|--------------------------------

page 36-272 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show captive-portal configuration

output definitions
Captive Portal Mode The Captive Portal mode of operation. Only internal mode (Web server
on the OmniSwitch) is supported at this time.
Captive Portal IP address The internal Captive Portal IP address for the switch. Configured
through the captive-portal ip-address command.
Captive Portal Redirect String The name of the redirect URL that is used for accessing a public
certificate. Configured through the captive-portal name command.
Captive Portal Success The URL of a specific site to which a user is redirected after a
Redirect URL successful Captive Portal authentication. Configured through the
captive-portal success-redirect-url command.
Captive Portal Proxy Server The proxy server port to use for Captive Portal. Configured through the
Port captive-portal proxy-server-port command.
Captive Portal Retry Count The number of times a device can try to login before Captive Portal
determines that authentication for that device has failed. Configured
through the captive-portal retry-count command.
Captive Portal Global Auth The name of a QoS policy list for the global Captive Portal
Policy List configuration. The specified list is applied to each device that passes
Captive Portal authentication. Configured through the captive-portal
authentication-pass command.
Captive Portal Page The status of Captive Portal page customization (Enable or Disable).
Customization When enabled, custom Web pages are presented to the user from the “/
flash/switch/captive_portal/custom_files/” location on the switch.
Configured through the captive-portal customization command.
Captive Portal Edge Profile The name of a UNP Edge profile for the global Captive Portal
Name configuration. The specified profile is applied to each device that
passes Captive Portal authentication. Configured through the captive-
portal authentication-pass command.
Captive Portal Edge Profile The status of Edge profile change (Enable or Disable). When enabled,
Change the Edge profile initially assigned to the Captive Portal user is changed
to the profile derived through successful Captive Portal authentication.
Configured through the captive-portal authentication-pass command.
Domain Specific Policy Lists: A list of QoS policy list names and the associated domain criteria for
each list name. The policy list is applied when the domain for a Captive
Portal authenticated user device matches the domain criteria associated
with the list.
Domain The domain name associated with the domain specific policy list.
Configured through the captive-portal authentication-pass command.
Realm The realm of the domain name (prefix or suffix) associated with the
domain specific policy list. The realm identifies the domain name as a
prefix (domain-name/user) or as a suffix (user@domain-name).
Configured through the captive-portal authentication-pass command.
Policy List The name of the policy list that is applied when the domain of a Captive
Portal authenticated user device matches the domain criteria associated
with the list name. Configured through the captive-portal
authentication-pass command.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-273
show captive-portal configuration UNP Commands

Release History
Release 8.1.1; command was introduced.

Related Commands

show captive-portal profile- Displays the Captive Portal profile configuration for the switch.
name

MIB Objects
alaDaUNPGlobalConfiguration
alaDaUNPAuthSrvDownEdgeProfName
alaDaUNPAuthServerDowneEdgeProfTimeout
alaDaUNPRedirectPortBounce
alaDaUNPRedirectPauseTimer
alaDaUNPRedirectProxyServerPort
alaDaUNPRedirectServerIP
alaDaUNPRedirectAllowedServerTable
alaDaUNPRedirectAllowedServerName
alaDaUNPRedirectAllowedServerIP
alaDaUNPRedirectAllowedMaskIP

page 36-274 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show captive-portal profile-name

show captive-portal profile-name

Displays the Captive Portal profile configuration for the switch.
show captive-portal {profile-names | profile-name profile_name configuration}

Syntax Definitions

profile-names Displays a list of configured Captive Portal profiles.

profile-name profile_name Displays the Captive Portal parameter configuration for the specified
configuration profile.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The parameter values configured and applied through a Captive Portal profile override any values set
through the global Captive Portal configuration.
• Currently only the internal (Web server on the switch) Captive Portal mode is configurable for the
switch. An external Captive Portal operation is provided through interaction with the ClearPass Policy
Manager (CPPM) as part of the OmniSwitch BYOD solution.

Examples
-> show captive-portal profile-names

Captive Portal Profile Names

----------------------------------------
1. cp1
2. cp2
3. cp3

-> show captive-portal profile-name cp1 configuration

Captive Portal Profile cp1 Configuration:

Captive Portal Mode = Internal

Captive Portal AAA Profile Name =
Captive Portal Success Redirect URL =
Captive Portal Retry Count = 3
Captive Portal Global Auth Policy List =
Domain Specific Policy Lists:
Domain | Realm | Policy List
--------------------------------|--------|--------------------------------

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-275
show captive-portal profile-name UNP Commands

output definitions
Captive Portal Mode The Captive Portal mode of operation. Only internal mode (Web server
on the OmniSwitch) is supported at this time.
Captive Portal AAA Profile The name of an authentication, authorization, and accounting (AAA)
Name profile associated with the Captive Portal profile.
Captive Portal Success The URL of a specific site to which a user is redirected after a
Redirect URL successful Captive Portal authentication.
Captive Portal Retry Count The number of times a device can try to login before Captive Portal
determines that authentication for that device has failed.
Captive Portal Global Auth The name of a QoS policy list for the global Captive Portal
Policy List configuration. The specified list is applied to each device that passes
Captive Portal authentication.
Domain Specific Policy Lists: A list of QoS policy list names and the associated domain criteria for
each list name. The policy list is applied when the domain for a Captive
Portal authenticated user device matches the domain criteria associated
with the list.
Domain The domain name associated with the domain specific policy list.
Realm The realm of the domain name (prefix or suffix) associated with the
domain specific policy list. The realm identifies the domain name as a
prefix (domain-name/user) or as a suffix (user@domain-name).
Policy List The name of the policy list that is applied when the domain of a Captive
Portal authenticated user device matches the domain criteria associated
with the list name.

Release History
Release 8.1.1; command was introduced.

Related Commands

captive-portal-profile Configures a Captive Portal profile.

show captive-portal Displays the global Captive Portal parameter settings configured for the
configuration switch

MIB Objects
alaDaCPortalProfTable
alaDaCPortalProfName
alaDaCPortalProfSuccRedirectUrl
alaDaCPortalProfRetryCnt
alaDaCPortalProfAuthPolicyListName
alaDaCPortalProfAaaProf

page 36-276 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands qmr quarantine path

qmr quarantine path

Specifies the URL for a remediation server. This information is used by the Quarantine Manager and
Remediation (QMR) application. A quarantined user is redirected to a remediation server to correct the
condition that put the user into a quarantined state.
qmr quarantine path url
no qmr quarantine path

Syntax Definitions
url The URL for the QMR remediation server.

Defaults
By default, no URL is configured.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to remove the remediation server URL from the configuration.

• Make sure to add the corresponding IP address for the remediation server to the QMR list of exception
subnets configured through the qmr quarantine allowed-name command.
• Configuring the URL and adding the server IP address to the allowed list is required to redirect
quarantined MAC addresses to the remediation server.

Examples
-> qos quarantine path www.remediate.com
-> no quarantine path

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-277
qmr quarantine path UNP Commands

Related Commands

qmr quarantine page Configures whether or not QMR will send a “Quarantined” page to a
user when a remediation server is not configured.
qmr quarantine allowed-name Configures a list of IP addresses to which a restricted quarantined user
can access.
qmr quarantine custom-proxy Configures the HTTP proxy port number that is used to redirect traffic
from a quarantined device.
qos quarantine mac-group Configures the name of the Quarantine MAC address group.
show qmr Displays the Access Guardian QMR configuration.
show quarantine mac group Displays the contents of the QoS quarantined MAC address group.

MIB Objects
alaDaQMRGlobalConfig
alaDaQMRPath

page 36-278 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands qmr quarantine page

qmr quarantine page

Configures the QMR application to send a “Quarantined” page to a client if a remediation server is not
configured. This page is used to notify the client that QMR has quarantined the client.
qmr qos quarantine page {enable | disable}

Syntax Definitions

enable Enables the sending of a “Quarantined” page to the client.

disable Disables the sending of a “Quarantined” page to the client.

Defaults
By default, no “Quarantined” page is sent to the client.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
A “Quarantined” page is only sent if a remediation server path was not configured for QMR. Note that
even if the remediation server is not active, QMR will not send the page as long as there is a value set for
the remediation server path.

Examples
-> qmr quarantine page enable
-> qmr quarantine page disable

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-279
qmr quarantine page UNP Commands

Related Commands

qmr quarantine path Specifies the URL for a remediation server.

qmr quarantine allowed-name Configures a list of IP addresses to which a restricted quarantined user
can access.
qmr quarantine custom-proxy Configures the HTTP proxy port number that is used to redirect traffic
from a quarantined device.
qos quarantine mac-group Configures the name of the Quarantine MAC address group.
show qmr Displays the Access Guardian QMR configuration.
show quarantine mac group Displays the contents of the QoS quarantined MAC address group.

MIB Objects
alaDaQMRGlobalConfig
alaDaQMRPage

page 36-280 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands qmr quarantine allowed-name

qmr quarantine allowed-name

Configures a list of IP addresses that a restricted quarantined user is allowed to access.
qmr quarantine allowed-name name ip-address ip_address [ip-mask ip_mask]
no qmr quarantine allowed-name name

Syntax Definitions

name Specify a name to assign to the allowed IP network address.

ip_address An IPv4 network address (for example, 10.0.0.0, 171.15.0.0, or
196.190.254.0).
ip_mask A valid IP address mask for the allowed IP network address (for
example, 255.0.0.0 or 255.255.0.0)

Defaults
By default, no IP addresses are configured as QMR allowed addresses.

parameter default
ip_mask IP address class

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an IP address from the allowed list.

• A maximum of three allowed IP addresses is supported.

• Make sure the IP address of the QMR remediation server is configured as an allowed IP address. A
quarantined user is redirected to a remediation server to correct the condition that put the user into a
quarantined state.

Examples
-> qmr quarantine allowed-name server2 ip-address 10.0.0.20 ip-mask 255.0.0.0
-> no qmr quarantine allowed-name server2

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-281
qmr quarantine allowed-name UNP Commands

Related Commands

qmr quarantine path Specifies the URL for a remediation server.

qmr quarantine page Configures whether or not QMR will send a “Quarantined” page to a
user when a remediation server is not configured.
qmr quarantine custom-proxy Configures the HTTP proxy port number that is used to redirect traffic
from a quarantined device.
qos quarantine mac-group Configures the name of the Quarantine MAC address group.
show qmr Displays the Access Guardian QMR configuration.
show quarantine mac group Displays the contents of the QoS quarantined MAC address group.

MIB Objects
alaDaQMRAllowedTable
alaDaQMRAllowedName
alaDaQMRAllowedIpAddr
alaDaQMRAllowedIpMask

page 36-282 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands qmr quarantine custom-proxy

qmr quarantine custom-proxy

Configures the HTTP proxy port number to which quarantined traffic is redirected for remediation.
qmr quarantine custom-proxy proxy_port
no qmr quarantine custom-proxy

Syntax Definitions

proxy_port The HTTP proxy port number. The valid range is 1025–65535.

Defaults
By default, the redirect proxy port number is set to 8080.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to set the proxy port number back to 8080 (the default).

• Setting the custom proxy to “0” also reverts the proxy port number back to 8080 (the default).

Examples
-> qmr quarantined custom-proxy 8887
-> qmr quarantined custom-proxy 0
-> no qmr quarantined custom-proxy

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-283
qmr quarantine custom-proxy UNP Commands

Related Commands

qmr quarantine path Specifies the URL for a remediation server.

qmr quarantine page Configures whether or not QMR will send a “Quarantined” page to a
user when a remediation server is not configured.
qmr quarantine allowed-name Configures a list of IP addresses to which a restricted quarantined user
can access.
qos quarantine mac-group Configures the name of the Quarantine MAC address group.
show qmr Displays the Access Guardian QMR configuration.
show quarantine mac group Displays the contents of the QoS quarantined MAC address group.

MIB Objects
alaDaQMRGlobalConfig
alaDaQMRCustomHttpProxyPort

page 36-284 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show qmr

show qmr
Displays the Quarantine Manager and Remediation (QMR) configuration for the switch.
show qmr

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
QMR is an OmniSwitch application that interacts with the OmniVista Quarantine Manager (OVQM)
application to restrict the network access of quarantined clients and provide a remediation path for such
clients to regain their network access. This command displays the OmniSwitch QMR configuration.

Examples
-> show qmr

Quarantine Mac Group Name : Quarantine,

Allowed IP Subnets : IT-HD 135.254.1.10 /255.255.255.248,
oss-lan 10.1.1.0 /255.255.255.0,
rem-ser 135.254.200.0 /255.255.255.0,
Custom Proxy port : 8888,
Quarantine Path : www.remediation-server.alu.com,
Quarantine Page : enabled,

output definitions
Quarantine MAC Group The name of the QoS Quarantine MAC address group. Configured
Name through the qos quarantine mac-group command.
Allowed IP Subnets A list of IP network addresses that devices can still access while in a
quarantined state. Configured through the qmr quarantine allowed-
name command.
Custom Proxy port The HTTP proxy port number used for redirection of HTTP traffic
from quarantined devices. Configured through the qmr quarantine
custom-proxy command.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-285
show qmr UNP Commands

output definitions
Quarantine Path The URL of a remediation server to which a device is redirected when
the device is quarantined. Configured through the qmr quarantine
path command.
Quarantine Page Whether or not QMR sends a “Quarantined” page notification to a
quarantined user when there is no remediation server configuration.
Configured through the qmr quarantine page command.

Release History
Release 8.1.1; command was introduced.

Related Commands

show quarantine mac group Displays the contents of the QoS Quarantine MAC address group.

MIB Objects
alaQoSConfigTable
alaQoSConfigQuarantineMacGroupName
alaDaQMRAllowedTable
alaDaQMRAllowedName
alaDaQMRAllowedIpAddr
alaDaQMRAllowedIpMask
alaDaQMRGlobalConfig
alaDaQMRCustomHttpProxyPort
alaDaQMRPath
alaDaQMRPage

page 36-286 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show quarantine mac group

show quarantine mac group

Displays the contents of the QoS Quarantine MAC address group.
show quarantine mace group

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The QoS MAC address group contains the MAC addresses of clients that the OmniVista Quarantine
Manager (OVQM) application has quarantined. This command displays the quarantined MAC addresses
that belong to this group.

Examples
-> show quarantine mac group

Group Name : Quarantine,

Number of MACs quarantined : 11,
00:00:00:11:11:1b,
00:00:00:11:11:1a,
00:00:00:11:11:19,
00:00:00:11:11:18,
00:00:00:11:11:17,
00:00:00:11:11:16,
00:00:00:11:11:15,
00:00:00:11:11:14,
00:00:00:11:11:13,
00:00:00:11:11:12,
00:00:00:11:11:11,

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-287
show quarantine mac group UNP Commands

Related Commands

qos quarantine mac-group Configures the name of the QoS Quarantine MAC address group.

MIB Objects
N/A

page 36-288 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands mdns-relay

mdns-relay
Enables or disables the Multicast Domain Name System (mDNS) relay on the switch.
mdns-relay {enable | disable}

Syntax Definitions

enable Enables mDNS relay.

disable Disables mDNS relay.

Defaults
The MDNS relay feature is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• A GRE tunnel interface must be associated with the mDNS tunnel relay before mDNS can be enabled.

• When MDNS relay is disabled on the switch, mDNS packets are handled in the same manner as
conventional packets.

Example
-> mdns-relay enable
-> mdns-relay disable

Release History
Release 8.1.1; command introduced.

Related Commands

mdns-relay tunnel Associates a GRE tunnel interface with the mDNS relay feature.
show mdns-relay config Displays the mDNS relay configuration.

MIB Objects
iphelperMIB
alaMdnsAdminStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-289
mdns-relay tunnel UNP Commands

mdns-relay tunnel
Associates a GRE tunneling interface for the Multicast DNS (mDNS) relay feature.
mdns-relay tunnel ip-interface-name
no mdns-relay tunnel ip-interface-name

Syntax Definitions

ip-interface-name The name of an existing IP GRE tunnel interface to associate with the
mDNS tunnel relay.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the associated GRE tunnel interface.

• Configure the GRE tunnel interface before attempting to associate the interface with the mDNS tunnel
relay. An IP address is required to bring the interface up; if necessary, specify a dummy IP address
when configuring the interface.
• Only a Layer 2 GRE Tunnel interface is supported.

• GRE Tunneling is supported only for IPv4 frames.

• To change the GRE tunnel interface, execute the command with the new existing IP interface name.

Example
-> mdns-relay tunnel Payroll
-> no mdns-relay tunnel Payroll

Release History
Release 8.1.1; command introduced.

page 36-290 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands mdns-relay tunnel

Related Commands

ip interface tunnel Configures a GRE tunnel interface.

mdns-relay Enables or disables mDNS tunnel relay for the switch.
show mdns-relay config Displays the mDNS relay configuration.

MIB Objects
iphelperMIB
alaMdnsGreTunnelName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-291
show mdns-relay config UNP Commands

show mdns-relay config

Displays the mDNS relay configuration.
show mdns-relay config

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Example
-> show mdns-relay config
mdns-relay admin status : disabled
mdns-relay tunnel interface : byod_dev
mdns-relay operational status : down

output definitions
mdns-relay admin status The mDNS relay administrative status (enabled or disabled).
mdns-relay tunnel interface The GRE tunnel interface name for the mDNS relay feature.
mdns-relay operational status The mDNS relay operational status (up or down).

Release History
Release 8.1.1; command introduced.

Related Commands

mdns-relay Enables or disables mDNS tunnel relay for the switch.

mdns-relay tunnel Associates a GRE tunnel interface with the mDNS relay feature.

MIB Objects
iphelperMIB
alaMdnsAdminStatus
alaMdnsGreTunnelName

page 36-292 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands ssdp-relay

ssdp-relay
Enables or disables the Simple Service Discovery Protocol (SSDP) relay on the switch. SSDP relay
enables the OmniSwitch to allow non-Apple devices to discover services with minimal configuration by
the administrator.
ssdp-relay {enable | disable}

Syntax Definitions

enable Enables SSDP relay.

disable Disables SSDP relay.

Defaults
The SSDP relay feature is disabled by default.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• A GRE tunnel interface must be configured specifically for the SSDP feature before SSDP relay can be
enabled.
• The Digital Living Network Alliance (DLNA) uses Universal Plug and Play (UPnP) for media
management, discovery, and control. DLNA/UPNP uses SSDP to discover services, similar to how
Bonjour uses mDNS for the same. All the SSDP packets coming in on an OmniSwitch are intercepted
and tunneled through the GRE tunnel to the WLAN controller (acting as a gateway).
• When SSDP relay is disabled on the switch, SSDP packets are handled in the same manner as
conventional packets.

Example
-> ssdp-relay enable
-> ssdp-relay disable

Release History
Release 8.2.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-293
ssdp-relay UNP Commands

Related Commands

ssdp-relay tunnel Associates a GRE tunnel interface with the SSDP relay feature.
show ssdp-relay config Displays the SSDP relay configuration.

MIB Objects
iphelperMIB
alaSsdpAdminStatus

page 36-294 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands ssdp-relay tunnel

ssdp-relay tunnel
Assigns a GRE tunneling interface for the Simple Service Discovery Protocol (SSDP) relay feature. The
GRE tunnel is setup between the switch and a WLAN controller to tunnel SSDP frames.
ssdp-relay tunnel ip_interface_name
no ssdp-relay tunnel ip_interface_name

Syntax Definitions

ip_interface_name The name of an existing IP GRE tunnel interface to associate with the
SSDP tunnel relay.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the associated GRE tunnel interface.

• Configure the GRE tunnel interface before attempting to associate the interface with the SSDP tunnel
relay. An IP address is required to bring the interface up; use the IP address of the wireless controller
as the destination IP address for the GRE tunnel.
• Only a Layer 2 GRE Tunnel interface is supported.

• GRE Tunneling is supported only for IPv4 frames.

• To change the GRE tunnel interface, use this command again with a new existing IP interface name.

Example
-> ssdp-relay tunnel “SSDP Relay Tunnel”
-> no ssdp-relay tunnel “SSDP Relay Tunnel”

Release History
Release 8.2.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-295
ssdp-relay tunnel UNP Commands

Related Commands

ip interface tunnel Configures a GRE tunnel interface.

ssdp-relay Enables or disables SSDP tunnel relay for the switch.
show ssdp-relay config Displays the SSDP relay configuration.

MIB Objects
iphelperMIB
alaSsdpGreTunnelName

page 36-296 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
UNP Commands show ssdp-relay config

show ssdp-relay config

Displays the Simple Service Discovery Protocol (SSDP) relay configuration.
show ssdp-relay config

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Example
-> show ssdp-relay config
ssdp-relay admin status : disabled,
ssdp-relay tunnel interface : byod_dev,
ssdp-relay operational status : down

output definitions
ssdp-relay admin status The SSDP relay administrative status (enabled or disabled).
ssdp-relay tunnel interface The GRE tunnel interface name associated with the SSDP relay feature.
ssdp-relay operational status The SSDP relay operational status (up or down).

Release History
Release 8.2.1; command introduced.

Related Commands

ssdp-relay Enables or disables SSDP tunnel relay for the switch.

ssdp-relay tunnel Associates a GRE tunnel interface with the SSDP relay feature.

MIB Objects
iphelperMIB
alaSsdpAdminStatus
alaSsdpGreTunnelName
alaSsdpOperStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 36-297
show ssdp-relay config UNP Commands

page 36-298 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 37 Application Monitoring
and Enforcement Commands

Application usage patterns in the enterprise network is changing with the increase in use of the social
networking, browser based file sharing, and peer to peer applications. The use of these applications result
in the new traffic patterns in the network that are not straightforward to distinguish. There is also an
increase in consumerization of IT with multiplication of thin clients, HTTP based, and virtual desktop
clients.
OmniSwitch Application Monitoring and Enforcement (AppMon) feature addresses the key challenges of
real time classification of flows at application level by providing differential QoS treatment in the form of
higher priority marking and security policies at application level. AppMon feature improves the quality of
user experience through application aware network optimization and control.

Note. AppMon is supported in a virtual chassis of OmniSwitch 6860 and OmniSwitch 6860E platforms
where at least one OmniSwitch 6860E is mandatory for the feature to work.

MIB information for the AppMon commands is as follows:

Filename: ALCATEL-IND1-APP-MON-MIB.mib
Module: alaAppMonMIB

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-1
 Application Monitoring and Enforcement Commands

A summary of the available commands is listed here:

app-mon admin-state
app-mon port admin-state
app-mon auto-group create
app-mon app-group
app-mon app-list
app-mon apply
app-mon l3-mode
app-mon l4-mode
app-mon l4port-exclude
app-mon flow-table flush
app-mon flow-table enforcement stats
app-mon aging enforcement
app-mon logging-threshold
app-mon flow-sync enforcement interval
app-mon force-flow-sync
show app-mon config
show app-mon port
show app-mon app-pool
show app-mon app-list
show app-mon app-group
show app-mon app-record
show app-mon ipv4-flow-table
show app-mon ipv6-flow-table
show app-mon l4port-exclude
show app-mon stats
show app-mon aging enforcement
show app-mon vc-topology
clear app-mon app-list

page 37-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands app-mon admin-state

app-mon admin-state
Enable or disable the Application Monitoring and Enforcement (AppMon) feature.
app-mon admin-state {enable | disable}

Syntax Definitions

enable Enables AppMon support on the switch.

disable Disables AppMon support on the switch.

Defaults
By default, AppMon is disabled on the switch.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• AppMon cannot be enabled globally when,
– all the mirroring sessions are used by port mirroring or monitoring features.
– mirroring session is used by policy manager.
• When AppMon is enabled globally, it reserves a mirroring session in the system.

• If AppMon functionality is enabled at a port level, disabling AppMon globally overrides the
functionality of all AppMon ports; however, configuration on the ports remain the same.

Examples
-> app-mon admin-state enable
-> app-mon admin-state disable

Release History
Release 8.2.1; command introduced.

Related Commands

app-mon port admin-state Enable or disable AppMon on one or more switch ports.
show app-mon config Displays global AppMon configuration, which includes information
about admin-state, running mode, IP mode, aging-timer, and total
signatures.

MIB Objects
alaAppMonAdminStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-3
app-mon port admin-state Application Monitoring and Enforcement Commands

app-mon port admin-state

Enable or disable AppMon Monitoring and Enforcement on one or more switch ports.
app-mon {port chassis/slot/port[-port2] | slot chassis/slot [-slot]} admin-state {enable | disable}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis/slot The chassis ID and slot number (3/1) for a specific slot.
enable Enables AppMon on the port.
disable Disables AppMon on the port.

Defaults
By default, AppMon is disabled on all ports.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• It is mandatory to enable AppMon globally for the port level AppMon to function.

• When slot option is used, then AppMon configuration is applied on all the physical ports of that
particular slot.
• AppMon configuration is not allowed on Virtual Fabric Link ports.

• AppMon cannot be configured on a port that is part of a link aggregate or a port mirroring port.

• AppMon must not be configured on user ports and uplink ports at the same time.

Examples
-> app-mon slot 1/1 admin-state enable
-> app-mon port 1/1/2-5 admin-state enable
-> app-mon slot 1/1 admin-state disable

Release History
Release 8.2.1; command introduced.

page 37-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands app-mon port admin-state

Related Commands

app-mon admin-state Enable or disable the Application Monitoring feature.

show app-mon port Displays AppMon status per physical port or per slot for the switch.

MIB Objects
alaAppMonPortConfigTable
alaAppMonPortConfigSlotPortIndex
alaAppMonPortConfigPortStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-5
app-mon auto-group create Application Monitoring and Enforcement Commands

app-mon auto-group create

Creates application groups automatically on the switch. The application groups are automatically created
based on the ‘category' field of each application present in the application pool.
app-mon auto-group create

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Modifications are allowed in auto application groups with addition or deletion of applications using the
app-mon app-group command.
• Enter app-mon apply and write memory to save the auto group configuration or modification on the
switch.
• The show app-mon app-pool command displays the application categories in the signature file. The
application group names are derived from the category name.

Examples
-> app-mon auto-group create

Release History
Release 8.2.1; command introduced.

Related Commands

app-mon apply Updates the set of application signatures configured for application
monitoring.
show app-mon app-group Displays the details of all the applications in an application group.
show app-mon app-pool Displays all the applications that are part of an application pool.

MIB Objects
alaAppMonAutoGroupCreation

page 37-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands app-mon app-group

app-mon app-group
Creates an application group. Applications can be added or removed from the application group.
app-mon app-group app_group_name {add | remove} {app-name app_name | from app_name to
app_name}
no app-mon app-group app_group_name

Syntax Definitions

app_group_name Name of the application group. The group name can be a maximum of
32 alphanumeric characters.
app_name The name of the application to be added to the application group.
The application name can be a maximum of 32 alphanumeric characters.
from app_name The first application name when adding a range of applications to an
application group.
to app_name The last application name when adding a range of applications to an
application group.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an application group.

• This command can be used to add or delete applications for the auto application groups as well.

• One application can belong to more than one application group.

• Only those applications that are part of an application pool are allowed to be added to an application
group.
• To add a range of applications or multiple applications to an application group, use the from and to
options. Range is expanded based on the list of applications in the app-pool list (application pool). Use
the show app-mon app-pool command to view the application names.
• If an application is removed from an application group which has only one application, then the
complete application group is removed.
• If any application is added to a user group (group name same name as category name), and signature
toolkit update operation or 'app-mon auto-group create' is done, then added group is not deleted. Only
update happens.
• If an application group contains a single application and the group is part of an application list, then
this single application cannot be removed from the application group.
• An application group cannot be deleted when it is part of an application list.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-7
app-mon app-group Application Monitoring and Enforcement Commands

• When the last application from the application group is removed, the application group is automatically
deleted.
• The list of applications (added or deleted) to an application group is displayed in show configuration
snapshot command after app-mon apply command is entered. A list of applications (added or deleted)
are displayed with the show app-mon app-group command even without using the app-mon apply
command.

Examples
-> app-mon app-group apg2 add app-name whatsapp
-> app-mon app-group apg2 remove app-name whatsapp
-> no app-mon app-group apg2

To add a range of applications or multiple applications to an application group, use the show app-mon
app-pool command to view the application names. For example:

-> show app-mon app-pool

Legend: Application-name: *= Not present in recently updated kit,
AppId Application-name Revision Category
-------+--------------------------------+------------+----------------
968 amazon 1.0.0 Web
244 facebook 1.0.0 Web
182 sip 1.0.0 Audio/Video
183 skype 1.1.0 Instant Messaging
211 tftp 1.0.0 File Server
503 twitter 1.0.0 Web
597 viber 1.0.0 Audio/Video
890 webex 1.0.0 Audio/Video
1093 whatsapp 1.0.0 Instant Messaging
240 youtube 1.0.0 Web
---------------------------------
Number of Applications: 10

Select any two applications for the range option using the app-mon app-group command.

-> app-mon app-group apg1 add from sip to viber

This command adds the applications from sip to viber to the application group (sip, skype, tftp, twitter, and
viber).
If an application is removed from an application group which has only one application, then the complete
application group is removed. For example:

-> show app-mon app-group group1

AppGrp-Id App-group App-name
----------+----------------------------+----------------------------
1093 whatsapp Instant Messaging

Now, remove the application name ‘whatsapp’ from the application group. The complete application
group gets removed as shown below.

-> app-mon app-group group1 remove app-name whatsapp

-> show app-mon app-group group1
AppGrp-Id App-group App-name
----------+---------------------------------+----------------------------

page 37-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands app-mon app-group

Release History
Release 8.2.1; command introduced.

Related Commands

app-mon apply Updates the set of application signatures configured for application
monitoring.
show app-mon app-group Displays the details of all the applications in an application group.
show app-mon app-list Displays a list of applications and application groups added to an
application list.
show app-mon app-pool Displays all the applications that are part of an application pool.

MIB Objects
alaAppMonAppGroupTable
alaAppMonAppGroupName
alaAppMonAppGroupMember
alaAppMonAppGroupStatus
alaAppMonAppGrpFromAppName
alaAppMonAppGrpToAppName
alaAppMonAddAppGrpName
alaAppMonAppGroupBuiltIn
alaAppMonAppGroupCategoryName
alaAppMonAppGrpId
alaAppMonAppGroupAppStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-9
app-mon app-list Application Monitoring and Enforcement Commands

app-mon app-list
Add or remove applications or application groups to an application list for enforcement or monitoring.
app-mon app-list {enforcement | monitor} {add | remove} {app-name app_name | app-group
app_group_name}

Syntax Definitions

add Adds the specified application or application group to an application

list.
remove Removes the specified application or application group from an
application list.
app_name Name of the application to be added to the application list. This adds the
specified application to the application list.
app_group_name Name of the application group to be added to the application list. This
enables the addition of multiple applications in the application group to
the application list.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The application group can be user created or generated automatically (see app-mon app-group and
app-mon auto-group create command).
• Separate application list is maintained for enforcement and monitoring.

• The show configuration snapshot command displays the applications added or removed from the
application list only after the app-mon apply command is used. The app-mon apply command saves
the list of applications added or removed to the application list. The saved list of applications are
displayed with the show app-mon app-list active command.
• QoS policy rules can be configured for a given application as well as an application group where the
same application also exists. QoS matches policies based on the application-name or application-group
name configured in an application list. For more information on configuring enforcement for QoS
policy rules, see the “QoS Policy Commands” chapter.

Examples
-> app-mon app-list enforcement add app-name whatsapp
-> app-mon app-list enforcement add app-group apg1
-> app-mon app-list monitor add app-group apg2
-> app-mon app-list enforcement remove app-name whatsapp

page 37-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands app-mon app-list

Release History
Release 8.2.1; command introduced.

Related Commands

app-mon auto-group create Enables or disables Auto-Group functionality on the switch.

app-mon app-group Creates an application group. Applications can be added or removed
from the application group.
show app-mon app-list Displays list of applications and application groups added to an
application list.
clear app-mon app-list Removes all applications signatures from the application list.

MIB Objects
alaAppMonAppListTable
alaAppMonAppListMemberName
alaAppMonAppListMemberType
alaAppMonAppListMemberStatus
alaAppMonAppListAppId
alaAppMonAppListAppStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-11
app-mon apply Application Monitoring and Enforcement Commands

app-mon apply
This activates both enforcement and monitoring application lists for flow classification.
app-mon apply

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The following operations are performed with the app-mon apply command:
• Saves the current application-list, application-group, and auto-groups to flash when 'write memory'
command is used.
• The application list is checked for any application configured more than once in an application list
(individually or as a part of application group).
– The app-mon apply command will not be successful until the conflict is resolved.
– The show app-mon app-list command with the monitor conflict or the enforcement conflict
parameter displays the available conflicts in an application list.
– The duplicate application names must be removed for a successful app-mon apply operation.
• QoS is applied to the flows learned for the activated applications based on the configured QoS policies
for Enforcement application list.

Examples
-> app-mon apply

Release History
Release 8.2.1; command introduced.

page 37-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands app-mon apply

Related Commands

show app-mon config Displays global AppMon configuration, which includes information like
admin-state, running mode, IP mode, aging-timer, and total signatures.
show app-mon port Displays AppMon status per physical port or per slot for the switch.
show app-mon app-list Displays a list of applications and application groups added to an
application list.

MIB Objects
alaAppMonUpdateAppList

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-13
app-mon l3-mode Application Monitoring and Enforcement Commands

app-mon l3-mode
Enables or disables monitoring and enforcement for IPv4 flows, IPv6 flows, or both.
app-mon l3-mode {ipv4 | ipv6} admin-state {enable | disable}

Syntax Definitions

IPv4 Applies monitoring and enforcement to IPv4 flows.

IPv6 Applies monitoring and enforcement to IPv6 flows.
enable Enables the specified L3 mode on the switch.
disable Disables the specified L3 mode on the switch.

Defaults
By default, monitoring and enforcement is enabled for both IPv4 and IPv6 flows.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> app-mon l3-mode ipv4 admin-state disable
-> app-mon l3-mode ipv4 admin-state enable
-> app-mon l3-mode ipv6 admin-state disable

Release History
Release 8.2.1; command introduced.

Related Commands

show app-mon ipv4-flow-table Displays the flow table for IPv4 flows entries for enforcement and
monitor flows.
show app-mon ipv6-flow-table Displays the flow table for IPv6 flows entries for enforcement and
monitor flows.
show app-mon config Displays global AppMon configuration, which includes information like
admin-state, running mode, IP mode, aging-timer, and total signatures.

MIB Objects
alaAppMonEnforcementIpv4
alaAppMonEnforcementIpv6

page 37-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands app-mon l4-mode

app-mon l4-mode
Enables or disables monitoring and enforcement for TCP or UDP flows.
app-mon {port chassis/slot/port[-port2] | slot chassis/slot} l4-mode {tcp | udp} admin-state {enable |
disable}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis/slot The chassis ID and slot number (3/1) for a specific slot.
tcp Applies monitoring and enforcement to TCP flows.
udp Applies monitoring and enforcement to UDP flows.
enable Enables the specified L4 mode on the switch.
disable Disables the specified L4 mode on the switch.

Defaults
By default, both TCP and UDP flows are processed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> app-mon port 1/1/2 l4-mode udp admin-state disable
-> app-mon slot 1/1 l4-mode tcp admin-state enable
-> app-mon port 1/1/2 l4-mode udp admin-state enable

Release History
Release 8.2.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-15
app-mon l4-mode Application Monitoring and Enforcement Commands

Related Commands

app-mon l4port-exclude Configures the L4 port range to exclude from the AppMon operation.
show app-mon ipv4-flow-table Displays the flow table for IPv4 flows entries for enforcement and
monitor flows.
show app-mon ipv6-flow-table Displays the flow table for IPv6 flows entries for enforcement and
monitor flows.
show app-mon config Displays global AppMon configuration, which includes information like
admin-state, running mode, IP mode, aging-timer, and total signatures.

MIB Objects
alaAppMonPortConfigTable
alaAppMonPortConfigSlotPortIndex
alaAppMonEnforcementPortConfigTcpStatus
alaAppMonEnforcementPortConfigUdpStatus

page 37-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands app-mon l4port-exclude

app-mon l4port-exclude
Configures the L4 port range to exclude from the AppMon operation.
app-mon l4port-exclude range-id number {tcp-service-port | udp-port} start number end number
no app-mon l4port-exclude range-id

Syntax Definitions

range-id number The range ID number. The valid range is 1–8.

tcp-service-port Specifies TCP service ports.
udp-port Specifies UDP ports.
start number The first port associated with the range ID number. The valid port range
is 1–65535.
end number The last port associated with the range ID number. The valid port range
is 1–65535.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an L4 exclude range ID from the switch configuration.

• For the udp-port option, the AppMon operation is not performed on the flows with a source or
destination port that is in the excluded port range.
• For the tcp-service-port option, the AppMon operation is not performed on the flows with a
destination TCP port of TCP-SYN packet or a source TCP port of TCP-SYN-ACK packet that is in the
excluded port range.
• This configuration applies to both enforcement and monitor features.

Examples
-> app-mon l4port-exclude range-id 5 tcp-service-port start 20 end 30
-> app-mon l4port-exclude range-id 6 udp-port start 90 end 100
-> no app-mon l4port-exclude range-id 6

Release History
Release 8.2.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-17
app-mon l4port-exclude Application Monitoring and Enforcement Commands

Related Commands

show app-mon l4port-exclude Displays the port range excluded from AppMon operation.

MIB Objects
alaAppMonEnforcementL4PortRangeTable
alaAppMonEnforcementL4PortRangeStart
alaAppMonEnforcementL4PortRangeEnd
alaAppMonEnforcementL4PortType
alaAppMonEnforcementL4PortStatus

page 37-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands app-mon flow-table flush

app-mon flow-table flush

Clears all the learned flow-table entries for both IPv4 and IPv6 flow tables.
app-mon flow-table {enforcement | monitor} flush

Syntax Definitions

enforcement Flushes all the learned flow-table entries from the enforcement
application.
monitor Flushes all the learned flow-table entries from the monitor application.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When the enforcement option is used, all the active flows information are cleared; no QoS treatment is
provided (if configured). The data (active, gross counters, statistics, and flow information) in the
following commands are cleared: show app-mon app-list enforcement active, show app-mon app-
list enforcement active stats, show app-mon ipv4-flow-table enforcement, show app-mon ipv6-
flow-table enforcement, show app-mon stats.
• When the monitor option is used, all the learned flows information will be cleared. The data (gross
counters and flow information) in the following commands are cleared: show app-mon app-list
monitor active, show app-mon ipv4-flow-table monitor, show app-mon ipv6-flow-table monitor.
• When this command is used, application-record information is not cleared.

Examples
-> app-mon flow-table enforcement flush
-> app-mon flow-table monitor flush

Release History
Release 8.2.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-19
app-mon flow-table flush Application Monitoring and Enforcement Commands

Related Commands

show app-mon config Displays global AppMon configuration, which includes information like
admin-state, running mode, IP mode, aging-timer, and total signatures.
show app-mon app-list Displays a list of applications and application groups added to an
application list. ‘stats’ option in this command displays active or gross
packets/byte counters on per application basis.
show app-mon ipv4-flow-table Displays the flow table for IPv4 flows entries for enforcement and
monitor flows.
show app-mon ipv6-flow-table Displays the flow table for IPv6 flows entries for enforcement and
monitor flows.

MIB Objects
alaAppMonFlowTableFlush

page 37-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands app-mon flow-table enforcement stats

app-mon flow-table enforcement stats

Enable or disable flow table statistics update for enforcement applications.
app-mon flow-table enforcement stats admin-state {enable | disable}

Syntax Definitions

enable Enable flow-table statistics update.

disable Disable flow-table statistics update.

Defaults
By default, statistics admin status is disabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command is applicable only for enforcement applications.

• The statistics collection capability is shared with Service Manager, which means that either the Service
Manager feature or AppMon can use this capability at any given time. Hence, disabling the counter
usage in Service Manager using the service stats disable command is required to view the flow table
statistics update for enforcement applications. For more information about this command, see the
“Service Manager Commands” chapter in the OmniSwitch AOS Release 8 CLI Reference Guide.
• When update statistics is enabled, the updated statistics is displayed in the show app-mon ipv4-flow-
table enforcement verbose, show app-mon ipv6-flow-table enforcement verbose, and show app-
mon app-list enforcement active stats commands. Statistics are refreshed every 160 seconds from
data path, and based on the flow sync interval between the data path and the control path.

Examples
-> app-mon flow-table enforcement stats admin-state enable
-> app-mon flow-table enforcement stats admin-state disable

Release History
Release 8.2.1; command introduced.

Related Commands

show app-mon config Displays global AppMon configuration, which includes information like
admin-state, running mode, IP mode, aging-timer, and total signatures.

MIB Objects
alaAppMonEnforcementFlowTableStatsAdminStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-21
 app-mon aging enforcement Application Monitoring and Enforcement Commands

app-mon aging enforcement

Configures aging time for dynamically learned TCP/UDP flows for each application for Enforcement
applications.
app-mon aging enforcement app-name app_name [tcp | udp] interval {120m | 60m | 30m | 10m | 5m |
3m | default}

Syntax Definitions

app_name Name of the application to configure its aging interval. The application
must be part of the application pool.
interval The aging time interval for dynamically learned flows in the flow table,
in minutes.
default Configures the default aging interval.

Defaults
By default, aging interval is set per application and TCP or UDP flow type basis.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• User can set separate TCP or UDP flows aging interval for an given application.

• When TCP option is used to configure aging interval for an application, TCP flows generated by a
given application age out with configured value.
• When UDP option is used to configure aging interval for an application, UDP flows generated by a
given application age out with configured value.
• Flow aging is supported for the applications that are part of the enforcement application list. Flows
related with enforcement application list are made active for QoS treatment as well statistics collection.
• Flow aging is not supported for applications that are part of Monitor application list. Monitor flow
tables log these flows when they are detected until logging threshold is reached.

Examples
-> app-mon aging enforcement app-name sip tcp interval 60m
-> app-mon aging enforcement app-name tftp udp interval 120m

Release History
Release 8.2.1; command introduced.

page 37-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands app-mon aging enforcement

Related Commands

show app-mon config Displays global AppMon configuration, which includes information like
admin-state, running mode, IP mode, aging-timer, and total signatures.
show app-mon aging Displays the aging interval for each application for enforcement feature.
enforcement

MIB Objects
alaAppMonEnforcementAgingTimerTable
alaAppMonEnforcementAgingTimerValue

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-23
app-mon logging-threshold Application Monitoring and Enforcement Commands

app-mon logging-threshold
Configures the threshold for the number of matched flows for enforcement and monitor applications.
app-mon logging-threshold {enforcement | monitor} num-of-flows {number | default}

Syntax Definitions

number Threshold value for the number of matched flows. The valid range is
1000–60000.
default Sets the threshold back to the default value of 20K.

Defaults
By default, 20000 flows are logged.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When the logging threshold value is set to ‘0’, flows are not logged to the log file.

• When used with enforcement option, it configures the threshold for the number of matched flows to be
saved on to the log file for enforcement applications.
• When used with monitor option, it configures the threshold for the number of matched flows to be
displayed in the monitor flow table commands.

Examples
-> app-mon logging-threshold monitor num-of-flows 10000
-> app-mon logging-threshold monitor num-of-flows default
-> app-mon logging-threshold enforcement num-of-flows 10000

Release History
Release 8.2.1; command introduced.

Related Commands

show app-mon config Displays global AppMon configuration, which includes information
about admin-state, running mode, IP mode, aging-timer, and total
signatures.

MIB Objects
alaAppMonThresholdNumberOfFlows

page 37-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands app-mon flow-sync enforcement interval

app-mon flow-sync enforcement interval

Configures the interval at which the enforcement flows information is refreshed.
app-mon flow-sync enforcement interval {number | default}

Syntax Definitions

number Flow sync interval at which the enforcement flows information is

refreshed. The valid range is 10–3600 seconds. The interval can be
configured only for the enforcement feature.
default Configures the default flow-sync interval.

Defaults
Default flow-sync interval is 60 seconds for enforcement.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The refreshed information is shown in the following show commands: show app-mon applist
enforcement active, show app-mon applist enforcement active stats, show app-mon ipv4-flow-table
enforcement, show app-mon stats.

Examples
-> app-mon flow-sync enforcement interval 10
-> app-mon flow-sync enforcement interval default

Release History
Release 8.2.1; command introduced.

Related Commands

show app-mon ipv4-flow-table Displays the flow table for IPv4 flows entries.

show app-mon ipv6-flow-table Displays the flow table for IPv6 flows entries.

MIB Objects
alaAppMonFlowSyncEnforcementInterval

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-25
app-mon force-flow-sync Application Monitoring and Enforcement Commands

app-mon force-flow-sync
Synchronizes flows learned in the data path.
app-mon force-flow-sync {enforcement | monitor}

Syntax Definitions

enforcement Synchronizes flows learned in the data path for the enforcement feature
from the hardware.
monitor Synchronizes flows learned in the data path for the monitor feature from
the hardware.

Defaults
By default, flow synchronization occurs every 5 minutes for monitor flows and 60 seconds for
enforcement flows.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use this command to force a flow synchronization with the control path database in real time.

Examples
-> app-mon force-flow-sync enforcement
-> app-mon force-flow-sync monitor

Release History
Release 8.2.1; command introduced.

Related Commands

show app-mon ipv4-flow-table Displays the flow table for IPv4 flows entries.
show app-mon ipv6-flow-table Displays the flow table for IPv6 flows entries.

MIB Objects
alaAppMonForceFlowSyncStatus

page 37-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands show app-mon config

show app-mon config

Displays global AppMon configuration, which includes information about admin-state, running mode, IP
mode, aging-timer, and total signatures.
show app-mon config

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The operational state is enabled if there is at least one OmniSwitch 6860E chassis in the virtual chassis
(VC). If there is no OmniSwitch 6860E in the VC, the operational-state is disabled.

Examples
-> show app-mon config
Admin State : Enable,
Operational State : Enable,
L3-IPv4 : Enable,
L3-IPv6 : Enable,
Enforcement Flow-Table Stats : Enable,
Enforcement Flow-Sync Interval : 10 seconds,
Monitor Logging Threshold : 20000,
Enforcement Logging Threshold : 20000,
App-Pool Applications : 10,
Monitor Applied Applications : 10,
Enforcement Applied Applications : 10,
Upgraded Signature File Type : Factory,
AOS Compatible Signature Kit Version : 1,
Signature Kit version : 1.1.1

output definitions
Admin-state The AppMon administrative status (Enabled or Disabled).
Configured through the app-mon admin-state command.
Operational State The operational status (Enabled or Disabled).
L3-IPv4 Status of IPv4 l3 mode on the switch (Enable or Disable)
L3-IPv6 Status of IPv6 l3 mode on the switch (Enable or Disable)
Enforcement Flow-Table Stats Status of the enforcement flow table statistics update.
Enforcement Flow Sync interval Enforcement flow sync interval at which the switch polls for flow
information.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-27
show app-mon config Application Monitoring and Enforcement Commands

output definitions (continued)

Monitor Logging-Threshold Monitor threshold value for the flows to be saved in the IPv4 or IPv6
flow table.
Enforcement Logging-Threshold Enforcement threshold value for the flows to be saved on to the log
file.
App-Pool Applications The number of application signatures in the application pool.
Monitor Applied Applications The number of active applications in the Monitor application list.
Enforcement Applied The number of active applications in the enforcement application
Applications list.
Upgraded Signature File Type The signature file type: Factory or Production
AOS Compatible Signature Kit Determines the compatibility between AOS software and the
Version signature file.
Signature Kit version The signature file version that contains the application signatures.

Release History
Release 8.2.1; command introduced.

Related Commands

show app-mon port Displays AppMon status per physical port or per slot.

MIB Objects
alaAppMonAdminStatus
alaAppMonOperStatus
alaAppMonAgingInterval
alaAppMonAppliedApplications
alaAppMonAppPoolApplications
alaAppMonSignatureFileVersion
alaAppMonLoggingThreshold
alaAppMonKitCompatabilityVersion
alaAppMonAOSCompatabilityVersion
alaAppMonAutoGroupCreation

page 37-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands show app-mon port

show app-mon port

Displays AppMon status per physical port or per slot for the switch.
show app-mon [port chassis/slot/port | slot chassis/slot]

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis/slot The chassis ID and slot number (3/1) for a specific slot.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show app-mon port
Port Admin-Status Oper-Status L4-mode
----------+-------------+------------------+---------------
1/1/1 Enable Up TCP-UDP
1/1/2 Enable Up TCP-UDP
1/1/3 Enable Up TCP-UDP
1/1/4 Enable Up TCP-UDP
1/1/5 Enable Up TCP-UDP
1/1/6 Enable Up TCP-UDP
1/1/7 Enable Up TCP-UDP
.
.
.

-> show app-mon slot 1/1

Port Admin-Status Oper-Status L4-mode
----------+-------------+------------------+---------------
1/1/1 Enable Up TCP-UDP
1/1/2 Enable Up TCP-UDP
1/1/3 Enable Up TCP-UDP
1/1/4 Enable Up TCP-UDP
1/1/5 Enable Up TCP-UDP
1/1/6 Enable Up TCP-UDP
1/1/7 Enable Up TCP-UDP
1/1/8 Enable Up TCP-UDP
.
.
.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-29
show app-mon port Application Monitoring and Enforcement Commands

output definitions
Port The chassis identifier, slot, and port on which AppMon is enabled or
disabled.
Admin-Status Indicates the admin status of the port.
Oper-Status Indicates the operational status of the port.
L4-mode Indicates the L4 mode: TCP or UDP.

Release History
Release 8.2.1; command introduced.

Related Commands

show app-mon config Displays global AppMon configuration, which includes information like
admin-state, running mode, IP mode, aging-timer, and total signatures.

MIB Objects
alaAppMonPortConfigTable
alaAppMonPortConfigSlotPortIndex
alaAppMonPortConfigPortStatus
alaAppMonPortConfigPortOperStatus
alaAppMonPortConfigPortType

page 37-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands show app-mon app-pool

show app-mon app-pool

Displays all the applications that are part of an application pool.
show app-mon app-pool

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show app-mon app-pool
Legend: Application-name: *= Not present in recently updated kit,
AppId Application-name Revision Category
-------+--------------------------------+------------+----------------
968 amazon 1.0.0 Web
244 facebook 1.0.0 Web
182 sip 1.0.0 Audio/Video
183 skype 1.1.0 Instant Messaging
211 tftp 1.0.0 File Server
503 twitter 1.0.0 Web
597 viber 1.0.0 Audio/Video
890 webex 1.0.0 Audio/Video
1093 whatsapp 1.0.0 Instant Messaging
240 youtube 1.0.0 Web

----------------------------------
Number of Applications: 10

output definitions
AppId Identity of the application group.
Application-name Name of the application group whose details are viewed.
Note: * indicates that the application is not present in the recently
updated signature file.
Revision Application revision number.
Category Application category name.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-31
show app-mon app-pool Application Monitoring and Enforcement Commands

Release History
Release 8.2.1; command introduced.

Related Commands

show app-mon config Displays global AppMon configuration, which includes information like
admin-state, running mode, IP mode, aging-timer, and total signatures.

MIB Objects
alaAppMonAppPoolTable
alaAppMonAppPoolAppName
alaAppMonAppPoolCategory
alaAppMonAppPoolRevision
alaAppMonAppPoolAppStatus

page 37-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands show app-mon app-list

show app-mon app-list

Displays a list of applications and application groups added to an application list.
show app-mon app-list {monitor | enforcement} [active [stats]] [conflict]

Syntax Definitions

monitor Displays information for applications added for monitoring.

enforcement Displays information for applications added for enforcement.
active [stats] Displays the list of activated applications in an application list. Use the
stats option together with the enforcement option.
conflict Displays the list of applications that are present more than once in an
application list.

Defaults
By default, all applications and application groups that belong to an application list are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the conflict option to identify applications that are present more than once in an application list.
This needs to be checked and resolved for app-mon apply to be successful.
• The active option displays active and gross number of flows detected on per application basis.

• For monitor feature, active option displays only the gross counters.

• The stats option is used only for the enforcement option. This displays active or gross packets/byte
counters per application basis.

Examples
-> show app-mon app-list monitor
App-Id/ Application-List Application-List
AppGrp-Id Member Name Member Type
------------+------------------------------------------+---------------------
244 facebook APP
182 sip APP-GRP

output definitions
App-Id/AppGrp-Id Identity of the application or application group.
Application-List Member Name Name of the application group or application.
Application-List Member Type Specifies the application type: individual application or whether the
application belongs to any application group.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-33
show app-mon app-list Application Monitoring and Enforcement Commands

-> show app-mon app-list monitor active

Legend: Application-name: *= Not present in recently updated kit,

App-Id Application App-Grp Matched

Name Name Gross Count
-------+--------------------+-------------------------+-----------------
968 amazon APP 0
244 facebook APP 0
211 tftp APP-GRP 24508
Number of Applications: 3

output definitions
App-ID Identity of the application group.
Application Name Name of the application.
App-Grp Name Name of the application group.
Matched Gross Count Total number of matched active flows per application.
Number of Applications Total number of active applications in the application list.

-> show app-mon app-list monitor conflict

Sn App-ID Application-Name Application-Group Error-Type
----+-------+------------------------+---------------------+---------------
1 244 facebook APP Duplicate
2 244 facebook APP Duplicate

output definitions
Sn The serial number.
App-ID Identity of the application group.
Application-Name Name of the application.
Application-Group Name of the application group.
Error-Type Displays the type of error.

-> show app-mon app-list enforcement

Legend: Application-name: *= Not present in recently updated kit,
App-Id/ Application-List Application-List
AppGrp-Id Member Name Member Type
------------+-----------------------------------+---------------------------
244 facebook grp1

output definitions
App-Id/AppGrp-Id Identity of the application or application group
Application-List Member Name Name of the application group or application.
Note: * indicates that the application is not present in the
recently updated signature file.
Application-List Member Type Specifies the application type: individual application or whether the
application belongs to any application group.

page 37-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands show app-mon app-list

-> show app-mon app-list enforcement active

Legend: Application-name: *= Not present in recently updated kit,
App-Id Application App-Grp Matched Matched
Name Name Flow Count Gross Count
------+---------------------+-----------------------+-----------+------------
968 amazon grp1 0 0
182 sip grp1 0 0
211 tftp grp1 0 0
890 webex grp2 0 0
1093 whatsapp grp2 0 0
183 skype grp1 0 0
597 viber grp2 0 0
244 facebook grp1 7837 8192
503 twitter grp1 0 0
240 youtube grp2 0 0
Number of Applications: 10

output definitions
Application Name Name of the application.
Note: * indicates that the application is not present in the
recently updated signature file.
App-Id Identity of the application group.
App-Group Name Name of the application group.
Matched Flow Count Number of matched active flows per application.
Matched Gross Count Total number of matched flows per application.
Number of Applications Total number of active applications in the application list.

-> show app-mon app-list enforcement active stats

Legend: Application-name: *= Not present in recently updated kit,

App-Id Application App-Grp Matched Active Matched Active Matched Gross Matched Gross
Name Name Packet Count Byte Count Packet Count Byte Count
------+----------+--------+---------------+--------------+-------------+--------------
182 SIP grp1 1236 15236 1000 15000
211 TFTP grp1 2000 345678 3456 604569

output definitions
Application Name Name of the application.
Note: * indicates that the application is not present in the
recently updated signature file.
App-Id Identity of the application group.
App-Group Name Name of the application group.
Matched Active Packet Count Packet count of active matched flows.
Matched Active Byte Count Byte count of active matched flows
Matched Gross Packet Count Cumulative packet count of active matched flows and ended flows.
Matched Gross Byte Count Cumulative byte count of active matched flows and ended flows.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-35
show app-mon app-list Application Monitoring and Enforcement Commands

-> show app-mon app-list enforcement conflict

Sn App-ID Application-Name Application-Group Error-Type

----+-------+------------------------+---------------------+---------------
1 244 facebook grp1 Duplicate
2 244 facebook grp1 Duplicate

output definitions
Sn The serial number.
App-ID Identity of the application group.
Application-Name Name of the application.
Application-Group Name of the application group.
Error-Type Displays the type of error.

Release History
Release 8.2.1; command introduced.

Related Commands

show app-mon config Displays global AppMon configuration, which includes information like
admin-state, running mode, IP mode, aging-timer, and total signatures.
show app-mon app-group Displays the details of all the applications in an application group.

MIB Objects
alaAppMonActiveAppListTable
alaAppMonAppListMemberName
alaAppMonAppListMemberType
alaAppMonAppListMemberStatus
alaAppMonAppListAppId
alaAppMonAppListAppStatus
alaAppMonActiveAppListTable
alaAppMonActiveAppListAppName
alaAppMonActiveAppListAppGroupName
alaAppMonActiveAppListAppId
alaAppMonActiveAppListAppStatus
alaAppMonAppListConflictTable
alaAppMonAppListConflictIndex
alaAppMonAppListConflictAppName
alaAppMonAppListConflictAppId
alaAppMonAppListConflictAppGroupName
alaAppMonAppListConflictErrorType
alaAppMonEnforcementAppListTable
alaAppMonEnforcementAppListMemberName
alaAppMonEnforcementAppListAppOrGroupID
alaAppMonEnforcementAppListMemberType
alaAppMonEnforcementAppListAppStatus
alaAppMonEnforcementAppListMemberStatus

page 37-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands show app-mon app-list

alaAppMonEnforcementActiveAppListTable
alaAppMonEnforcementActiveAppListAppName
alaAppMonEnforcementActiveAppListAppGroupName
alaAppMonEnforcementActiveAppListActiveMatchedFlows
alaAppMonEnforcementActiveAppListTotalMatchedFlows
alaAppMonEnforcementActiveAppListAppID
alaAppMonEnforcementActiveAppListAppStatus
alaAppMonEnforcementActiveAppListActivePktCount
alaAppMonEnforcementActiveAppListActiveByteCount
alaAppMonEnforcementActiveAppListGrossPktCount
alaAppMonEnforcementActiveAppListGrossByteCount
alaAppMonEnforcementAppListConflictTable
alaAppMonEnforcementAppListConflictIndex
alaAppMonEnforcementAppListConflictAppID
alaAppMonEnforcementAppListConflictAppName
alaAppMonEnforcementAppListConflictAppGrpName
alaAppMonEnforcementAppListConflictAppErrorType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-37
show app-mon app-group Application Monitoring and Enforcement Commands

show app-mon app-group

Displays the details of all the applications in an application group.
show app-mon app-group [group-name group_name]

Syntax Definitions

group_name The name of an application group. This is a case sensitive string.

Defaults
By default, information is displayed for all application groups.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command displays both user created and automatically created application groups and the
applications added to the respective group.
• Application names which are added to group and not yet activated are also displayed.

• This also display the auto application groups.

Examples
-> show app-mon app-group
Legend: Application-name: *= Not present in recently updated kit,

AppGrp-Id App-group App-name

----------+---------------------------------------+--------------------------
AG-1 Web amazon
facebook
twitter
youtube
AG-2 Instant Messaging whatsapp
skype
AG-3 Audio/Video sip
viber
webex
AG-4 File Server tftp

output definitions
AppGrp-Id Identity of the application group.
App-group Name of the application group whose details are viewed.
App-name Name of the applications attached to the application group.

Release History
Release 8.2.1; command introduced.

page 37-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands show app-mon app-group

Related Commands

show app-mon config Displays global AppMon configuration, which includes information like
admin-state, running mode, IP mode, aging-timer, and total signatures.
show app-mon app-list Displays list of applications and application groups added to an
application list.

MIB Objects
alaAppMonAppGroupTable
alaAppMonAppGroupName
alaAppMonAppGroupMember
alaAppMonAppGroupCategoryName
alaAppMonAppGrpId
alaAppMonAppGroupAppStatus
alaAppMonAppGroupStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-39
show app-mon app-record Application Monitoring and Enforcement Commands

show app-mon app-record

Displays current-hour application-record information as well the historic application-records on the hourly
or 24-hours basis for monitored applications.
show app-mon app-record [hourly | twenty-four-hours | current-hour] [verbose]

Syntax Definitions

hourly Displays flows detected for an applications in an hour. An Hour is

defined with fixed boundary (for example, 1:30 p.m to 2:30 p.m).
twenty-four-hours Displays aggregate of available 'hourly' records for each application,
flows detected in last 24-hours since last hour boundary. 'current-hour'
data will not be part of this. This information is updated every one hour
when 'hourly' record is updated.
current-hour Displays new flow detected for an application in the current hour which
is not part of 'hourly' historic data. When current-hour reaches an hour
boundary, this data is moved to 'hourly' records. For example, if current
time is 2.40 p.m, then information between 2.30 p.m to 2.40 p.m is
displayed. On 3.30 p.m, current-hour information is moved to the latest
hourly record.
verbose Select this option to view detail information for each option. Detail
information include minimum, maximum and average flows detected
for each application.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This is supported for monitoring.

Examples
-> show app-mon app-record current-hour
Sampling Interval Every 5-minutes
Application Application group Total Detected Flows
--------------------------------+---------------------------+----------------------
2015-07-28 15:30:00 IST 0d 00h 48m 11s
sip grp1 11
youtube grp1 16572
--------------------------------
Number of Applications: 2

page 37-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands show app-mon app-record

-> show app-mon app-record hourly

Sampling Interval Every 5-minutes
Application Application group Total Detected Flows
------------------------+-----------------------------+------------------------
2015-07-28 13:30:00 IST 0d 01h 00m 00s
youtube grp1 21534
--------------------------------
--------------------------------
Number of Applications: 2
--------------------------------+--------------------------------------------------
2015-07-28 14:30:00 IST 0d 01h 00m 00s
facebook grp2 24

--------------------------------
--------------------------------
Number of Applications: 1
--------------------------------+--------------------------------------------------
Number of hourly App-Records: 2

-> show app-mon app-record hourly verbose

Sampling Interval Every 5-minutes
Application Application group Detected Flows
Min. Max. Avg. Total
-------------+--------------------+-----------+-----------+-----------+------------
2015-07-28 13:30:00 IST 0d 01h 00m 00s
facebook grp2 1 2 1 7
youtube grp1 1184 12600 7178 21534

--------------------------------
--------------------------------
Number of Applications: 2
--------------------------------+--------------------------------------------------
2015-07-28 14:30:00 IST 0d 01h 00m 00s
facebook grp2 1 1 1
4
--------------------------------
--------------------------------
Number of Applications: 1
--------------------------------+--------------------------------------------------
Number of hourly App-Records: 2

-> show app-mon app-record twenty-four-hours

Sampling Interval Every 5-minutes
2015-10-09 12:30:00 IST 1d 00h 00m 00s

Application Total Detected Flows (24-hours)

-----------------------------+------------------------------------------
skype 471
youtube 4239
facebook 102
twitter 2
viber 99
whatsapp 13
--------------------------------
Number of Applications: 6

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-41
show app-mon app-record Application Monitoring and Enforcement Commands

-> show app-mon app-record twenty-four-hours verbose

Sampling Interval Every 5-minutes
2015-10-09 12:30:00 IST 1d 00h 00m 00s

Application Detected Flows (24-hours)

Min. Max. Avg. Total
---------------------------+--------------+--------------+--------------+----------
skype 2 111 52 471
youtube 1 1200 529 4239
facebook 4 15 7 102
twitter 2 2 2 2
viber 1 35 9 99
whatsapp 1 4 1 13
--------------------------------
Number of Applications: 6

output definitions
Application Name of the application.
Application group Name of the application group.
Detected Flows Min: Minimum number of flows that were detected.
Max: Maximum number of flows that were detected.
Avg: Average number of flows that were detected.
Total: Total number of flows that were detected
Number of Applications Displays the total number of applications.

Release History
Release 8.2.1; command introduced.

Related Commands

show app-mon config Displays the global AppMon configuration.

MIB Objects
alaAppMonAppRecCurrentHrStatsTable
alaAppMonAppRecCurrentHrStatsName
alaAppMonAppRecCurrentHrStatsMinActiveFlow
alaAppMonAppRecCurrentHrStatsMaxActiveFlow
alaAppMonAppRecCurrentHrStatsAvgActiveFlow
alaAppMonAppRecCurrentHrStatsTotalFlow
alaAppMonAppRecHrlyStatsTable
alaAppMonAppRecHrlyStatsName
alaAppMonAppRecHrlyStatsMinActiveFlow
alaAppMonAppRecHrlyStatsMaxActiveFlow
alaAppMonAppRecHrlyStatsAvgActiveFlow
alaAppMonAppRecHrlyStatsTotalFlow
alaAppMonAppRec24HrStatsTable
alaAppMonAppRec24HrStatsName
alaAppMonAppRec24HrStatsMinActiveFlow
alaAppMonAppRec24HrStatsMaxActiveFlow
alaAppMonAppRec24HrStatsAvgActiveFlow
alaAppMonAppRec24HrStatsTotalFlow

page 37-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands show app-mon ipv4-flow-table

show app-mon ipv4-flow-table

Displays the flow table for IPv4 flows entries for enforcement and monitor flows.
show app-mon ipv4-flow-table {monitor | enforcement [verbose]} [{src-ipv4 | dest-ipv4} ip_address]
[app-name app_name | app-group grp_name]

Syntax Definitions

verbose Displays detailed information of the flows.

src-ipv4 ip_address Filter flow table based on the specified source IPv4 address.
dest-ipv4 ip_address Filter flow table based on the specified destination IPv4 address.
app_name Filter flow table based on application name.
grp_name Filter flow table based on application group.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The verbose option displays additional information about the flow start time, statistics counters,
associated application group, policy rule, and so on. This option is supported only for enforcement feature.

Examples
-> show app-mon ipv4-flow-table monitor
SrcIP DestIP SrcPort DestPort Proto App Name App Group
--------------+--------------+----------+-----------+---------+----------+---------
100.0.0.10 101.0.0.10 48128 3128 TCP facebook test
100.0.0.10 101.0.0.10 48384 3128 TCP facebook test
100.0.0.10 101.0.0.10 48640 3128 TCP facebook test
100.0.0.10 101.0.0.10 48896 3128 TCP facebook test
.
.
.

-> show app-mon ipv4-flow-table monitor src-ipv4 103.20.92.80

SrcIP DestIP sPort dPort Proto App Name App-Group Name
--------------+---------------+-------+-------+------+-------------+---------------
103.20.92.80 192.168.1.3 443 61069 TCP whatsapp test

Number of flows : 1

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-43
show app-mon ipv4-flow-table Application Monitoring and Enforcement Commands

-> show app-mon ipv4-flow-table monitor dest-ipv4 74.112.124.120

SrcIP DestIP sPort dPort Proto App Name App-Group Name
--------------+---------------+-------+-------+------+-------------+---------------
209.226.67.175 74.112.124.120 2458 9673 TCP whatsapp test

Number of flows : 1

-> show app-mon ipv4-flow-table monitor app-name youtube

SrcIP DestIP sPort dPort Proto App Name App-Group Name
--------------+---------------+-------+-------+------+-------------+---------------
207.219.97.56 74.125.225.0 1410 80 TCP youtube test

Number of flows : 1

output definitions
SrcIP Displays flow table based on the specified source IPv4 IP address.
DestIP Displays flow table based on the specified destination IPv4 IP address.
SrcPort Source port of the flow entry.
DestPort Destination port of the flow entry.
Proto Indicates the protocol type (TCP or UDP)
App Name Displays the flow table based on the application name.
App-Group Displays the flow table based on the application group.

-> show app-mon ipv4-flow-table enforcement

SrcIP DestIP SrcPort DestPort Proto App Name
--------------+-------------+-----------+-----------+---------+---------------
100.0.0.10 101.0.0.10 48128 3128 TCP facebook
100.0.0.10 101.0.0.10 48384 3128 TCP facebook
100.0.0.10 101.0.0.10 48640 3128 TCP facebook
100.0.0.10 101.0.0.10 48896 3128 TCP facebook
100.0.0.10 101.0.0.10 49152 3128 TCP facebook
100.0.0.10 101.0.0.10 49408 3128 TCP facebook
100.0.0.10 101.0.0.10 49664 3128 TCP facebook
100.0.0.10 101.0.0.10 49920 3128 TCP facebook
.
.
.

-> show app-mon ipv4-flow-table enforcement verbose

Legend: start/date/time/zone duration
SrcIp DestIP SrcPort DestPort Protocol Application-name App-group Policy rule Packet Count Byte Count,
----------------------------------------------------------------------------------
2015-07-24/15:01:34/IST 0d 0h 1m 42s
100.0.0.10 101.0.0.10 48128 3128 TCP facebook test app-mon1 0 0
2015-07-24/15:01:36/IST 0d 0h 1m 40s
100.0.0.10 101.0.0.10 48384 3128 TCP facebook test app-mon1 0 0
2015-07-24/15:01:38/IST 0d 0h 1m 38s
100.0.0.10 101.0.0.10 48640 3128 TCP facebook test app-mon1 0 0
2015-07-24/15:01:39/IST 0d 0h 1m 37s
100.0.0.10 101.0.0.10 48896 3128 TCP facebook test app-mon1 0 0
2015-07-24/15:01:41/IST 0d 0h 1m 35s
100.0.0.10 101.0.0.10 49152 3128 TCP facebook test app-mon1 0 0
2015-07-24/15:01:43/IST 0d 0h 1m 33s
100.0.0.10 101.0.0.10 49408 3128 TCP facebook test app-mon1 0 0
2015-07-24/15:01:45/IST 0d 0h 1m 31s.
.
.
.

page 37-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands show app-mon ipv4-flow-table

output definitions
SrcIP Source IPv4 address of the flow.
DestIP Destination IPv4 address of the flow.
SrcPort Source port of the flow entry.
DestPort Destination port of the flow entry.
Protocol Indicates the protocol type (TCP or UDP)
Application Name Name of the application.
App-group Name of the application group.
Policy rule The QoS policy applied for enforcement.
Packet Count Number of packet counts that match a flow table entry in the hardware.
Byte Count Number of byte counts that match a flow table entry in the hardware.

Release History
Release 8.2.1; command introduced.

Related Commands

show app-mon config Displays global AppMon configuration, which includes information like
admin-state, running mode, IP mode, aging-timer, and total signatures.

MIB Objects
alaAppMonFlowTable
alaAppMonFlowSourceIPType
alaAppMonFlowSourceIP
alaAppMonFlowDestIPType
alaAppMonFlowDestIP
alaAppMonFlowSrcPort
alaAppMonFlowDestPort
alaAppMonFlowProtocol
alaAppMonFlowAppName
alaAppMonEnforcementFlowTable
alaAppMonEnforcementFlowSourceIPType
alaAppMonEnforcementFlowSourceIP
alaAppMonEnforcementFlowDestIPType
alaAppMonEnforcementFlowDestIP
alaAppMonEnforcementFlowSrcPort
alaAppMonEnforcementFlowDestPort
alaAppMonEnforcementFlowProtocol
alaAppMonEnforcementFlowAppName
alaAppMonEnforcementFlowAppGrpName
alaAppMonEnforcementFlowPolicyRule
alaAppMonEnforcementFlowStartTime
alaAppMonEnforcementFlowPktCount
alaAppMonEnforcementFlowByteCount

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-45
show app-mon ipv6-flow-table Application Monitoring and Enforcement Commands

show app-mon ipv6-flow-table

Displays the flow table for IPv6 flows entries for enforcement and monitor flows.
show app-mon ipv6-flow-table {monitor | enforcement [verbose]} [{src-ipv6 | dest-ipv6} ip_address]
[app-name app_name | app-group grp_name]

Syntax Definitions

verbose Displays detailed information of the flows.

src-ipv6 ip_address Filter flow table based on the specified source IPv6 address.
dest-ipv6 ip_address Filter flow table based on the specified destination IPv6 address.
app_name Filter flow table based on application name.
grp_name Filter flow table based on application group.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The verbose option displays additional information about the flow start time, statistics counters, associated
application group, policy rule, and so on. This option is supported only for enforcement feature.

Examples
-> show app-mon ipv6-flow-table monitor
SrcIP DestIP SrcPort DstPort Proto App Name App-Group
--------------+------------+--------+-------+-------+-----------+---------------
1000::14 2000::11 58108 80 TCP youtube test
1000::14 2000::11 58364 80 TCP youtube test
1000::14 2000::11 57085 80 TCP youtube test
1000::14 2000::11 57341 80 TCP youtube test
1000::14 2000::11 57597 80 TCP youtube test
.
.
.

-> show app-mon ipv6-flow-table monitor src-ipv6 1000::11

SrcIP DestIP SrcPort DstPort Proto App Name App-Group
--------------+------------+--------+-------+-------+-----------+---------------
1000::14 2000::11 58108 80 TCP youtube test
1000::14 2000::11 58364 80 TCP youtube test
1000::14 2000::11 57085 80 TCP youtube test
1000::14 2000::11 57341 80 TCP youtube test
1000::14 2000::11 57597 80 TCP youtube test
Number of flows : 5

page 37-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands show app-mon ipv6-flow-table

-> show app-mon ipv6-flow-table monitor dest-ipv6 2000::11

SrcIP DestIP SrcPort DstPort Proto App Name App-Group
--------------+------------+--------+-------+-------+-----------+---------------
1000::14 2000::11 58108 80 TCP youtube test
1000::14 2000::11 58364 80 TCP youtube test
1000::14 2000::11 57085 80 TCP youtube test
1000::14 2000::11 57341 80 TCP youtube test
1000::14 2000::11 57597 80 TCP youtube test
Number of flows : 5

-> show app-mon ipv6-flow-table monitor app-group test

SrcIP DestIP SrcPort DstPort Proto App Name App-Group
--------------+------------+--------+-------+-------+-----------+---------------
1000::14 2000::11 58108 80 TCP youtube test
1000::14 2000::11 58364 80 TCP youtube test
1000::14 2000::11 57085 80 TCP youtube test
1000::14 2000::11 57341 80 TCP youtube test
1000::14 2000::11 57597 80 TCP youtube test
Number of flows : 5

output definitions
SrcIP Displays flow table based on the specified source IPv6 IP address.
DestIP Displays flow table based on the specified destination IPv6 IP address.
SrcPort Displays the flow table based on the source port.
DstPort Displays the flow table based on the destination port.
Proto Displays the flow table based on the protocol type.
App Name Displays the flow table based on the application name.
App-Group Displays the flow table based on the application group.

-> show app-mon ipv6-flow-table enforcement

Src IP Dest IP App Name
---------------------+-----------------------------+---------------------
1000::14 2000::11 youtube
1000::14 2000::11 youtube
1000::14 2000::11 youtube
1000::14 2000::11 youtube
1000::14 2000::11 youtube
1000::14 2000::11 youtube
.
.
.

-> show app-mon ipv6-flow-table enforcement src-ipv6 1000::14

Src IP Dest IP App Name
---------------------+-----------------------------+---------------------
1000::14 2000::11 youtube
1000::14 2000::11 youtube
1000::14 2000::11 youtube
1000::14 2000::11 youtube
1000::14 2000::11 youtube
1000::14 2000::11 youtube

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-47
show app-mon ipv6-flow-table Application Monitoring and Enforcement Commands

-> show app-mon ipv6-flow-table enforcement verbose

Legend: start/date/time/zone duration
SrcIp DestIP SrcPort DestPort Protocol Application-name App-group Policy Rule Packet Count Byte Count
---------------------------------------------------------------------------------------------------------------
2015-10-11/16:48:55/IST 0d 0h 3m 0s
1000::11 2000::11 61184 80 TCP youtube - appmon-youtube 61 47437
2015-10-11/16:48:56/IST 0d 0h 2m 59s
1000::11 2000::11 61185 80 TCP youtube - appmon-youtube 31 23696
2015-10-11/16:48:57/IST 0d 0h 2m 58s
1000::11 2000::11 61186 80 TCP youtube - appmon-youtube 4 1430
2015-10-11/16:48:58/IST 0d 0h 2m 57s
1000::11 2000::11 61187 80 TCP youtube - appmon-youtube 61 47437
.
.
.

Release History
Release 8.2.1; command introduced.

Related Commands

show app-mon config Displays the global AppMon configuration, which includes information
about admin-state, running mode, IP mode, aging-timer, and total
signatures.

MIB Objects
alaAppMonFlowTable
alaAppMonFlowSourceIPType
alaAppMonFlowSourceIP
alaAppMonFlowDestIPType
alaAppMonFlowDestIP
alaAppMonFlowSrcPort
alaAppMonFlowDestPort
alaAppMonFlowProtocol
alaAppMonFlowAppName
alaAppMonEnforcementFlowTable
alaAppMonEnforcementFlowSourceIPType
alaAppMonEnforcementFlowSourceIP
alaAppMonEnforcementFlowDestIPType
alaAppMonEnforcementFlowDestIP
alaAppMonEnforcementFlowSrcPort
alaAppMonEnforcementFlowDestPort
alaAppMonEnforcementFlowProtocol
alaAppMonEnforcementFlowAppName
alaAppMonEnforcementFlowAppGrpName
alaAppMonEnforcementFlowPolicyRule
alaAppMonEnforcementFlowStartTime
alaAppMonEnforcementFlowPktCount
alaAppMonEnforcementFlowByteCount

page 37-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands show app-mon l4port-exclude

show app-mon l4port-exclude

Displays the port range excluded from AppMon operation.
show app-mon l4port-exclude range-id [number]

Syntax Definitions

number A range ID number. The valid range is 1–8.

Defaults
By default, information is displayed for all range ID numbers.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Enter a range ID number with this command to display information for a specific range.

Examples
-> show app-mon l4port-exclude range-id
Range-Id Start-port End-port Port-type
----------+-------------+---------------+----------
1 100 200 UDP-Port
2 20 25 TCP-Service-Port

-> show app-mon l4port-exclude range-id 1

Range-Id Start-port End-port Port-type
----------+-------------+---------------+----------
1 100 200 UDP-Port

output definitions
Range-Id The service port range ID.
Start-port The start port associated with the range ID.
End-port The end port associated with the range ID.
Port-type Indicates the port type (TCP or UDP)

Release History
Release 8.2.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-49
show app-mon l4port-exclude Application Monitoring and Enforcement Commands

Related Commands

app-mon l4port-exclude Configures the L4 port range to exclude from the AppMon operation.

MIB Objects
alaAppMonEnforcementL4PortRangeTable
alaAppMonEnforcementL4PortRangeID
alaAppMonEnforcementL4PortRangeStart
alaAppMonEnforcementL4PortRangeEnd
alaAppMonEnforcementL4PortType
alaAppMonEnforcementL4PortStatus

page 37-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands show app-mon stats

show app-mon stats

Displays the number of flow statistics.
show app-mon stats

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the app-mon flow-table enforcement flush command to clear the counters.

Examples
-> show app-mon stats
Chassis/ Total Enforcement Total Total TCP Total UDP
Slot Matched Flows Used Flows Overflow Flows Overflow Packets
--------+----------------+---------------+-----------------+----------------
1/1 8192 8192 1422 0
2/1 0 3 0 0
3/1 0 0 0 0
4/1 0 0 0 0
Total 8192 8195 1422 0

output definitions
Chassis/Slot The chassis ID and slot number.
Total Enforcement Matched Total number of active flows that matched to any active application
Flows signature for enforcement feature.
Total Used Flows Total number of active flows (including unmatched and enforcement
matched) on a given chassis/slot.
Each IPv4 flow takes one entry count, while each IPv6 flow takes two
entries for Total Used Flows count.
Total TCP Overflow Flows Total number of TCP flows missed to create flow entry in flow table
due to hash collision.
Total UDP Overflow Packets Cumulative number of UDP packets missed to create flow entry in flow
table due to hash collision.

Release History
Release 8.2.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-51
show app-mon stats Application Monitoring and Enforcement Commands

Related Commands

app-mon flow-table Enable or disable flow table statistics update for enforcement
enforcement stats applications.

MIB Objects
alaAppMonStatisticsTable
alaAppMonStatsSlotIndex
alaAppMonTotalEnforcementActiveFlows
alaAppMonTotalFlowTableInUseFlows
alaAppMonTCPOverflowFlows
alaAppMonUDPOverflowPackets

page 37-52 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands show app-mon aging enforcement

show app-mon aging enforcement

Displays the aging interval for each application for enforcement feature.
show app-mon aging enforcement [app_name]

Syntax Definitions

app_name The name of the application. This is a case sensitive string.

Defaults
By default, the aging time for all applications is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show app-mon aging enforcement
AppId Application-name TCP Aging-time/
UDP Aging-time(minutes)
------+--------------------------------------+-------------------------
968 amazon 6/1
244 facebook 6/1
182 sip 60/60
183 skype 6/1
211 tftp 15/15
503 twitter 6/1
597 viber 6/1
890 webex 6/1
1093 whatsapp 6/1
240 youtube 6/1

-> show app-mon aging enforcement app-name SIP

AppId Application-name TCP Aging-time/
UDP Aging-time(minutes)
------+--------------------------------------+-------------------------
182 sip 60/60

output definitions
AppId Identity of the application.
Application-name Name of the application.
TCP Aging-time/UDP Aging- Aging time configured for the application.
time (minutes)

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-53
show app-mon aging enforcement Application Monitoring and Enforcement Commands

Release History
Release 8.2.1; command introduced.

Related Commands

app-mon aging enforcement Configures the aging time for dynamically learned flows for each
application for enforcement feature.

MIB Objects
alaAppMonEnforcementAgingTimerTable
alaAppMonEnforcementAgingTimerAppName
alaAppMonEnforcementAgingTimerValue

page 37-54 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands show app-mon vc-topology

show app-mon vc-topology

Displays the AppMon virtual chassis topology.
show app-mon vc-topology

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Displays the topology of the available OmniSwitch 6860 and OmniSwitch 6860E chassis. This also
displays the connectivity between the chassis for flow classification.

Examples
-> show app-mon vc-topology
Chassis/ Node Designated
Slot Type Chassis/Slot
--------+----------------+----------------
1/1 OS6860 2/1
2/1 OS6860E 2/1
3/1 OS6860E 3/1

output definitions
Chassis/Slot The chassis ID and slot number.
Node Type Indicates the switch type.
Designated Chassis/Slot The chassis and slot of the switch.

Release History
Release 8.2.1; command introduced

Related Commands
N/A

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-55
show app-mon vc-topology Application Monitoring and Enforcement Commands

MIB Objects
alaAppMonVCTopologyTable
alaAppMonVCTopologyChassisIndex
alaAppMonVCTopologyChassisType
alaAppMonVCTopologyDesignatedChassisIndex

page 37-56 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Application Monitoring and Enforcement Commands clear app-mon app-list

clear app-mon app-list

Removes all applications from the enforcement or monitor application list.
clear app-mon app-list {monitor| enforcement}

Syntax Definitions

monitor Removes all applications from the monitor application list.

enforcement Removes all applications from the enforcement application list.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command does not clear the active application list until the app-mon apply command is used.

Examples
-> clear app-mon app-list enforcement
-> clear app-mon app-list monitor

Release History
Release 8.2.1; command introduced.

Related Commands

app-mon app-list Add or remove applications or application groups to an application list

for enforcement or monitoring.

MIB Objects
alaAppMonClearAppList

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 37-57
clear app-mon app-list Application Monitoring and Enforcement Commands

page 37-58 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
38 Port Mapping Commands

Port Mapping is a security feature that controls communication between peer users. Each session
comprises of a session ID and a set of user ports and/or a set of network ports. The user ports within a
session cannot communicate with each other and can only communicate through network ports. In a port
mapping session with user port set A and network port set B, ports in set A can communicate with ports in
set B only. If set B is empty, the ports in set A can communicate with the rest of the ports in the system.
A port mapping session can be configured in a unidirectional or bidirectional mode. In the unidirectional
mode, the network ports can communicate with each other within the same session. In the bidirectional
mode, the network ports cannot communicate with each other. Network ports of a unidirectional port
mapping session can be shared with other unidirectional sessions, but cannot be shared with any session
that is configured in bidirectional mode. Network ports of different sessions can communicate with each
other.
MIB information for the Port Mapping commands is as follows:
Filename: AlcatelIND1PortMapping.mib
Module: ALCATEL-IND1-PORT-MAPPING
A summary of the available commands is listed here:

port-mapping user-port network-port

port-mapping (configures port mapping status)
port-mapping [unidirectional | bidirectional]
port-mapping unknown-unicast-flooding
show port-mapping status
show port-mapping

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 38-1
port-mapping user-port network-port Port Mapping Commands

port-mapping user-port network-port

Creates a port mapping session with the user ports, network ports, or both user ports and network ports.
Use the no form of the command to delete ports or a link aggregate group from a session.
port-mapping port_mapping_sessionid [user-port {slot chassis/slot | chassis//slot/port[-port2] | linkagg
linkagg_id}] [network-port {slot chassis/slot | chassis//slot/port[-port2] | linkagg linkagg_id}]
no port-mapping port_mapping_sessionid [user-port {slot chassis/slot | chassis//slot/port[-port2] | link-
agg linkagg_id}] [network-port {slot chassis/slot | chassis//slot/port[-port2] | linkagg linkagg_id}]

Syntax Definitions

port_mapping_sessionid The port mapping session ID.

user-port Specifies a user port of the mapping session.
network-port Specifies a network port of the mapping session.
slot Specifies that a slot is assigned to the mapping session.
chassis The chassis identifier.
slot Enter the slot number to be assigned to the mapping session.
port Enter the port number to be assigned to the mapping session.
port2 Last port number in a range of ports assigned to the mapping session.
linkagg Specifies that a link aggregation group is assigned to the mapping ses-
sion.
linkagg_id Enter a link aggregate ID number.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• User ports that are part of one session cannot communicate with each other. The user ports can commu-
nicate only through network ports of the session to the other elements of the system.
• User ports can be part of only one port mapping session.

• An aggregable port of a link aggregation group cannot be a mapped port and a mapped port cannot be
an aggregable port of a link aggregation group.
• A mirrored port cannot be a mapped port and a mapped port cannot be a mirrored port.

page 38-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Port Mapping Commands port-mapping user-port network-port

Examples
-> port-mapping 3 user-port 2/1/3 network-port 6/1/4
-> port-mapping 4 user-port 2/1/5-8
-> port-mapping 5 user-port 2/1/3 network-port slot 3
-> no port-mapping 5 user-port 2/1/3
-> no port-mapping 6 network-port linkagg 7

Release History
Release 8.1.1; command introduced.

Related Commands

port-mapping Enables, disables, or deletes a port mapping session.

port-mapping [unidirectional | Configures the direction of a port mapping session.
bidirectional]
port-mapping unknown- Enables or disables flooding of unknown unicast traffic from all ports to
unicast-flooding user ports for a particular session.
show port-mapping Displays the configuration of one or more port mapping sessions.

MIB Objects
PortMappingSessionTable
pmapSessionNumber
portMappingTable
pmapPortIfindex
pmapPortType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 38-3
port-mapping Port Mapping Commands

port-mapping
Enables, disables, or deletes a port mapping session.
port-mapping port_mapping_sessionid {enable | disable}
no port-mapping port_mapping_sessionid

Syntax Definitions

port_mapping_sessionid The port mapping session ID.

enable Enables a port mapping session.
disable Disables a port mapping session.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
To be enabled, a session should have a minimum of two ports.

Examples
-> port-mapping 3 enable
-> port-mapping 4 disable
-> no port-mapping 5

Release History
Release 8.1.1; command introduced.

page 38-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Port Mapping Commands port-mapping

Related Commands

port-mapping user-port Creates a port mapping session with or without the user ports, network
network-port ports, or both.
port-mapping [unidirectional | Configures the direction of a port mapping session.
bidirectional]
show port-mapping status Displays the status of one or more port mapping sessions.
show port-mapping Displays the configuration of one or more port mapping sessions.

MIB Objects
PortMappingSessionTable
pmapSessionNumber
pmapSessionStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 38-5
port-mapping [unidirectional | bidirectional] Port Mapping Commands

port-mapping [unidirectional | bidirectional]

Configures the direction of a port mapping session.
port-mapping port_mapping_sessionid [unidirectional | bidirectional]

Syntax Definitions

port_mapping_sessionid The port mapping session ID.

unidirectional Specifies unidirectional port mapping.
bidirectional Specifies bidirectional port mapping.

Defaults

parameter default
enable | disable enable
unidirectional | bidirectional bidirectional

Platform Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• In the bidirectional mode, the network ports of a session cannot communicate with each other. Also,
the network ports of that session cannot be a part of a network port set of another session.
• In the unidirectional mode, the network ports of a session can communicate with each other. Also, the
network ports of that session can be part of a network port set of another session that is in the unidirec-
tional mode.
• To change the directional mode of an active session with network ports, delete the network ports of the
session, change the direction, and recreate the network ports.

Examples
-> port-mapping 5 enable unidirectional
-> port-mapping 5 disable unidirectional
-> port-mapping 6 enable bidirectional
-> port-mapping 5 disable bidirectional

Release History
Release 8.1.1; command introduced.

page 38-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Port Mapping Commands port-mapping [unidirectional | bidirectional]

Related Commands

port-mapping user-port Creates a port mapping session with or without the user ports, network
network-port ports or both.
port-mapping Enables, disables, or deletes a port mapping session.
show port-mapping Displays the configuration of one or more port mapping sessions.

MIB Objects
PortMappingSessionTable
PmapSessionNumber
PmapSessionDirection

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 38-7
port-mapping unknown-unicast-flooding Port Mapping Commands

port-mapping unknown-unicast-flooding
Enables or disables flooding of unicast traffic from all the switch ports to the user ports related to a
particular session.
port-mapping session_id unknown-unicast-flooding {enable | disable}

Syntax Definitions

session_id Enter the port mapping session ID.

enable Enables the flooding of unknown unicast traffic from all ports to the
user ports for a particular session.
disable Disables the flooding of unknown unicast traffic from all ports to the
user ports for a particular session.

Defaults

parameter default
enable | disable enable

Platform Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Configuring unknown unicast flooding creates a new port mapping session if there is no existing
session.
• When a link aggregate is configured as a user port, the unknown unicast flooding configuration is
applied to all the member ports of the aggregate.

Examples
-> port-mapping 1 unknown-unicast-flooding enable
-> port-mapping 2 unknown-unicast-flooding disable

Release History
Release 8.1.1; command introduced.

page 38-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Port Mapping Commands port-mapping unknown-unicast-flooding

Related Commands

port-mapping user-port Creates a port mapping session with or without the user ports, network
network-port ports or both.
port-mapping Enables, disables, or deletes a port mapping session.
show port-mapping Displays the configuration of one or more port mapping sessions.
show port-mapping status Displays the status of one or more port mapping sessions.

MIB Objects
portMappingSessionTable
pmapSessionUnknownUnicastFloodStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 38-9
show port-mapping status Port Mapping Commands

show port-mapping status

Displays the status of one or more port mapping sessions.
show port-mapping [port_mapping_sessionid] status

Syntax definitions

port_mapping_sessionid The port mapping session ID.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If you do not specify the port mapping session ID, then the status of all the port mapping sessions are
displayed.

Examples
-> show port-mapping status

SessionID Direction Status Unknown Unicast

------------+-----------------+--------------+-----------------
1 bi enable drop
2 bi disable flood

output definitions
SessionID Displays the port mapping session ID.
Direction Displays the direction of a port mapping session.
Status Displays status of a port mapping session.

Release History
Release 8.1.1; command introduced.

page 38-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Port Mapping Commands show port-mapping status

Related Commands

port-mapping user-port Creates a port mapping session with or without the user ports, network
network-port ports, or both.
port-mapping Enables, disables, or deletes a port mapping session.

MIB Objects
PortMappingSessionTable
PmapSessionNumber
PmapSessionDirection
pmapSessionStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 38-11
show port-mapping Port Mapping Commands

show port-mapping
Displays the configuration of one or more port mapping sessions.
show port-mapping [port_mapping_sessionid]

Syntax Definitions

port_mapping_sessionid The port mapping session ID.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If you do not specify the port mapping session ID, then the user port and network port information are
displayed for all the port mapping sessions active on the switch.

Examples
-> show port-mapping 3

SessionID USR-PORT NETWORK-PORT

-----------+----------------+------------------
1 1/2 1/1/3
1 1/6
1 1/7

output definitions
SessionID Displays the port mapping session ID.
USR-PORT Displays the set of user ports of a port mapping session.
NETWORK-PORT Displays the set of network ports of a port mapping session.

Release History
Release 8.1.1; command introduced.

page 38-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Port Mapping Commands show port-mapping

Related Commands

port-mapping user-port Creates a port mapping session with or without the user ports, network
network-port ports, or both.
port-mapping Enables, disables, or deletes a port mapping session.

MIB Objects
PortMappingSessionTable
PmapSessionNumber
PortMappingTable
pmapPortIfindex
pmapPortType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 38-13
show port-mapping Port Mapping Commands

page 38-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 39 Learned Port Security
Commands

Learned Port Security (LPS) provides a mechanism for controlling network device communication on one
or more switch ports. Configurable LPS parameters allow the user to restrict source learning on a port to:
• A maximum number of learned source MAC addresses.

• A specific amount of time in which source MAC addresses are learned.

• An individual learned source MAC address.

• A range of learned source MAC addresses.

This chapter includes descriptions of the CLI commands used to define LPS parameters and display
information about the current LPS configuration.
MIB information for Learned Port Security commands is as follows:
Filename: ALCATEL-IND1-LPS-MIB
Module: alcatelIND1LearnedPortSecurityMIB
A summary of the available commands is listed here:

port-security
port-security learning-window
port-security convert-to-static
port-security maximum
port-security port max-filtering
port-security mac-range
port-security port violation
port-security learn-trap-threshold
show port-security
show port-security brief
show port-security learning-window

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 39-1
port-security Learned Port Security Commands

port-security
Enables or disables Learned Port Security (LPS) on the switch port(s). When LPS is enabled, only devices
that have a source MAC address that complies with LPS restrictions are learned on the port(s).
port-security {port chassis/slot/port[-port2] | chassis} [admin-state {enable | disable | locked}]
no port-security port chassis/slot/port[-port2]

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
enable Administratively enables LPS on the specified port(s).
disable Administratively disables LPS on the specified port(s). All bridged and
filtered MAC addresses are cleared, but the static MAC address and
LPS configuration for the port is retained. Learning is unrestricted.
locked Administratively disables all learning on the port. Existing MAC
addresses are retained but no additional learning of addresses, except for
static MAC addresses, is allowed.

Defaults
By default, LPS functionality is disabled on all ports.
The following default value applies if the admin-state parameter is not specified with this
command:

parameter default
admin-state enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the LPS configuration from the specified port and clear all
MAC addresses learned on the port. Note that the chassis parameter is not supported when using the no
form of this command.
• The admin-state disable option disables LPS on the port but does not clear the LPS configuration.

• Use the chassis parameter to administratively disable or enable all active LPS ports with one
command. This option does not apply to ports on which LPS was not previously enabled.
• LPS is supported on Ethernet fixed and 802.1Q-tagged ports. However, LPS is not supported on ports
that are configured as service access ports.
• LPS is not supported on link aggregates, 802.1Q tagged (trunked) link aggregates, or link aggregate
member ports.

page 39-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Learned Port Security Commands port-security

• Note that when LPS is enabled on an active port, all MAC addresses previously learned on that port are
cleared from the source learning MAC address table.
• LPS is also supported on ports that have Universal Network Profile (UNP) functionality enabled, with
the following conditions:
– When LPS is enabled or disabled on a UNP edge or bridge port (LPS is not supported on UNP
access ports), MAC addresses already learned on that port are flushed.
– UNP authentication and classification is applied first, then LPS rules.
– If UNP classifies a MAC address as forwarding but LPS learns the address as filtering, an untagged
packet will show as filtering in the default VLAN for the port and a tagged packet MAC will show
as filtering in the specific tagged VLAN.
– When a MAC address is filtered by LPS, the show unp edge-user command will display “LPS-B”
as the classification source for that MAC address.
• LPS allows for the configuration of the following source MAC address learning restrictions:
– A source learning time limit window to specify the length of time learning is allowed on a port.
– A maximum number of bridged and filtered MAC addresses allowed on a specific port
– A list of MAC addresses (individual or range of addresses) allowed on a port.
– How a port handles traffic that is unauthorized.

Examples
-> port-security port 4/1/8 admin-state enable
-> port-security port 2/1/1-10 admin-state enable
-> port-security chassis admin-state disable
-> no port-security port 1/1/1-12

Release History
Release 8.1.1; command introduced.

Related Commands

port-security mac-range Configures a list of authorized MAC addresses by defining a range of

addresses allowed on the port.
port-security maximum Specifies the maximum number of source MAC addresses that an LPS
port(s) is allowed to learn.
port-security learning-window Configures the amount of time, in minutes, to allow source learning on
all LPS ports.
port-security port violation Selects the method for handling traffic that does not comply with LPS
restrictions for the specified port(s).

MIB Objects
learnedPortSecurityTable
lpsAdminStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 39-3
port-security learning-window Learned Port Security Commands

port-security learning-window
Configures the amount of time, in minutes, to allow source learning on all LPS ports. This LPS parameter
applies to the entire switch, so when the time limit expires, source learning of new MAC addresses is
stopped on all LPS ports. Only authorized MAC addresses are allowed to be associated on LPS ports after
this timer expires. This command also enables or disables the conversion of dynamic MAC addresses to
static MAC addresses on LPS ports.
port-security learning-window minutes [convert-to-static {enable | disable}] [no-aging {enable |
disable}] [learn-as-static {enable | disable}] [mac-move {enable | disable}] [boot-up {enable | disable}]
no port-security learning-window

Syntax Definitions

minutes The number of minutes during which LPS allows source learning across
all LPS ports. This amount of time defines the LPS learning window.
The valid range is 0–2880. When this value is set to zero, the learning
window time is set to infinity (no source learning time restriction on
LPS ports).
convert-to-static enable Enables the convert-to-static option for the learning window.
Dynamically learned bridged (not filtered) MAC addresses are
automatically converted to static addresses when the learning window
closes. This option is automatically disabled when the LPS learning
window is set to infinity (zero).
convert-to-static disable Disables the convert-to-static option for the learning window.
Dynamically learned MAC addresses are not converted to static
addresses and will start to age out when the learning window closes.
no-aging enable Enables the no-aging option for the learning window. Dynamic bridged
MAC addresses are learned as pseudo-static MACs, which do not age
out but are not saved in the switch configuration.
no-aging disable Disables the no-aging option for the learning window. MAC addresses
are learned as dynamic addresses that will age out.
learn-as-static enable Enables the learn-as-static option for the learning window. Bridged
MAC addresses are learned as static MAC addresses during the learning
window time and regardless of whether or not the convert-to-static
option is enabled.
learn-as-static disable Disables the learn-as-static option for the learning window. Learned
bridged MAC addresses are not converted to static until the window is
closed and the convert-to-static option is enabled.
mac-move enable Enables the mac-move option. Allows a pseudo-static MAC address to
move to a different port in the same VLAN without getting dropped.
Enabling the no-aging option is required to support the mac-move
option.
mac-move disable Disables the mac-move option. Frames from a duplicate pseudo-static
MAC address are dropped.

page 39-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Learned Port Security Commands port-security learning-window

boot-up enable Enables the automatic start of the LPS learning window timer when the
switch restarts.
boot-up disable Disables the automatic start of the LPS learning window timer when the
switch restarts.

Defaults
By default, the LPS source learning time limit is not set for the switch; the learning window defaults to
infinity (source learning is not limited to a specific time frame).

parameter default
convert-to-static disable
no-aging disable
learn-as-static disable
mac-move disable
boot-up enable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to clear the learning window time (no learning window time limit is
applied to the port).
• The LPS source learning time window is started and/or reset each time the port-security learning-
window command is issued or when the port-security learning-window boot-up option is enabled
and the switch restarts.
• Setting the LPS learning window time to 0 (zero) configures an infinite source learning time period for
all LPS ports. The learning of MAC addresses on LPS ports never times out.
• When the LPS learning window time is set to zero, all options except the convert-to-static option are
still valid. For example, the no-aging option setting still applies.
• After the LPS learning window time expires, MAC addresses are learned as filtered addresses until the
maximum number of filtered MAC addresses allowed for the LPS port is reached. For example, if the
maximum number of bridged MAC addresses allowed is set to 30 and the learning window expires
when the port has only learned 15, the port is still allowed to learn an additional 15 filtered MAC
addresses.
• If the no-aging option is enabled, then all new bridged MAC addresses are learned as pseudo-static
MAC addresses during the learning window time period. Pseudo-static addresses do not age out but are
not saved to the switch configuration.
• When the no-aging option is enabled and the learning window starts, any MAC addresses that were
learned prior to the learning window time period are retained as dynamic addresses; they are not
converted to pseudo-static MAC addresses.
• Enabling the mac-move option is not allowed unless the no-aging option is also enabled. When the
mac-move option is enabled, disabling the no-aging option is not allowed.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 39-5
port-security learning-window Learned Port Security Commands

• If the convert-to-static option is enabled, then all dynamic bridged and pseudo-static MAC addresses
are converted to static MAC addresses when the learning window closes. Static MAC addresses do not
age out and are saved to the switch configuration.

Note. When UNP is enabled on any one LPS port, the convert-to-static, no-aging, and boot-up
parameter options are not supported on all LPS-enabled ports. This is because the learning window
configuration is global and applies to all LPS ports.

Examples
-> port-security learning-window 25
-> port-security learning-window 2 convert-to-static enable
-> port-security learning-window 60 no-aging enable mac-move enable
-> port-security learning-window 0 learn-as-static enable
-> port-security learning-window 500 boot-up disable
-> port-security learning-window 2 convert-to-static enable no-aging enable
-> port-security learning-window 2 no-aging enable convert-to-static enable boot-up
enable learn-as-static enable mac-move enable
-> no port-security learning-window

Release History
Release 8.1.1; command introduced.
Release 8.2.1; learn-as-static and mac-move parameters added.

Related Commands

port-security Enables or disables Learned Port Security (LPS) on the switch port(s).
port-security maximum Specifies the maximum number of source MAC addresses that an LPS
port(s) is allowed to learn.
port-security port max- Configures the maximum number of MAC addresses that can be filtered
filtering on the LPS port.
port-security port violation Selects the method for handling traffic that does not comply with LPS
restrictions for the specified port.
show port-security learning- Displays the source learning window configuration.
window

MIB Objects
learnedPortSecurityGlobalGroup
lpsLearningWindowTime
lpsLearningWindowTimeWithStaticConversion
lpsLearningWindowNoAging
lpsLearningWindowBootupStatus
lpsLearningWindowLearnAsStatic,
lpsLearningWindowPseudoMacMove

page 39-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Learned Port Security Commands port-security convert-to-static

port-security convert-to-static
Converts all MAC addresses dynamically learned on the LPS port(s) to static MAC addresses. This
command does not apply to MAC addresses that are filtered.
port-security {port chassis/slot/port[-port2] | chassis} convert-to-static

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
chassis Specifies all the LPS ports on the chassis.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Converting dynamic MAC addresses to static MAC addresses is not supported on Universal Network
Profile (UNP) ports.
• You can stop the aging out of dynamic MAC addresses on the LPS port(s) by converting them to static
MAC addresses.
• The number of converted static MAC addresses cannot exceed the maximum number of MAC
addresses allowed on the port(s).

Note. The port-security convert-to-static command is not supported on Universal Network Profile
(UNP) ports.

Examples
-> port-security port 4/1/8 convert-to-static
-> port-security chassis convert-to-static

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 39-7
port-security convert-to-static Learned Port Security Commands

Related Commands

port-security Enables or disables Learned Port Security (LPS) on the switch port(s).
port-security maximum Specifies the maximum number of source MAC addresses that an LPS
port(s) is allowed to learn.

MIB Objects
learnedPortSecurityGlobalGroup
lpsConvertToStatic

page 39-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Learned Port Security Commands port-security maximum

port-security maximum
Specifies the maximum number of bridged MAC addresses that an LPS port(s) is allowed to learn.
port-security {port chassis/slot/port[-port2]} maximum number

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
number The number of source MAC addresses that are allowed on this port. The
valid range is 1–1000.

Defaults
By default, the number of MAC addresses allowed is set to 1.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Any additional source MAC addresses received that exceed the maximum number of bridged addresses
allowed are filtered on the port, regardless of the LPS learning window time limit. Once the number of
filtered MAC addresses reaches the maximum number of filtered addresses allowed, the port violation
mode is applied.
• Note that source learning of configured authorized MAC addresses is still allowed after the LPS time
limit has expired; however, all learning is stopped if the number of MAC addresses learned meets or
exceeds the maximum number of addresses allowed, even if the LPS time limit has not expired.

Examples
-> port-security 2/1/14 maximum 25
-> port-security 4/1/10-15 maximum 100

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 39-9
port-security maximum Learned Port Security Commands

Related Commands

port-security Enables or disables Learned Port Security (LPS) on the switch port(s).
port-security learning-window Configures the amount of time in minutes to allow source learning on all
LPS ports.
port-security learn-trap- Configures the number of bridged MAC addresses to learn before
threshold sending a SNMP trap.
port-security port violation Selects the method for handling traffic that does not comply with LPS
restrictions for the specified port.

MIB Objects
learnedPortSecurityTable
lpsMaxMacNum

page 39-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Learned Port Security Commands port-security learn-trap-threshold

port-security learn-trap-threshold
Configures the number of bridged MAC addresses to learn before sending a SNMP trap.
port-security {port chassis/slot/port[-port2]} learn-trap-threshold number

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
number The number of bridged MAC addresses to learn before sending a trap.
The valid range is 0–1000.

Defaults
By default, the number of bridged MAC addresses to learn before sending a trap is set to the same value as
the maximum number of bridged MAC addresses allowed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When the number of bridged MAC addresses learned on the port matches the specified threshold
amount, a trap is sent for every bridged MAC address learned thereafter.
• Sending a trap when this threshold is reached provides notification of newly learned bridged MAC
addresses. Trap contents includes identifying information about the MAC, such as the address itself,
the corresponding IP address, switch identification, and the slot and port number on which the MAC
was learned.
• If this threshold value is set to zero, a trap is sent for every MAC address learned on the LPS port.

Examples
-> port-security port 1/1/10 learn-trap-threshold 6
-> port-security port 1/1/10-13 learn-trap-threshold 18

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 39-11
port-security learn-trap-threshold Learned Port Security Commands

Related Commands

port-security maximum Configures the maximum number of source MAC addresses that an LPS
port is allowed to learn.
show port-security Displays Learned Port Security (LPS) configuration and table entries.

MIB Objects
learnedPortSecurityTable
lpsLearnTrapThreshold

page 39-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Learned Port Security Commands port-security port max-filtering

port-security port max-filtering

Configures the maximum number of MAC addresses that can be filtered on the LPS port(s).
port-security port chassis/slot/port[-port2] max-filtering number

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
number The maximum number of filtered MAC addresses that are allowed on
this port. The valid range is 0–100.

Defaults
By default, the maximum number of MAC addresses that can be filtered on an LPS port is 5.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When the number of filtered MAC addresses learned on the port reaches the maximum, the violation
mode (restrict, discard, or shutdown) configured for the port is applied.
• Any additional source MAC addresses received that exceed the maximum number of bridged addresses
allowed are filtered on the port, regardless of the LPS learning window time limit. Once the number of
filtered MAC addresses reaches the maximum number of filtered addresses allowed, the port violation
mode is applied.
• Even after the LPS learning window time expires, MAC addresses are learned as filtered addresses
until the maximum number of filtered MAC addresses allowed for the LPS port is reached. For exam-
ple, if the maximum number of MAC addresses allowed is set to 30 and the learning window expires
when the port has only learned 15, the port is still allowed to learn an additional 15 filtered MAC
addresses.

Examples
-> port-security 1/1/10 max-filtering 6
-> port-security 1/1/10-13 max-filtering 18

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 39-13
port-security port max-filtering Learned Port Security Commands

Related Commands

port-security maximum Specifies the maximum number of source MAC addresses that an LPS
port(s) is allowed to learn.
port-security learning-window Configures the amount of time in minutes to allow source learning on all
LPS ports.
port-security port violation Selects the method for handling traffic that does not comply with LPS
restrictions for the specified port.
show port-security Displays Learned Port Security (LPS) configuration and table entries.

MIB Objects
learnedPortSecurityTable
lpsMaxFilteredMacNum

page 39-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Learned Port Security Commands port-security mac-range

port-security mac-range
Configures a list of authorized MAC addresses by defining a range of addresses allowed on the port. This
command also enables LPS on the specified port, if LPS is not already active on the port.
port-security {port chassis/slot/port[-port2]} mac-range [low mac_address | high mac_address]

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
low mac_address MAC address that defines the low end of a range of MACs (for
example, 00:20:95:00:10:2A).
high mac_address MAC address that defines the high end of a range of MACs (for
example, 00:20:95:00:10:2F).

Defaults

parameter default
high mac_address ff:ff:ff:ff:ff:ff
low mac_address 00:00:00:00:00:00

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If low and high end MAC addresses are not specified with this command, then the range is set back to
the default range value (00:00:00:00:00:00– ff:ff:ff:ff:ff:ff).
• Source MAC addresses received on an LPS port that fall within the authorized range are allowed on
the port. An additional entry is made in the LPS table for each of these learned addresses.
• Any additional source MAC addresses received that do not match the configured authorized addresses
are not allowed (filtered) on the port, regardless of the LPS learning window time limit or the maxi-
mum number of bridged addresses allowed. Once the number of filtered MAC addresses reaches the
maximum number of filtered addresses allowed, the port violation mode is applied.

Examples
-> port-security port 4/1/20 mac-range low 00:20:95:00:fa:5c
-> port-security port 5/1/11-15 mac-range low 00:da:95:00:00:10 high
00:da:95:00:00:1f
-> port-security port 5/1/16-20 mac-range high 00:da:95:00:00:1f
-> port-security port 5/1/11-15 mac-range

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 39-15
port-security mac-range Learned Port Security Commands

Related Commands

port-security Enables or disables Learned Port Security (LPS) on the switch port(s).
port-security learning-window Configures the amount of time in minutes to allow source learning on all
LPS ports.
port-security maximum Specifies the maximum number of source MAC addresses that an LPS
port(s) is allowed to learn.
port-security port max- Configures the maximum number of MAC addresses that can be filtered
filtering on the LPS port.
port-security port violation Selects the method for handling traffic that does not comply with LPS
restrictions for the specified port.
show port-security Displays Learned Port Security (LPS) configuration and table entries.

MIB Objects
learnedPortSecurityTable
lpsLoMacRange
lpsHiMacRange
lpsRowStatus

page 39-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Learned Port Security Commands port-security port violation

port-security port violation

Selects the method for handling traffic that does not comply with LPS restrictions for the specified port(s).
port-security port chassis/slot/port[-port2] violation {shutdown | restrict | discard}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
shutdown The port is administratively disabled when the port receives
unauthorized traffic. No further traffic is allowed on the port.
restrict Disables learning on the port when unauthorized traffic is received or
the configured maximum number of MAC addresses is reached.
discard Discards unauthorized traffic but allows traffic that complies with LPS
restrictions to forward on the port. The port remains administratively
enabled.

Defaults
By default, the security violation mode is set to restrict when LPS is enabled on the port.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When a traffic violation occurs on an LPS port, a notice is sent to the switch log.

• If the violation mode is set to restrict, unauthorized source MAC addresses are not learned in the LPS
table, but they are recorded in the source learning MAC address table with a filtered operational status.
This allows the user to view MAC addresses attempting unauthorized access to the LPS port.

Examples
-> port-security port 2/1/14 violation restrict
-> port-security port 4/1/10-15 violation shutdown
-> port-security port 1/1/37 violation discard

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 39-17
port-security port violation Learned Port Security Commands

Related Commands

port-security Enables or disables Learned Port Security (LPS) on the switch port(s).
interfaces wait-to-restore Clears all port violations; allows the port to resume normal operation
without a manual reset of the port or module.
show port-security Displays Learned Port Security (LPS) configuration and table entries.

MIB Objects
learnedPortSecurityTable
lpsViolationOption

page 39-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Learned Port Security Commands show port-security

show port-security
Displays Learned Port Security (LPS) configuration and table entries.
show port-security {port [chassis/slot/port[-port2] | slot chassis/slot]}

Syntax Definitions

chassis The chassis identifier.

slot/port[-port2] The slot and port number. Use a hyphen to specify a range of ports.
slot Enter the slot number for a module to specify that the command should
include all ports on that module (for example, 6 specifies all ports on the
module found in slot 6 of the switch chassis).

Defaults
By default, all ports with an LPS configuration are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Displays ports that have an LPS configuration, even if LPS is disabled on the port.

• Use the port parameter with this command to display the LPS configuration for a specific port or a
range of ports.
• Use the slot parameter with this command to display the LPS configuration for all the ports on a
specific slot.
• In addition, MAC addresses learned on the LPS enabled port that are within the specified MAC
address range appear as a separate entries in the LPS table as dynamic MAC type addresses.
• The MAC Type field is blank if an authorized MAC address range is configured for the LPS port.

Examples
-> show port-security port 1/1/1
Port: 1/1
Admin-State : ENABLED,
Operation Mode : ENABLED,
Max MAC bridged : 3,
Trap Threshold : 1,
Violation : RESTRICT
Max MAC filtered : 5,
Low MAC Range : 00:00:00:00:00:00,
High MAC Range : ff:ff:ff:ff:ff:ff,
Violating MAC : NULL

MAC VLAN MAC TYPE OPERATION

-------------------------+--------+-----------------+-----------------
00:11:22:22:22:21 1 STATIC bridging

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 39-19
show port-security Learned Port Security Commands

00:11:22:22:22:22 1 STATIC bridging

00:11:22:22:22:23 1 PSEUDO-STATIC bridging

output definitions
Port The module slot number and the physical port number on that module.
Admin-State The LPS administrative state for the port (Enabled, Disabled, or
Locked). Configured through the port-security command.
Operation Mode The LPS operational mode for the port (Enabled, Disabled,
Restricted, Shutdown, Discard, Locked, or Filtered-only).
Max MAC bridged The maximum number of bridged MAC addresses that are allowed on
this port. Configured through the port-security maximum command.
Trap Threshold The number of bridged MACs to learn before sending a trap. After this
number is reached, a trap is sent out for every MAC learned thereafter.
If disabled is displayed in this field, the trap threshold is not in force.
Configured through the port-security learn-trap-threshold command.
Violation The security violation mode for the port (restrict, shutdown, or
discard). Configured through the port-security port violation
command.
Max MAC filtered The maximum number of filtered MAC addresses that the LPS port can
learn. Configured through the port-security port max-filtering
command.
Low MAC Range MAC address that defines the lower end of a MAC address range.
Configured through the port-security mac-range command.
High MAC Range MAC address that defines the higher end of a MAC address range.
Configured through the port-security mac-range command.
Violating MAC The MAC Address that caused the violation on this port.
MAC The MAC address learned dynamically or configured statically on the
LPS port.
VLAN The VLAN to which the LPS port belongs.
MAC TYPE Indicates if the MAC address was dynamically learned or statically
configured as an authorized MAC address for the port.
OPERATION The operational status of the MAC address (bridging or filtering).

Release History
Release 8.1.1; command introduced.

Related Commands

show port-security learning- Displays the amount of time during which source learning can occur
window on all LPS ports.

page 39-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Learned Port Security Commands show port-security

MIB Objects
learnedPortSecurityTable
lpsAdminStatus
lpsOperStatus
lpsMaxMacNum
lpsLearnTrapThreshold
lpsViolationOption
lpsMaxFilteredMacNum
lpsLoMacRange
lpsHiMacRange
lpsViolatingMac
lpsRelease

learnedPortSecurityAgL2MacAddressTable
lpsAgL2MacAddress
lpsAgL2VlanId
lpsAgL2MacAddressLearnType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 39-21
show port-security brief Learned Port Security Commands

show port-security brief

Displays the LPS port configuration for all the LPS ports.
show port-security brief

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The LPS port parameter values are displayed even if the LPS is disabled on the port.

• The operation mode displayed for the LPS port is based on a combination of the existing admin status
and operational status of the port, the result of which is one of the following values:
– Enabled
– Restricted (only when admin status is enabled)
– Shutdown (only when admin status is enabled)
– Discard (only when admin status is enabled)
– Disabled
– Locked
– Filtered_only

Examples
-> show port-security brief

Slot/ Max Max Nb Macs Nb Macs Nb Macs Nb Macs

Port Operation Mode Bridge Filter Dyn Br Dyn Fltr Static Br Static Fltr
----+----------------+--------+--------+---------+---------+-----------+-----------
1/1/1 ENABLED 5 100 5 10 0 0
1/1/2 ENABLED 5 100 0 10 5 0
1/1/3 RESTRICTED 5 100 5 100 0 0
1/1/4 SHUTDOWN 5 100 - - - 0
1/1/5 DISABLED 5 100 - - - 0
1/1/6 LOCKED 5 100 - - 3 0

page 39-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Learned Port Security Commands show port-security brief

output definitions
Slot/Port The slot number for the module and the physical port number on that
module (e.g., 1/2 specifies port 2 on slot 1).
Operation Mode Displays the status of the LPS port.
Max Bridge The maximum number of bridged MAC addresses that are allowed on
the LPS port. Configured through the port-security maximum
command.
Max Filter The maximum number of filtered MAC addresses that the LPS port can
learn. Configured through the port-security port max-filtering
command.
Nb Macs Dyn Br Total number of bridged MAC addresses learned on the LPS port.
Nb Macs Dyn Fltr Total number of filtered MAC addresses learned on the LPS port.
Nb Macs Static Br Total number of bridged static MAC addresses (configured static and
MAC addresses learned as pseudo-static) on the LPS port.
Nb Macs Static Fltr Total number of filtered static MAC addresses configured on the LPS
port.

Release History
Release 8.1.1; command introduced.

Related Commands

show port-security Displays the LPS configuration and table entries for individual LPS
ports.

MIB Objects
learnedPortSecurityTable
lpsMaxMacNum
lpsMaxFilteredMacNum
lpsMaxStaticMacNum
lpsOperStatus
lpsAdminStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 39-23
show port-security learning-window Learned Port Security Commands

show port-security learning-window

Displays the source learning window configuration.
show port-security learning-window

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The source learning time limit is a switch-wide parameter that applies to all ports that have LPS
enabled.
• If the learning window time is not set, then no source learning time limit is applied to LPS ports.

• Even after the LPS learning window time expires, dynamic MAC addresses are learned as filtered
addresses until the maximum number of filtered MAC addresses allowed for the LPS port is reached.
For example, if the maximum number of bridged MAC addresses allowed is set to 30 and the learning
window expires when the port has only learned 15, the port is still allowed to learn an additional 15
filtered MAC addresses.

Examples
-> show port-security learning-window
Learning-Window = 2 min,
Convert-to-static = DISABLE,
No Aging = DISABLE,
Boot Up = ENABLE,
Remaining Learning Window = 120 sec
Learn As Static = ENABLE,
Mac Move = ENABLE,

output definitions
Learning-Window The configured amount of time during which the LPS port can learn
new MAC addresses.
Convert-to-static Indicates whether or not dynamic bridged or pseudo-static MACs are
converted to static MACs (enabled or disabled). This option is always
disabled when the LPS learning window is set to infinity (zero).
No Aging Indicates whether or not bridged MAC addresses are learned as pseudo-
static MAC addresses, which do not age out during the LPS learning
window time period (disabled or enabled).

page 39-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Learned Port Security Commands show port-security learning-window

output definitions
Boot Up Indicates whether or not the LPS learning window automatically starts
when the switch boots up (enabled or disabled).
Learn As Static Indicates whether or not dynamic MAC addresses are automatically
learned as static MAC addresses during the LPS learning window time
period.
Mac Move Indicates whether or not pseudo-static MAC addresses are allowed to
move to a different port in the same VLAN during the LPS learning
window time period.
Remaining Learning Window The remaining amount of time during which the LPS port can learn
MAC addresses. If the learning time window is set to INFINITY
(zero), this field does not display in the show command output.

Release History
Release 8.1.1; command introduced.

Related Commands

port-security learning-window Configures the learning window parameters that are applied to all
LPS ports.
show port-security Displays the LPS configuration and table entries for individual LPS
ports.

MIB Objects
learnedPortSecurityGlobalGroup
lpsLearningWindowTime
lpsLearningWindowTimeWithStaticConversion
lpsLearningWindowNoAging
lpsLearningWindowBootupStatus
lpsLearningWindowLearnAsStatic,
lpsLearningWindowPseudoMacMove
lpsLearningWindowTimeRemaining

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 39-25
show port-security learning-window Learned Port Security Commands

page 39-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 40 Port Mirroring and
Monitoring Commands

The Port Mirroring and Port Monitoring features are primarily used as diagnostic tools.
The Port Mirroring feature allows you to have all the inbound and outbound traffic of an Ethernet port sent
to another port on the switch. When you enable port mirroring, the active, or “mirrored,” port transmits
and receives network traffic normally and the “mirroring” port receives a copy of all transmit and receive
traffic to the active port. You can connect an RMON probe or network analysis device to the mirroring
port to see an exact duplication of traffic on the mirrored port without disrupting network traffic to and
from the mirrored port.
The Port Monitoring feature allows you to capture and examine the data traffic to and from a monitored
Ethernet port.
MIB information for the Port Mirroring commands is as follows:
Filename: AlcatelIND1portMirMon.mib
Module: ALCATEL-IND1-PORT-MIRRORING-MONITORING-MIB
The following table summarizes the available commands:

Port Mirroring Commands port-mirroring source destination

port-mirroring
show port-mirroring status
Port Monitoring Commands port-monitoring source
port-monitoring
show port-monitoring status
show port-monitoring file

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 40-1
port-mirroring source destination Port Mirroring and Monitoring Commands

port-mirroring source destination

Defines the port to mirror and the port that is to receive data from the mirrored port. Also, enables or
disables remote port mirroring.
port-mirroring port_mirror_sessionid source {chassis/slot/port[-port2] [chassis/slot/port[-port2]...]
destination chassis/slot/port [rpmir-vlan vlan_id] [bidirectional |inport |outport] [unblocked vlan_id]
[enable | disable]
port-mirroring port_mirror_sessionid no source {chassis/slot/port[-port2] [chassis/slot/port[-port2]...]

Syntax Definitions

port_mirror_sessionid Mirroring session identifier.

source Specifies source port, or range of ports desired to be mirrored.
no source Removes a port or range of ports from a port mirroring session.
destination Specifies the destination port, that receives all the mirrored packets.
chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
rpmir-vlan vlan_id Specifies a reserved VLAN to carry the mirroring traffic.
bidirectional Specifies bidirectional port mirroring.
inport Specifies incoming unidirectional port mirroring.
outport Specifies outgoing unidirectional port mirroring.
unblocked vlan_id Specifies the VLAN that is to be protected from Spanning Tree changes
when port mirroring is active. Ports in this VLAN remain unblocked.
enable Enables port mirroring status.
disable Disables port mirroring status.

Defaults

parameter default
bidirectional | inport | outport bidirectional
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• You can configure a port mirroring and a port monitoring session on the same network interface
module in an OmniSwitch 6860, 6860E.
• A mirroring port can not be assigned to a tagged VLAN port.

• When a port is configured as a mirroring port, it does not belong to any VLAN. Inbound traffic to the
mirroring port is dropped since it does not belong to any VLAN.

page 40-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Port Mirroring and Monitoring Commands port-mirroring source destination

• Spanning tree is disabled by default on a mirroring port.

• Port mirroring is not supported on logical link aggregate ports. However, it is supported on individual
ports that are members of a link aggregate.
• Execute the port mirroring source destination command to define the mirrored port and enable port
mirroring status. Use the port mirroring command to enable the port mirroring session.
• Specify the vlan_id number of the mirroring port that is to remain unblocked when the command is
executed. The unblocked VLAN becomes the default VLAN for the mirroring port. This VLAN
handles the inbound traffic for the mirroring port. Spanning tree remains disabled on the unblocked
VLAN.

Usage Guidelines - Remote Port Mirroring

• Remote port mirroring is supported only on OmniSwitch 6860, 6860E switches.

• Use the rpmir-vlan parameter and VLAN ID with this command to configure remote port mirroring
and to assign the VLAN ID for remote port mirroring.
• The VLAN ID assigned for remote port mirroring cannot be assigned to a general port mirroring port.

• There must not be any physical loop present in the remote port mirroring VLAN.

• Source learning must be disabled or overridden on the ports belonging to the remote port mirroring
VLAN on intermediate and destination switches.
• On OmniSwitch 6860, 6860E switches, the QoS redirect feature can be used to override source learn-
ing.
• The mac-learning command can also be used to disable learning on the RPMIR VLAN ID.

Examples
-> port-mirroring 6 source 2/1/2
-> port-mirroring 6 source 2/1/3-5
-> port-mirroring 6 destination 1/1/12 rpmir-vlan 7
-> port-mirroring 6 no source 2/1/2-5

-> port-mirroring 7 source 2/1/3 destination 6/1/4 unblocked 750

-> port-mirroring 8 source 1/1/7 bidirectional

-> port-mirroring 8 no source 1/1/7

-> port-mirroring 9 source 1/1/23 inport

-> port-mirroring 9 destination 1/1/24
-> port-mirroring 9 disable

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 40-3
port-mirroring source destination Port Mirroring and Monitoring Commands

Related Commands

port-mirroring Enables, disables, or deletes a port mirroring session.

show port-mirroring status Displays the status of mirrored ports. This value may be enabled or
disabled.

MIB Objects
mirrorTable
mirrorMirroringIfindex
mirrorDirection
mirrorStatus
mirrorUnblockedVLAN
mirrorRowStatus
mirrorDirection
mirrorSessOperStatus
mirrorTaggedVLAN

page 40-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Port Mirroring and Monitoring Commands port-mirroring

port-mirroring
Enables, disables, or deletes a port mirroring session.
port-mirroring port_mirror_sessionid {enable | disable}
no port-mirroring port_mirror_sessionid

Syntax Definitions

port_mirror_sessionid Mirroring session identifier.

enable Enables port mirroring.
disable Disables port mirroring.

Defaults

parameter default
enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete a port mirroring session.

• Use the port-mirroring source destination command to specify the mirrored ports and destination
port. before using this command to enable or disable port mirroring activity for the particular port
mirroring session.

Examples
-> port-mirroring 6 enable
-> port-mirroring 6 disable
-> no port-mirroring 6

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 40-5
port-mirroring Port Mirroring and Monitoring Commands

Related Commands

port-mirroring source Defines a port to mirror and the port that is to receive data from the
destination mirrored port, and enables or disables port mirroring status.
show port-mirroring status Displays the status of mirrored ports. This value may be enabled or
disabled.

MIB Objects
mirrorTable
mirrorMirroringIfindex
mirrorTaggedVLAN
mirrorStatus

page 40-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Port Mirroring and Monitoring Commands port-monitoring source

port-monitoring source
Configures a port monitoring session.
port-monitoring port_monitor_sessionid source chassis/slot/port [{no file | file filename [size filesize] |
[overwrite {on | off}]}] [inport | outport | bidirectional] [timeout seconds] [enable | disable] [capture-
type {full | brief}]

Syntax Definitions

port_monitor_sessionid Monitoring session identifier.

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
file filename Specifies a file name and pathname for capturing information related to
the monitoring session (for example, /flash/port2.enc).
filesize Specifies the size of the file in 64K byte increments. For example, a
value of 3 would specify a size of (3 x 64K) bytes.
overwrite on Specifies that capturing of data packets into the port monitoring file con-
tinues and old information is overwritten if the total data exceeds the
specified file size.
overwrite off Specifies that capturing of data packets into the port monitoring file is
stopped when the maximum file size is reached.
inport Specifies incoming unidirectional port monitoring.
outport Specifies outgoing unidirectional port monitoring.
seconds Specifies the number of seconds after which the session is disabled.
enable Enables the port monitoring status.
disable Disables the port monitoring status.
full Captures port monitoring information in detail.
brief Captures only the concise port monitoring data transmitted.

Defaults

parameter default
filesize 1
on | off on
bidirectional | inport | outport bidirectional
seconds 0
enable | disable disable
capture-type brief

Platforms Supported
OmniSwitch 6860, 6860E

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 40-7
port-monitoring source Port Mirroring and Monitoring Commands

Usage Guidelines
• You can configure a port mirroring and a port monitoring session on the same NI module in an OmniS-
witch 6860, 6860E.
• If the port monitoring capture-type is set to brief, the first 64 bytes of the traffic is captured. If the port-
monitoring capture-type is set to full, the entire packet is captured.
• By default, a file called pmonitor.enc is created in the /flash directory when you configure and enable
a port monitoring session. Use the file option to create a user-specified file.
• The /flash directory is the default and the only directory used to capture the port monitoring files.

• The format of the file created is compliant with the ENC file format (Network General Sniffer Network
Analyzer Format).
• By default, the recent frames overwrite the older frames in a port monitoring file if the total data
exceeds the specified file size. Use the overwrite off option to prevent this from occurring.

Examples
-> port-monitoring 6 source 2/1/3
-> port-monitoring 6 source 2/1/3 file /flash/user_port size 2 enable
-> port-monitoring 6 source 2/1/3 file /flash/user_port capture-type full

Release History
Release 8.1.1; command introduced.

Related Commands

port-monitoring Disables, pauses, resumes, or deletes a port monitoring session.

show port-monitoring status Displays the port monitoring status.
show port-monitoring file Displays the port monitoring data.

MIB Objects
monitorTable
monitor
monitorSessionNumber
monitorIfindex
monitorFileStatus
monitorFileName
monitorFileSize
monitorScreenStatus
monitorScreenLine
monitorCaptureType
monitorTrafficType
monitorStatus
monitorFileOverWrite
monitorDirection
monitorTimeout

page 40-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Port Mirroring and Monitoring Commands port-monitoring

port-monitoring
Disables, pauses, resume, or deletes an existing port monitoring session.
port-monitoring port_monitor_sessionid {disable | pause | resume}
no port-monitoring port_monitor_sessionid

Syntax Definitions

port_monitor_sessionid Monitoring session identifier.

disable Disables the port monitoring session.
pause Pauses the port monitoring session.
resumes Resumes the port monitoring session.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to delete a port monitoring session.

Examples
-> port-monitoring 6 pause
-> port-monitoring 6 disable
-> port-monitoring 6 resume
-> no port-monitoring 6

Release History
Release 8.1.1; command introduced.

Related Commands

port-monitoring Configures a port monitoring session.

show port-monitoring status Displays the port monitoring status.

MIB Objects
monitorTable
monitorSessionNumber
monitorScreenStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 40-9
show port-mirroring status Port Mirroring and Monitoring Commands

show port-mirroring status

Displays the status of mirrored ports.
show port-mirroring status [port_mirror_sessionid]

Syntax Definitions

port_mirror_sessionid Mirroring session identifier.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If a port mirroring session identifier is not specified with this command, then all port mirroring sessions
are displayed.

Examples
-> show port-mirroring status

Session Mirror Mirror Unblocked Config Oper

Destination Direction Vlan Status Status
----------+----------+--------------+----------+----------+---------
6. 1/1/41 - NONE Enable Off
----------+----------+--------------+----------+----------+---------
Mirror
Source
----------+----------+--------------+----------+----------+---------
6. 1/1/20 bidirectional - Enable Off
6. 1/1/21 bidirectional - Enable Off
6. 1/1/22 bidirectional - Enable Off
6. 1/1/23 bidirectional - Enable Off
6. 1/1/24 bidirectional - Enable Off
6. 1/1/25 bidirectional - Enable Off
6. 1/1/26 bidirectional - Enable Off
6. 1/1/27 bidirectional - Enable Off
6. 1/1/28 bidirectional - Enable Off
6. 1/1/29 bidirectional - Enable Off
6. 1/1/30 bidirectional - Enable Off

output definitions
Session The port mirroring session identifier.
Mirror Destination The location of the mirrored port.
Mirror Direction The direction of the mirroring or mirrored port, which can be bidirec-
tional (the default), inport, or outport.

page 40-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Port Mirroring and Monitoring Commands show port-mirroring status

output definitions (continued)

Unblocked VLAN The mirroring VLAN ID number.
Config Status The configuration status of the session.
Oper Status The current status of the mirroring or mirrored port.
Mirror Source The location of the mirroring port.

On OmniSwitch 6860, 6860E series switches:

-> show port-mirroring status

Session Mirror Mirror Unblocked Config Oper

Destination Direction Vlan Status Status
----------+----------+--------------+----------+----------+---------
6. 1/1/41 - NONE Enable Off
----------+----------+--------------+----------+----------+---------
Mirror
Source
----------+----------+--------------+----------+----------+---------
6. 1/1/20 bidirectional - Enable Off
6. 1/1/21 bidirectional - Enable Off
6. 1/1/22 bidirectional - Enable Off
6. 1/1/23 bidirectional - Enable Off
6. 1/1/24 bidirectional - Enable Off
6. 1/1/25 bidirectional - Enable Off
6. 1/1/26 bidirectional - Enable Off
6. 1/1/27 bidirectional - Enable Off
6. 1/1/28 bidirectional - Enable Off
6. 1/1/29 bidirectional - Enable Off
6. 1/1/30 bidirectional - Enable Off

output definitions
Session The port mirroring session identifier.
Mirror Destination The location of the mirrored port.
Mirror Direction The direction of the mirroring or mirrored port, which can be bidirec-
tional (the default), inport, or outport.
Unblocked VLAN The mirroring VLAN ID number.
Config Status The configuration status of the session.
Oper Status The current status of the mirroring or mirrored port.
Mirror Source The location of the mirroring port.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 40-11
show port-mirroring status Port Mirroring and Monitoring Commands

Related Commands

port-mirroring Enables, disables, or deletes a port mirroring session.

port-mirroring source Defines a port to mirror and a port that receives data from the mir-
destination rored port, and enables or disables port mirroring status.

MIB Objects
mirrorTable
mirrorMirroringIfindex
mirrorMirroredIfindex
mirrorDirection
mirrorStatus
mirrorSessionNumber
mirrorSessOperStatus
mirrorSrcStatus
mirrorSrcDirection
mirrorSrcRowStatus
mirrorSrcOperStatus
mirrorUnblockedVLAN

page 40-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Port Mirroring and Monitoring Commands show port-monitoring status

show port-monitoring status

Displays port monitoring status.
show port-monitoring status [port_monitor_sessionid]

Syntax Definitions

port_monitor_sessionid Monitoring session identifier.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If a port monitoring session identifier is not specified with this command, then all port monitoring sessions
are displayed.

Examples
-> show port-monitoring status

Sess Mon. Mon. Over Oper. Admin Capt. Max. File

Src Dir write Stat Stat Type Size Name
-----+----+----+-----+------+------+-------+------+--------------------------
1. 1/1/2 Out OFF OFF OFF Brief 64K /flash/pm.enc

output definitions
Sess Session - The port monitoring session identifier.
Mon. Src Monitor Source - The source ports that are monitored.
Mon Dir Monitor Direction - The direction of the monitoring session, which
can be bidirectional (the default), inport, or outport.
Overwrite Whether files created by a port monitoring session can be overwritten.
The default is ON.
Oper Stat Operating Status - The current operating status of the port monitoring
session (on/off).
Admin Stat Admin Status - The current administrative status of the port monitor-
ing session (on/off).
Capt Type Capture type - Brief (captures only 64 bytes of data per traffic data
packet) or Full (captures the entire packet).
Max Size Maximum Size - The maximum size of the port monitoring file.
File Name The name of the port monitoring file.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 40-13
show port-monitoring status Port Mirroring and Monitoring Commands

Release History
Release 8.1.1; command introduced.

Related Commands

port-monitoring source Configures a port monitoring session.

port-monitoring Disables, pauses, resumes, or deletes a port monitoring session.
show port-monitoring file Displays port monitoring data.

MIB Objects
monitorTable
monitorSessionNumber
monitorIfindex
monitorStatus
monitorFileStatus
monitorFileName
monitorFileSize
monitorScreenStatus
monitorScreenLine
monitorTrafficType
monitorDirection
monitorTimeout
monitorCaptureType
monitorFileOverWrite
monitorDirection

page 40-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Port Mirroring and Monitoring Commands show port-monitoring file

show port-monitoring file

Displays port monitoring data.
show port-monitoring file port_monitor_sessionid

Syntax Definitions

port_monitor_sessionid Monitoring session identifier.

Defaults
A single line from the captured packet is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Only a single line from the captured packet is displayed, even though the full packet is captured. To view
the entire packet, download the file and view it using compatible network analyzer tool.

Examples
-> show port-monitoring file 1

Destination | Source | Type | Data

-------------------------------------------------------------------------------
01:80:C2:00:00:00 | 00:20:DA:8F:92:C6 | BPDU | 00:26:42:42:03:00:00:00:00:00
00:20:DA:C7:2D:D6 | 08:00:20:95:F3:89 | UDP | 08:00:45:00:00:6B:FE:4A:40:00
00:20:DA:A3:89:F6 | 08:00:20:95:F3:89 | UDP | 08:00:45:00:00:6B:CF:89:40:00
00:20:DA:BF:5B:76 | 08:00:20:95:F3:89 | UDP | 08:00:45:00:00:6B:CF:85:40:00
00:20:DA:A3:89:F6 | 08:00:20:95:F3:89 | UDP | 08:00:45:00:00:6B:CF:8A:40:00
00:20:DA:BF:5B:76 | 08:00:20:95:F3:89 | UDP | 08:00:45:00:00:6B:CF:86:40:00
00:20:DA:A3:89:F6 | 08:00:20:95:F3:89 | UDP | 08:00:45:00:00:6B:CF:8B:40:00
01:80:C2:00:00:00 | 00:20:DA:8F:92:C6 | BPDU | 00:26:42:42:03:00:00:00:00:00
00:20:DA:BF:5B:76 | 08:00:20:95:F3:89 | UDP | 08:00:45:00:00:6B:CF:87:40:00

output definitions
Destination The destination MAC address of the packet.
Source The source MAC address of the packet.
Type The type of packet.
Data The packet displayed in hexadecimal format.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 40-15
show port-monitoring file Port Mirroring and Monitoring Commands

Related Commands

port-monitoring source Configures a port monitoring session.

port-monitoring Disables, pauses, resumes, or deletes a port monitoring session.
show port-monitoring status Displays the port monitoring status.

MIB Objects
monitorTable
monitorSessionNumber
monitorIfindex
monitorTrafficType
monitorFileStatus
monitorFileName
monitorFileSize
monitorScreenStatus
monitorScreenLine

page 40-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 41 sFlow Commands

sFlow is a network monitoring technology that gives visibility in to the activity of the network, by
providing network usage information. It provides the data required to effectively control and manage the
network usage. sFlow is a sampling technology that meets the requirements for a network traffic
monitoring solution.
sFlow provides a network-wide view of usage and active routes. It is used for measuring network traffic,
collecting, storing, and analyzing the traffic data. As it is scalable, that doesn’t add significant network
load. sFlow is an industry standard with many vendors delivering products with this support. Some of the
applications of the sFlow data include:
• Detecting, diagnosing, and fixing network problems

• Real-time congestion management

• Detecting unauthorized network activity

• Usage accounting and billing

• Understanding application mix

• Route profiling and peer optimization

• Capacity planning

sFlow is a sampling technology embedded within switches/routers. It provides the ability to monitor the
traffic flows. It requires an sFlow agent software process running as part of the switch software and a
sFlow collector which receives and analyses the monitored data. The sFlow collector makes use of SNMP
to communicate with an sFlow agent in order to configure sFlow monitoring on the device (switch).
An sFlow agent running on the switch/router combines interface counters and traffic flow (packet)
samples, preferably, on all the interfaces into sFlow datagrams that are sent across the network to an sFlow
collector.
Packet sampling on the switch/router is typically performed by the switching/routing ASICs, providing
wire-speed performance. In this case, an sFlow agent does very little processing, by packaging data into
sFlow datagrams that are immediately sent on network. This minimizes the memory and CPU utilization
by the sFlow agent.
MIB information for the sFlow commands is as follows:
Filename: Alcatel-IND1-PORT-MIRRORING-MONITORING-MIB.mib
Module: AlcatelIND1PortMirMon
Filename: SFLOW--MIB.MIB
Module: sFlow

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 41-1
 sFlow Commands

A summary of the available commands is listed here:

sflow receiver
sflow sampler
sflow poller
show sflow agent
show sflow receiver
show sflow sampler
show sflow poller

page 41-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
sFlow Commands sflow receiver

sflow receiver
Sets the destination hosts where the sFlow datagrams are sent out. If there are multiple destinations, then
each destination has an instance of the receiver. All these receivers are attached to the sFlow manager
instance and to an associated sampler/poller.
sflow receiver receiver_index {name string | timeout { seconds | forever} | address {ip_address |
ipv6address} | udp-port port | packet-size size Version num | release}

Syntax Definitions

receiver_index Specifies the receiver index.

string Specifies the name.
seconds | forever Specifies the timeout value.
ip_address | ipv6address Specifies the 32/128-bit ip address.
port Specifies the UDP (destination) port.
size Specifies the maximum number of data bytes (size) that can be sent.
num Specifies the version number.

Defaults

parameter default
string empty
seconds 0
ip_address 0.0.0.0(ipv4)
port 6343
size 1400
version num 5

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the release form at the end of the command to delete a receiver.

Examples
-> sflow receiver 1 name Golden Rcvr1 address 198.206.181.3
-> sflow receiver 1 release

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 41-3
sflow receiver sFlow Commands

Related Commands

show sflow receiver Displays the receiver table.

MIB Objects
sFlowRcvrTable
sFlowRcvrIndex
sFlowRcvrOwner
sFlowRcvrTimeout
sFlowRcvrMaximumDatagramSize
sFlowRcvrAddressType
sFlowRcvrAddress
sFlowRcvrPort
sFlowRcvrDatagramVersion

page 41-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
sFlow Commands sflow sampler

sflow sampler
Gets the hardware sampled from Q-dispatcher and fills up the sampler part of the UDP datagram.
sflow sampler num port chassis/slot/port[-port] {receiver receiver_index | rate value | sample-hdr-size
size}
no sflow sampler num portlist

Syntax Definitions

num Specifies the instance id.

chassis The chassis identifier.
slot/port The slot number for the module and the physical port number on that
module.
receiver_index Specifies the receiver index.
value Specifies the rate value for packet sampling.
size Specifies the maximum number of bytes (size) that can be copied from a
sampled packet.
portlist Specifies the interface index range.

Defaults

parameter default
receiver_index 0
value 0
size 128

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete a sampler.

• A sampling rate of 1 counts all packets. A sampling rate of 0 disables sampling.

Examples
-> sflow sampler 1 2/1/1 receiver 1 rate 5 sample-hdr-size 64
-> no sflow sampler 1 2/1/1-5

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 41-5
sflow sampler sFlow Commands

Related Commands

show sflow sampler Displays the sampler table.

MIB Objects
sFlowFsTable
sFlowFsDataSource
sFlowFsInstance
sFlowFsReceiver
sFlowFsPacketSamplingRate
sFlowFsMaximumHeaderSize

page 41-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
sFlow Commands sflow poller

sflow poller
Gets counter samples from ethernet driver and fills up the counter part of the UDP datagram.
sflow poller num port chassis/slot/port[-port] {receiver receiver_index | interval value}
no sflow poller num portlist

Syntax Definitions

num Specifies the instance id.

chassis The chassis identifier.
slot/port The slot number for the module and the physical port number on that
module.
receiver_index Specifies the receiver index.
value Specifies the maximum number of seconds between successive samples
(interval value).
portlist Specifies the interface index range.

Defaults

parameter default
receiver_index 0
value 0

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the no form of this command to delete a poller.

Examples
-> sflow poller 1 1/1/1 receiver 2 interval 20
-> sflow poller 1 2/1/6-10 receiver 1 interval 30
-> no sflow poller 1 2/1/6-10

Release History
Release 8.1.1; command was introduced.

Related Commands

show sflow poller Displays the poller table.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 41-7
sflow poller sFlow Commands

MIB Objects
sFlowCpTable
sFlowCpDataSource
sFlowCpInstance
sFlowCpReceiver
sFlowCpInterval

page 41-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
sFlow Commands show sflow agent

show sflow agent

Displays the sFlow agent table.
show sflow agent

Syntax Definitions

agent Collects sample datagrams and send it to the collector across the net-
work.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• It is necessary to execute the ip interface command to make a loopback0 IP address as the fixed
primary address of the switch, in order to avoid interface changes, which might need the collector soft-
ware to be restarted for it to communicate using the new agent IP address. Normally, the primary IP
address could change depending on the IP interface going up/down. Therefore, the sFlow agent always
needs to send a fixed IP address in the datagram.
• The loopback address should be an IP interface configured on the switch.

Examples
-> ip interface loopback0 address 198.206.181.100
-> show sflow agent
Agent Version = 1.3; Alcatel-Lucent; 6.1.1
Agent IP = 127.0.0.1

output definitions
Agent Version Identifies the version which includes the MIB version, organization
name, and the specific software build of the agent.
Agent address IP address associated with the agent. Configured through the ip service
source-ip command.

Release History
Release 8.1.1; command was introduced.

Related Commands

show sflow receiver Displays the receiver table.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 41-9
show sflow agent sFlow Commands

MIB Objects
sFlowAgent
sFlowVersion
sFlowAgentAddressType
sFlowAgentAddress

page 41-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
sFlow Commands show sflow receiver

show sflow receiver

Displays the sflow receiver table.
show sflow receiver [num]

Syntax Definitions

num Specifies the receiver index.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show sflow receiver
Receiver 1
Name = Golden
Address = IP_V4 198.206.181.3
UDP Port = 6343
Timeout = 65535
Packet Size= 1400
DatagramVer= 5

output definitions
Name Name of the entry to claim.
Address IP address of the sFlow collector.
UDP Port Destination port for sFlow datagrams.
Timeout Time remaining before the sampler is released and stops sampling.
Packet size Maximum number of data bytes that can be sent in a single sample
datagram.
Datagram ver Version of sFlow datagrams that should be sent.

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 41-11
show sflow receiver sFlow Commands

Related Commands

ip service source-ip Sets the destination hosts where the sFlow datagrams are sent out.

MIB Objects
sFlowRcvrTable
sFlowRcvrIndex

page 41-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
sFlow Commands show sflow sampler

show sflow sampler

Displays the sflow sampler table.
show sflow sampler [num]

Syntax Definitions

num Specifies the instance id.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show sflow sampler
Instance Interface Receiver Sample-rate Sample-hdr-size
-----------------------------------------------------------------
1 2/1/1 1 2048 128
1 2/1/2 1 2048 128
1 2/1/3 1 2048 128
1 2/1/4 1 2048 128
1 2/1/5 1 2048 128

output definitions
Instance Instance for the flow sampler.
Interface Interface used for the flow sampler.
Receiver Receiver associated with the flow sampler.
Sample-rate Statistical sampling rate for packet sampling from the source.
Sample-hdr-size Maximum number of bytes that should be copied from a sampled
packet.

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 41-13
show sflow sampler sFlow Commands

Related Commands

sflow sampler Gets hardware sampled from Q-dispatcher.

MIB Objects
sFlowFsTable
sFlowFsInstance

page 41-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
sFlow Commands show sflow poller

show sflow poller

Displays the sflow poller table.
show sflow poller [num]

Syntax Definitions

num Specifies the instance ID.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show sflow poller
Instance Interface Receiver Interval
-------------------------------------------
1 2/1/6 1 30
1 2/1/7 1 30
1 2/1/8 1 30
1 2/1/9 1 30
1 2/1/10 1 30

output definitions
Instance Instance for the counter poller.
Interface Interface used for the counter poller.
Receiver Receiver associated with the counter poller.
Interval The maximum number of seconds between successive samples of the
counters associated with the data source.

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 41-15
show sflow poller sFlow Commands

Related Commands

sflow poller Gets counter samples.

MIB Objects
sFlowCpTable
sFlowCpInstance

page 41-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 42 RMON Commands

Remote Network Monitoring (RMON) probes can be used to monitor, manage, and compile statistical data
about network traffic from designated active ports in a LAN segment without negatively impacting
network performance. This feature supports basic RMON 4 group implementation compliant with
RFC 2819 (Remote Network Monitoring Management Information Base), but does not support RMON 10
group or RMON 2. This chapter includes descriptions of RMON commands used to enable or disable
individual (or a group of a certain flavor type) RMON probes, show a list of (or individual) RMON probes
and show a list of (or individual) RMON logged events.
MIB information for the RMON commands is as follows:
Filename: IETF_RMON.mib
Module: RMON-MIB
The following table summarizes the available commands:

rmon probes
show rmon probes
show rmon events

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 42-1
rmon probes RMON Commands

rmon probes
This command enables or disables types of RMON probes.
rmon probes {stats | history | alarm} [entry-number] {enable | disable}

Syntax Definitions

stats Ethernet Statistics Table probe entries.

history History Control Table probe entries.
alarm Alarm Table probe entries.
entry-number The entry number in the list of probes (optional).
enable Enables the RMON probe.
disable Disables the RMON probe.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Network activity on subnetworks attached to the RMON probe can be monitored by NMS applications.

• RMON will not monitor activities on the CMM onboard Ethernet Management port.

Examples
-> rmon probes stats 4012 enable
-> rmon probes history 10240 disable
-> rmon probes alarm 11235 enable
-> rmon probes stats enable
-> rmon probes history disable
-> rmon probes alarm enable

Release History
Release 8.1.1; command introduced.

page 42-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
RMON Commands rmon probes

Related Commands

show rmon probes Displays a list of RMON probes or a single RMON probe.
show rmon events Displays a list of RMON logged events or a single RMON event.

MIB Objects
ETHERSTATSTABLE
etherStatsStatus
HISTORYCONTROLTABLE
historyControlStatus
ALARMTABLE
alarmStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 42-3
show rmon probes RMON Commands

show rmon probes

Displays a list of RMON probes or a single RMON probe.
show rmon probes [stats | history | alarm] [entry-number]

Syntax Definitions

stats Ethernet Statistics Table probe entries.

history History Control Table probe entries.
alarm Alarm Table probe entries.
entry-number The entry number in the list of probes (optional).

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• To display a list of current probes, omit the entry-number from the command line.

• To display statistics for a particular probe, include the probe’s entry-number in the command line.

• The show rmon probes command displays the following information: Entry number, Slot/Port, Flavor
(whether the probe type is Ethernet, History or Alarm), Status (Active or Inactive), Duration (time
since the last change in status, in hours/minutes) and System Resources (the amount of memory allo-
cated to this probe).
• The show rmon probes entry-number command displays the following information: Probe’s Owner
(probe type and location), Slot/Port, Entry number, Flavor (whether the probe type is Ethernet, History
or Alarm), Status (Active or Inactive), Time since the last change in status (hours/minutes), and System
Resources (the amount of memory allocated to this probe). Displayed statistics may vary, depending on
whether the probe type is Ethernet, History or Alarm.

Examples
-> show rmon probes stats

Chassis/
Entry Slot/Port Flavor Status Duration System Resources
-------+-----------+-----------+----------+---------------+---------------------
4001 4/1/1 Ethernet Active 00:25:00 275 bytes
4008 4/1/8 Ethernet Active 00:25:00 275 bytes
4005 4/1/5 Ethernet Active 00:25:00 275 bytes

page 42-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
RMON Commands show rmon probes

-> show rmon probes history

Chassis/
Entry Slot/Port Flavor Status Duration System Resources
-------+-----------+-----------+----------+---------------+---------------------
1 4/1/1 History Active 00:25:00 9063 bytes
10240 4/1/5 History Active 00:14:00 601 bytes
10325 4/1/8 History Active 00:14:00 601 bytes

-> show rmon probes alarm

Chassis/
Entry Slot/Port Flavor Status Duration System Resources
-------+-----------+-----------+----------+---------------+---------------------
11235 4/1/8 Alarm Active 00:07:00 835 bytes

-> show rmon probes stats 4005

Probe’s Owner: Switch Auto Probe on Chassis 4, Slot 1, Port 5

Entry 4005
Flavor = History, Status = Active
Time = 48 hrs 54 mins,
System Resources (bytes) = 275

-> show rmon probes history 10325

Probe’s Owner: Analyzer-p:128.251.18.166 on Chassis 4, Slot 1, Port 5

History Control Buckets Requested = 2
History Control Buckets Granted = 2
History Control Interval = 30 seconds
History Sample Index = 5859
Entry 10325
Flavor = History, Status = Active
Time = 48 hrs 53 mins,
System Resources (bytes) = 601

-> show rmon probes alarm 11235

Probe’s Owner: Analyzer-t:128.251.18.166 on Chassis 4, Slot 1, Port 8

Alarm Rising Threshold = 5
Alarm Falling Threshold = 0
Alarm Rising Event Index = 26020
Alarm Falling Event Index = 0
Alarm Interval = 10 seconds
Alarm Sample Type = delta value
Alarm Startup Alarm = rising alarm
Alarm Variable = 1.3.6.1.2.1.16.1.1.1.5.4008
Entry 11235
Flavor = Alarm, Status = Active
Time = 48 hrs 48 mins,
System Resources (bytes) = 1677

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 42-5
show rmon probes RMON Commands

output definitions
Probe’s Owner Description and interface (location) of the probe.
Slot/Port The Slot/Port number (interface) that this probe is monitoring.
Entry The Entry number in the list of probes.
Flavor Whether the probe type is Ethernet, History, or Alarm.
Status The status of the probe–Creating (the probe is under creation), Active
(the probe is Active), or Inactive (the probe is inactive).
Duration Elapsed time (hours/minutes/seconds) since the last change in status.
System Resources Amount of memory that has been allocated to this probe.

Release History
Release 8.1.1; command introduced.

Related Commands

rmon probes Enables or disables types of RMON probes.

show rmon events Displays RMON logged events.

MIB Objects
ETHERSTATSTABLE
etherStatsIndex
HISTORYCONTROLTABLE
historyControlIndex
ALARMTABLE
alarmIndex

page 42-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
RMON Commands show rmon events

show rmon events

Displays RMON events (actions that take place based on alarm conditions detected by the RMON probe).
show rmon events [event-number]

Syntax Definitions

event-number The event number (optional) in the list of probes.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• To display a list of logged events, omit the event-number from the command line.

• To display statistics for a particular event, include the event-number in the command line.

• The show rmon events command displays the following information for all RMON Logged Events:
Entry number, Time (hours/minutes/seconds) since the last change in status and Description (nature of
the event).
• The show rmon events event-number command displays the following information for a particular
RMON Logged Event: Entry number, Time (hours/minutes/seconds) since the last change in status and
Description (nature of the event).

Examples
-> show rmon events

Entry Time Description

---------+-------------------+-----------------------------------------------------
1 00:08:00 etherStatsPkts.4008: [Falling trap] “Falling Event”
2 00:26:00 etherStatsCollisions.2008: “Rising Event”

-> show rmon events 2

Entry Time Description

---------+-------------------+-----------------------------------------------------
2 00:26:00 etherStatsCollisions.2008: “Rising Event”

output definitions
Entry The entry number in the list of probes.
Time Time (hours, minutes, and seconds) since the last change in status.
Description Description of the Alarm condition detected by the probe.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 42-7
show rmon events RMON Commands

Release History
Release 8.1.1; command introduced.

Related Commands

rmon probes Enables or disables types of RMON probes.

show rmon probes Displays RMON probes or a single RMON probe.

MIB Objects
EVENTTABLE
eventIndex

page 42-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 43 Switch Logging
Commands

This chapter includes descriptions for Switch Logging commands. These commands are used to configure
parameters for the Switch Logging utility.
MIB information for the system commands is as follows:
Filename: AlcatelIND1System.MIB
Module: ALCATEL-IND1-SYSTEM-MIB
A summary of the available commands is listed here.

swlog
swlog appid
swlog output
swlog output flash-file-size
swlog clear
show log swlog
show swlog

OmniSwitch CLI Reference Guide November 2015 page 43-1

swlog Switch Logging Commands

swlog
Enables or disables switch logging. Switch logging allows you to view a history of various switch
activities in a text format.
swlog {[enable | disable] | remote command-log {enable| disable} | preamble | hash-time-limit num |
duplicate-detect | console level num}
no swlog

Syntax Definitions

enable | disable Enables or disables the switch logging functionality.

command-log enable | disable Enables or disables the logging of commands to syslog.
preamble Enables or disables the display of the preamble to the console.
hash-time-limit num Configures the amount of elapsed time for an entry to no longer be con-
sidered a duplicate entry.
duplicate-detect Enables or disables the duplicate detection capability.
level num The severity level filter keyword or numeric value for the application
ID. (see table for swlog appid command).

Defaults
By default, switch logging is enabled.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of the command to enable or disable the preamble and duplicate-detect setting.

• The syslog preamble includes the level, appid and timestamps that precedes the actual log messages.

• If duplicate entries are received within the configured hash-time-limit only a single entry will be
logged along with the number of times duplicated.

Examples
-> swlog enable
-> swlog hash-time-limit 30
-> no swlog preamble

Release History
Release 8.1.1; command was introduced.

page 43-2 OmniSwitch CLI Reference Guide November 2015

Switch Logging Commands swlog

Related Commands

swlog appid Defines the level at which switch logging information will be filtered for
the specified application.
swlog output Enables or disables switch logging output to the console, file, or data
socket.
show log swlog Displays stored switch logging information from flash.
show swlog Displays switch logging information.

MIB Objects
systemSwitchLoggingGroup
systemSwitchLoggingEnable

OmniSwitch CLI Reference Guide November 2015 page 43-3

swlog appid Switch Logging Commands

swlog appid
Defines the level at which switch logging information will be filtered for the specified application. All
application events of the defined level and lower are captured.
swlog appid {all | string} {[library {all | string} | subapp {all | num}]} {[disable | enable | level {level |
num]} [vrf num]

Syntax Definitions

string An application or library identification keyword.

subapp num A numerical equivalent value for the subapp ID.
disable | enable Enables or disables the logging of the associated application.
level level | num The severity level filter keyword or numerical equivalent value for the
application ID (see table below). All switch logging messages of the
specified level and lower will be captured. The severity level is a value
assigned to the relative severity of the switch logging message. A lower
value indicates messages that are more severe, a higher value indicates
messages that are less severe.
vrf num The VRF ID.

Supported Levels Numeric Equivalents Description

off 0 Disabled
alarm 1 Highest severity. The system is about to crash
and reboot.
error 2 System functionality is reduced.
alert 3 A violation has occurred.
warning 4 A unexpected, non-critical event has occurred.
info 5 Any other non-debug message (default).
debug1 6 A normal event debug message.
debug2 7 A debug-specific message.
debug3 8 All debug messages.

Defaults
Default severity level is info.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the show swlog appid all command to display all available registered applications.

page 43-4 OmniSwitch CLI Reference Guide November 2015

Switch Logging Commands swlog appid

Examples
-> swlog appid all subid all enable
-> swlog appid mvrpNi subapp 1 level 8
-> show swlog appid mvrpNi
Application Name : mvrpNi,

SubAppl ID Sub Application Name Level VRF Level

----------+--------------------+--------+-------------------------------
1 main error VRF 1-64 info

Release History
Release 8.1.1; command was introduced.

Related Commands

swlog Enables or disables switch logging.

swlog output Enables or disables switch logging output to the console, file, or data
socket.
show log swlog Displays stored switch logging information from flash.
show swlog Displays switch logging information.

MIB Objects
systemSwitchLoggingGroup
systemSwitchLoggingLevelAppName
systemSwitchLoggingLevel
systemSwitchLoggingVrf

OmniSwitch CLI Reference Guide November 2015 page 43-5

swlog output Switch Logging Commands

swlog output
Enables or disables switch logging output to the console, file, or data socket (remote session).
swlog output {tty {enable | disable} | console | flash | socket ip_address [vrf-name name]}
no swlog output {console | flash | socket ip_address}

Syntax Definitions

tty enable | disable Enables or disables switch logging to a connected Telnet session.
console Specifies console output. When enabled, switch logging output is
printed to the user console.
flash Specifies /flash file output. When enabled, switch logging output is
printed to a file in the switch’s /flash file system.
socket Specifies data socket output. When enabled, switch logging output is
printed to a remote session.
ip_address The IPv4 or IPv6 address for the remote session host.
name Specifies the VRF to be used to access the remote syslog server.

Defaults

parameter default
console | flash | socket flash and console

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to disable one or more configured output IP addresses.

• This command can also be used on the secondary CMM.

• You can send output to a syslog server using the socket keyword, followed by the IP address of the
remote host. Up to 12 servers can be configured.
• VRF name must either be ‘default’or pre-defined VRF (user-defined).

Examples
-> swlog output console
-> no swlog output flash
-> swlog output socket 14.1.1.1
-> swlog output socket 14.1.1.1 vrf-name vrf1

Release History
Release 8.1.1; command was introduced.

page 43-6 OmniSwitch CLI Reference Guide November 2015

Switch Logging Commands swlog output

Related Commands

swlog Enables or disables switch logging.

swlog appid Defines the level at which switch logging information will be filtered for
the specified application.
show log swlog Displays stored switch logging information from flash.
show swlog Displays switch logging information.

MIB Objects
systemSwitchLoggingGroup
systemSwitchLoggingFlash
systemSwitchLoggingSocket
systemSwitchLoggingSocketIpAddr
systemSwitchLoggingConsole
systemSwitchLoggingHostTable
systemSwitchLoggingHostIpAddr
systemSwitchLoggingHostPort
systemSwitchLoggingHostStatus
systemSwitchLoggingHostVrfName

OmniSwitch CLI Reference Guide November 2015 page 43-7

swlog output flash-file-size Switch Logging Commands

swlog output flash-file-size

Configures the size of the switch logging file.
swlog output flash-file-size kilobytes

Syntax Definitions

kilobytes The size of the switch logging file in kilobytes.

Defaults

parameter default
kilobytes 1250

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the show hardware-info command to determine the amount of available flash memory.

• This command can also be used on the secondary CMM.

Examples
-> swlog output flash-file-size 256

Release History
Release 8.1.1; command was introduced.

Related Commands

swlog clear Clears the files that store switch logging data.
show log swlog Displays stored switch logging information from flash.
show swlog Displays switch logging information.

MIB Objects
systemSwitchLoggingGroup
systemSwitchLoggingFileSize

page 43-8 OmniSwitch CLI Reference Guide November 2015

Switch Logging Commands swlog clear

swlog clear
Clears the files that store switch logging data.
swlog clear

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use this command when the switch logging display is too long due to some of the data being old or out
of date.
• This command can also be used on the secondary CMM.

Examples
-> swlog clear

Release History
Release 8.1.1; command was introduced.

Related Commands

swlog output Enables or disables switch logging output to the console, file, or data
socket.
show log swlog Displays stored switch logging information from flash.
show swlog Displays switch logging information.

MIB Objects
systemSwitchLoggingGroup
systemSwitchLoggingClear

OmniSwitch CLI Reference Guide November 2015 page 43-9

show log swlog Switch Logging Commands

show log swlog

Displays stored switch logging information.
show log swlog
show log swlog [timestamp mm/dd/yyyy hh:mm:ss] [slot num]

Syntax Definitions

num The slot number to display the logging information for. Currently not
supported.
start_time Specify the starting time for the switch logging information to be dis-
played. Use the format mm/dd/yyyy hh:mm:ss where mm represents the
month, dd is the day, yyyy is the year, hh is the hour, mm is the minutes
and ss is the seconds. Use four digits to specify the year.

Default
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When the switch logging display is too long, you may use the swlog clear command to clear all of the
switch logging information.
• The use of grep and the timestamp parameter can be used to filter the log files.

Examples
-> show log swlog timestamp 09/30/2011 13:27:00
Displaying file contents for '/flash/swlog.6'
Displaying file contents for '/flash/swlog.5'
<output truncated>

Sep 30 13:27:16 Chassis6900 local0.info swlogd: ChassisSupervisor fan & temp Mgr
info(5) Alert: PS1 airFlow unknown yet- duplicated 5 times!

-> show log swlog | grep ChassisSupervisor

Displaying file contents for '/flash/swlog.6'
Displaying file contents for '/flash/swlog.5'
<output truncated>

Sep 28 13:25:15 Chassis6900 local0.info swlogd: ChassisSupervisor fan & temp Mgr
info(5) Alert: PS1 airFlow unknown yet- duplicated 5 times!

Sep 30 13:26:16 Chassis6900 local0.info swlogd: ChassisSupervisor fan & temp Mgr
info(5) Alert: PS1 airFlow unknown yet- duplicated 5 times!

Sep 30 13:27:16 Chassis6900 local0.info swlogd: ChassisSupervisor fan & temp Mgr
info(5) Alert: PS1 airFlow unknown yet- duplicated 5 times!

page 43-10 OmniSwitch CLI Reference Guide November 2015

Switch Logging Commands show log swlog

Release History
Release 8.1.1; command was introduced.

Related Commands

swlog Enables or disables switch logging.

swlog appid Adds or removes a filter level for a specified subsystem.
swlog output Enables or disables switch logging output to the console, file, or data
socket.
swlog clear Clears the files that store switch logging data.
show swlog Displays switch logging information.

OmniSwitch CLI Reference Guide November 2015 page 43-11

show swlog Switch Logging Commands

show swlog
Displays switch logging information (e.g., switch logging status, log devices, application IDs with non-
default severity level settings).
show swlog [library | dying-gasp-station |appid {all | string}]

Syntax Definitions

library The slot number to display the logging information for.

dying-gasp-station The status of configured dying gasp station.
string The name of the appid to display.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command can also be used on the secondary CMM.

Examples
-> show swlog
Operational Status : Running,
File Size per file : 125K bytes,
Log Device : console flash socket,
Log Device : ipaddr 1.2.3.4 vrf mgt(1),
Syslog FacilityID : local0(16),
Remote command-log : Disabled,
Hash Table entries age limit : 60 seconds,
Switch Log Preamble : Enabled,
Switch Log Debug : Disabled,
Switch Log Duplicate Detection : Enabled,
Console Display Level : info

-> show swlog dying-gasp-station

Operational Status : Running,
Log Device : ipaddr 10.135.34.45 remote command-log
Syslog FacilityID : local0(16)

output definitions
Application ID The Application ID (subsystem) for which the Severity Level is not set
to the info (6) default setting.
Operational Status Displays whether switch logging is enabled or disabled.
File Size per file The maximum file size of the switch log file.

page 43-12 OmniSwitch CLI Reference Guide November 2015

Switch Logging Commands show swlog

output definitions
Log Device Which devices are the switch log messages being sent to.
Log Device Which devices are the switch log messages being sent to.
Syslog FacilityID Syslog FacilityID
Remote command-log Status of remote command logging.
Hash Tables entries age limit The elapsed time for duplicate entries.
Switch Log Preamble Status of displaying message preamble on console.
Switch Log Debug Status of swlog debug.
Switch Log Duplicate Status of duplicate detection.
Detection
Console Display Level The console severity level of the above-referenced Application ID.

Release History
Release 8.1.1; command was introduced.

Related Commands

swlog Enables or disables switch logging.

swlog appid Defines the level at which switch logging information will be filtered for
the specified application.
swlog output Enables or disables switch logging output to the console, file, or data
socket.
show log swlog Displays stored switch logging information from flash.

MIB Objects
systemSwitchLoggingHostVrfName

OmniSwitch CLI Reference Guide November 2015 page 43-13

show swlog Switch Logging Commands

page 43-14 OmniSwitch CLI Reference Guide November 2015

 44 Health Monitoring
Commands

The Health Monitoring function monitors the consumable resources of the switch (for example, bandwidth
usage, CPU usage) and provides a single integrated resource for a Network Management System (NMS).
This function monitors the switch, and at fixed intervals, collects the current values for each resource
being monitored. Users specify resource threshold limits and traps are sent to an NMS if a value falls
above or below a user-specified threshold.
The Health Monitoring commands comply with RFC1212.
MIB information for the Health Monitoring commands is as follows:
Filename: AlcatelIND1Health.mib
Module: healthMIB
A summary of the available commands is listed here:

health threshold
health interval
show health configuration
show health
show health all

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 44-1
health threshold Health Monitoring Commands

health threshold
Configures thresholds for input traffic (RX), output/input traffic (TX/RX), memory usage, CPU usage, and
chassis temperature.
Input traffic, output/input traffic, memory usage, and CPU usage thresholds specify the maximum
percentage for each resource that may be consumed before a trap is sent to the user. The temperature
threshold specifies the maximum operating temperature, in Celsius, allowed within the chassis before a
trap is sent.
health threshold {rx percent | txrx percent | memory percent | cpu percent}

Syntax Definitions

rx Specifies the maximum input (RX) traffic threshold.

txrx Specifies the maximum output/input (TX/RX) traffic threshold.
memory Specifies the maximum RAM memory usage threshold.
cpu Specifies the maximum CPU usage threshold.
percent The new threshold value for the corresponding resource (rx, txrx, mem-
ory, cpu). The valid range is 0–100 percent.
degrees The new threshold value, in Celsius, for the chassis temperature thresh-
old (0–100).

Defaults

parameter default
percentage 80
degrees 50

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When a resource falls back below the configured threshold, an additional trap is sent to the user. This
indicates that the resource is no longer operating beyond its configured threshold limit.
• Changing a threshold value sets the value for all levels of the switch (the switch, module, and port).
You cannot set different threshold values for each level.
• For detailed information on each threshold type, refer to page 44-5, or refer to the “Diagnosing Switch
Problems” chapter in the OmniSwitch AOS Release 8 Network Configuration Guide.
• To view the current health threshold values, use the show health configuration command.

page 44-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Health Monitoring Commands health threshold

Examples
-> health threshold rx 85
-> health threshold txrx 55
-> health threshold memory 95
-> health threshold cpu 85

Release History
Release 8.1.1; command introduced.

Related Commands

show health configuration Displays the current health threshold settings.

MIB Objects
HealthThreshInfo
healthThreshDeviceRxLimit
healthThreshDeviceTxRxLimit
healthThreshDeviceMemoryLimit
healthThreshDeviceCpuLimit

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 44-3
health interval Health Monitoring Commands

health interval
Configures the sampling interval between health statistics checks. The sampling interval is the time
interval between polls of the consumable resources of the switch to see if it is performing within set
thresholds.
health interval seconds

Syntax Definitions

seconds Sampling interval (in seconds). Valid entries are 1, 2, 3, 4, 5, 6, 10, 12,
15, 20, 30.

Defaults

parameter default
seconds 5

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Decreasing the polling interval may impact switch performance.

Examples
-> health interval 6

Release History
Release 8.1.1; command introduced.

Related Commands

show health Displays the current health sampling interval.

MIB Objects
HealthThreshInfo
healthSamplingInterval

page 44-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Health Monitoring Commands show health configuration

show health configuration

Displays current health configuration settings.
show health configuration

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show health configuration
Rx Threshold : 80
TxRx Threshold : 80
Cpu Threshold : 80
Memory Threshold : 80
Sampling Interval (Secs) : 10

output definitions
Rx Threshold The current device input (RX) threshold. This value displays the maxi-
mum percentage of total bandwidth allowed for incoming traffic on the
switch. The total bandwidth is defined as the Ethernet port capacity for
all NI modules currently operating in the switch, in Mbps. For example,
a chassis with 48 100Base-T Ethernet ports installed has a total band-
width of 4800 Mbps. The default value is 80 percent and can be
changed using the health threshold command.
TxRx Threshold The current device output/input (TX/RX) threshold. This value dis-
plays the maximum percentage of total bandwidth allowed for all
incoming and outgoing traffic. As with the RX threshold described
above, the total bandwidth is defined as the Ethernet port capacity for
all the NI modules currently operating in the switch, in Mbps. The
default value is 80 percent and can be changed using the
health threshold command.
Memory Threshold Displays the current memory usage threshold. Memory usage refers to
the total amount of RAM memory currently used by switch applica-
tions. The default value is 80 percent and can be changed using the
health threshold command.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 44-5
show health configuration Health Monitoring Commands

output definitions (continued)

CPU Threshold Displays the current CPU usage threshold. CPU usage refers to the total
amount of CPU processor capacity currently used by switch applica-
tions. The default value is 80 percent and can be changed using the
health threshold command.
Sampling Interval Displays the sampling interval time period in seconds. The default
value is 5 seconds. Sampling interval can be changed using the health
interval command.

Release History
Release 8.1.1; command introduced.

Related Commands

health threshold Configures thresholds for input traffic (RX), output/input traffic
(TX/RX), memory usage, CPU usage, and chassis temperature.
health interval Configures the sampling interval between health statistics checks.

MIB Objects
HealthThreshInfo
healthThreshDeviceRxLimit
healthThreshDeviceTxRxLimit
healthThreshDeviceTempLimit
healthThreshDeviceMemoryLimit
healthThreshDeviceCpuLimit

page 44-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Health Monitoring Commands show health

show health
Displays the health statistics for the switch. Statistics are displayed as percentages of total resource
capacity and represent data taken from the last sampling interval.
show health [port chassis//slot/port | slot chassis/slot] [statistics]

Syntax Definitions

chassis/slot/port The chassis ID, slot, and port number (3/1/1) for a specific port.
chassis/slot The chassis ID and slot number (3/1) for a specific slot.
statistics Optional command syntax. It displays the same information as the show
health command.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
If no slot or port information is specified, the aggregate health statistics for all ports is displayed.

Examples
-> show health

CMM Current 1 Min 1 Hr 1 Day

Resources Avg Avg Avg
-------------------+---------+-------+------+-------
CPU 0 0 0 0
Memory 30 30 24 24

-> show health port 4/1/3

Port 1/1/1 1 Min 1 Hr 1 Hr
Resources Limit Curr Avg Avg Max
----------------+-------+-----+-------+-----+-------
Receive 80 01 01 01 01
Transmit/Receive 80 01 01 01 01

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 44-7
show health Health Monitoring Commands

Receive Traffic received by the switch.

Transmit/Receive Traffic transmitted and received by the switch.
Memory Switch memory.
CPU Switch CPU.
Temperature Cmm CMM Chassis Temperature.
Temperature Cmm Cpu CMM CPU Temperature.
Limit Currently configured device threshold levels (percentage of total avail-
able bandwidth or temperature measured in degrees Celsius).
Curr Current device bandwidth usage or temperature (measured in degrees
Celsius).
1 Min Avg Average device bandwidth usage or temperature (measured in degrees
Celsius) over a 1-minute period.
1 Hr Avg Average device bandwidth usage or temperature (measured in degrees
Celsius) over a 1-hour period.
1 Hr Max Maximum device bandwidth usage or temperature (measured in
degrees Celsius) over a 1-hour period (the maximum of the 1 minute
averages).

Release History
Release 8.1.1; command introduced.

Related Commands

show health all Displays health statistics for a specified resource on all NIs cur-
rently operating in the chassis.

MIB Objects
healthModuleTable
healthModuleSlot
healthModuleRxLatest
healthModuleRx1MinAvg
healthModuleRx1HrAvg
healthModuleRx1HrMax
healthModuleRxTxLatest
healthModuleRxTx1MinAvg
healthModuleRxTx1HrAvg
healthModuleRxTx1HrMax
healthModuleMemoryLatest
healthModuleMemory1MinAvg
healthModuleMemory1HrAvg
healthModuleMemory1HrMax
healthModuleCpuLatest
healthModuleCpu1MinAvg
healthModuleCpu1HrAvg
healthModuleCpu1HrMax

page 44-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Health Monitoring Commands show health all

show health all

Displays health statistics for a specified resource on all active NI modules installed in the chassis.
show health all {memory | cpu | rx | txrx}

Syntax Definitions

memory Displays the RAM memory health statistics for all active NI modules in
the switch.
cpu Displays the CPU health statistics for all active NI modules.
rx Displays the health statistics for traffic received on all active NI mod-
ules.
txrx Displays the health statistics for traffic both transmitted and received on
all active NI modules.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show health all memory

* - current value exceeds threshold

1 Min 1 Hr 1 Hr
Memory Limit Curr Avg Avg Max
-----------------+-------+------+------+-----+----
01 80 40 40 40 40
02 80 40 40 40 40
03 80 40 40 40 40
04 80 40 40 40 40
05 80 40 40 40 40
06 80 40 40 40 40
07 80 40 40 40 40
13 80 40 40 40 40

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 44-9
show health all Health Monitoring Commands

output definitions
Memory (Cpu, TXRX, RX) A list of all currently-active NI modules (i.e., active slots) on the
switch. The column header corresponds with the resource keyword
entered. For example, if show health all cpu is entered, Cpu is used as
the column header.
Limit Current usage threshold for the specified resource type, on the corre-
sponding slot (in percent). The usage threshold refers to the maximum
amount of the resource’s total bandwidth that can be used by switch
applications before a notification is sent to the user. The default value
for all resource types is 80 percent. This threshold can be changed
using the health threshold command.
Curr Current usage of the resource on the corresponding slot, in percent (the
amount of the total resource bandwidth actually being used by the
switch applications).
1 Min Avg Average usage of the resource on the corresponding slot over a one
minute period.
1 Hr Avg Average usage of the resource on the corresponding slot over a one
hour period.
1 Hr Max The highest average hourly usage for the resource on the corresponding
slot.

Release History
Release 8.1.1; command introduced.

Related Commands

show health Displays the health statistics for the switch.

health threshold Configures thresholds for input traffic (RX), output/input traffic
(TX/RX), memory usage, CPU usage, and chassis temperature.

MIB Objects
healthModuleTable
healthModuleSlot
healthModuleRxLatest
healthModuleRx1MinAvg
healthModuleRx1HrAvg
healthModuleRx1HrMax
healthModuleRxTxLatest
healthModuleRxTx1MinAvg
healthModuleRxTx1HrAvg
healthModuleRxTx1HrMax
healthModuleMemoryLatest
healthModuleMemory1MinAvg
healthModuleMemory1HrAvg
healthModuleMemory1HrMax
healthModuleCpuLatest
healthModuleCpu1MinAvg
healthModuleCpu1HrAvg
healthModuleCpu1HrMax

page 44-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
45 Ethernet OAM Commands

Service provider networks are large and complex with a wide user base, and they often involve different
operators that must work together in order to provide end-to-end services to enterprise customers.
Operations, Administration, and Maintenance (OAM) provides service assurance over a converged
network that service providers are looking for in an Ethernet network. Ethernet OAM addresses areas such
as availability, mean time to repair and more. Ethernet OAM focuses on two main areas that are most in
need by service providers and are rapidly evolving in the standards bodies, Service OAM and Link OAM.
These two OAM protocols have unique objectives but are complementary to each other. Service OAM
provides monitoring and troubleshooting of end-to-end Ethernet service instances, while Link OAM
allows a provider to monitor and troubleshoot an individual Ethernet link.
MIB information for the Ethernet OAM commands is as follows:
Filename: AlcatelIND1Eoam.MIB
Module: Alcatel-IND1-ETHERNET-OAM-MIB
Filename: IETF_802_1ag.MI
Module: IEEE8021-CFM-MIB
A summary of the available commands is listed here:

EthOAM vlan Configuration ethoam vlan

Commands
EthOAM Domain ethoam domain
Configuration Commands ethoam domain mhf
ethoam domain id-permission
EthOAM Management ethoam association
Association Configuration ethoam association mhf
Commands
ethoam association id-permission
ethoam association ccm-interval
ethoam association endpoint-list
clear ethoam statistics
EthOAM Default-Domain ethoam default-domain level
Configuration Commands ethoam default-domain mhf
ethoam default-domain id-permission
ethoam default-domain primary-vlan
EthOAM Management Point ethoam endpoint
Configuration Commands ethoam endpoint admin-state
ethoam endpoint rfp
ethoam endpoint ccm
ethoam endpoint priority
ethoam endpoint lowest-defect-priority

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-1
 Ethernet OAM Commands

EthOAM Loopback and ethoam linktrace

Linktrace Commands ethoam loopback
EthOAM Timer ethoam fault-alarm-time
Configuration Commands ethoam fault-reset-time
EthOAM Performance ethoam one-way-delay
Monitoring Configuration ethoam two-way-delay
Commands clear ethoam
EthOAM Show Commands show ethoam
show ethoam domain
show ethoam domain association
show ethoam domain association end-point
show ethoam default-domain configuration
show ethoam default-domain
show ethoam remote-endpoint domain
show ethoam cfmstack
show ethoam linktrace-reply
show ethoam linktrace-tran-id
show ethoam vlan
show ethoam statistics
show ethoam config-error
show ethoam one-way-delay
show ethoam two-way-delay

page 45-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam vlan

ethoam vlan
Creates an association between Primary VID and Non-Primary VID(s).
ethoam vlan {vlanid-list} primary-vlan {vlan-id}
no ethoam vlan {vlanid-list}

Syntax Definitions

vlanid-list VLAN Identifier List e.g. ‘10 30-40’ or ‘10’

vlan-id VLAN Identifier e.g. ‘20’

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Each VLAN ID specified must be created before creating any association.

• Each VLAN ID specified must be between 1 and 4094.

• Each VLAN ID specified must be static.

• A Non-Primary VID can only be associated with single Primary VID only.

• Once Primary VID is associated with Non-Primary VID, then it can not be configured as Non-Primary
VID. Its association must be removed before it is configured as Non-Primary VID.
• This CLI shall trigger Automip for this VLAN, if either ‘mhf’ is enabled for MA or default-MD with
primary VLAN same as the primary VLAN of this VLAN.
• If the VLAN is deleted using VLAN CLI (no vlan <vid>) and VLAN is non-primary, then the entry for
this VLAN in the VLAN table will be deleted. This shall in turn delete all MEPs and MIPs associated
with it. If the deleted VLAN is primary VLAN, then all its associated VLAN entries in the VLAN table
shall be deleted. This shall in turn delete all MAs on this deleted VLAN.
• Use the no form of this command to dissociate Primary VID from the Non-Primary VID(s).

Examples
-> ethoam vlan 10 primary-vlan 20
-> ethoam vlan 11-15 primary-vlan 20
-> ethoam vlan 30 40-50 primary-vlan 20
-> no ethoam vlan 10

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-3
ethoam vlan Ethernet OAM Commands

Related Commands

show ethoam vlan Displays the Ethernet OAM statistics of all the Management
Domains configured on the bridge.

MIB Objects
dot1agCfmVlanTable
dot1agCfmVlanComponentId
dot1agCfmVlanVid
dot1agCfmVlanPrimaryVid
dot1agCfmVlanRowStatus

page 45-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam domain

ethoam domain
Creates an Ethernet domain with a specific name.
ethoam domain name format {none | dnsname | mac-address-uint | string} level num
no ethoam domain name

Syntax Definitions

name Specifies the domain name used while creating the management domain
for which this management association is created.
none This format is supported for the inter-op with ITU-T Y.1731.
string Character String.
mac-address-unit MAC address + 2-octet (unsigned) integer.
dnsname Domain Name like string, globally unique text string derived from a
DNS name.
num MD Level and it ranges from 0 to 7

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Maximum domain length is 43.

• Use format as ‘none’ for inter-op with ITU-T Y.1731.

• Domain name is unique in a system.

• Deletion of MD shall result in the deletion of all MAs, MEPs and MIPs configured in it.

Examples
-> ethoam domain MD format none level 3
-> ethoam domain MD1 format string level 4

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-5
ethoam domain Ethernet OAM Commands

Related Commands

show ethoam Displays the information of all the Management Domains (MD)
configured on the bridge.
show ethoam domain Displays the information of a specific Management Domain
configured on the bridge.

MIB Objects
dot1agCfmMdTable
dot1agCfmMdName
dot1agCfmMdFromat
dot1agCfmMdLevel

page 45-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam domain mhf

ethoam domain mhf

Configure the Message Handling Function (MHF) value for MD entry.
ethoam domain name mhf {none | explicit | default}

Syntax Definitions

name Specifies the domain name used while creating the management domain
for which this management association is created.
none No MHFs can be created.
default MHFs can be created.
explicit MHFs can be created only if a MEP is created at some lower MD Level.

Defaults

parameter default
none | explicit | default none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Domain must be created before it is modified.

Examples
-> ethoam domain MD mhf default

Release History
Release 8.1.1; command was introduced.

Related Commands

show ethoam Displays the information of all the Management Domains (MD)
configured on the bridge.

MIB Objects
dot1agCfmMdTable
dot1agCfmMdName
dot1agCfmMdMhfCreation

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-7
ethoam domain id-permission Ethernet OAM Commands

ethoam domain id-permission

Configures the ID-permission value for MD entry.
ethoam domain name id-permission {none | chassisid}

Syntax Definitions

name Specifies the domain name used while creating the management domain
for which this management association is created.
none Sender ID TLV is not to be sent.
chassisid Chassis ID Length, Chassis ID Subtype and Chassis ID TLV are to be
present.System name shall be filled as Chassis ID.

Defaults

parameter default
none | chassisid none

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Domain must be created before it is modified.

Examples
-> ethoam domain MD id-permission chassisid

Release History
Release 8.1.1; command was introduced.

Related Commands

show ethoam default-domain Displays the values of scalar Default-MD objects.

configuration
show ethoam domain Displays the information of a specific Management Domain
configured on the bridge.

MIB Objects
dot1agCfmMdTable
dot1agCfmMdName
dot1agCfmMdIdPermission

page 45-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam association

ethoam association
Creates Maintenance Association (MA) entry.
ethoam association ma_name format {vpnid | unsignedint | string | primaryvid | icc-based} domain
md_name primary-vlan vlan-id
no ethoam association ma_name domain md_name

Syntax Definitions

ma_name Association name for the created Ethernet OAM Association.

vpnid As specified in RFC 2685 VPN ID.
unsignedint 2-octet unsigned integer.
string Character String.
primaryvid Primary VLAN ID (12 bits represented in a 2-octet integer).
icc-based This format is supported for inter-op with ITU-T.
md_name Specifies the domain name used while creating the management domain
for which this management association is created.
vlan-id Primary VLAN Identifier.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Maximum association name is name 44 minus the length of its domain name.

• Use format as ‘icc-based’ to inter-op with ITU-T Y.1731.

• Domain must be created before the creation of MA.

• VLAN must be created before the creation of MA.

• VLAN specified must be a primary VID.

• VLAN ID specified must be between 1 and 4094.

• Deletion of MA shall result in the deletion of MIPs and MEPs (on primary and non-primary VLAN)
configured in it.

Examples
-> ethoam association MA format string domain MD primary-vlan 100

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-9
ethoam association Ethernet OAM Commands

Release History
Release 8.1.1; command was introduced.

Related Commands

show ethoam domain Displays the information of a specified MA in a Management

association Domain configured on the bridge.

MIB Objects
dot1agCfmMaNetTable
dot1agCfmMaNetFormat
dot1agCfmMaNetName
dot1agCfmMaNetRowStatus
dot1agCfmMaCompTable
dot1agCfmMaComponentId
dot1agCfmMaCompPrimaryVid
dot1agCfmMaCompRowStatus

page 45-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam association mhf

ethoam association mhf

Configures the MIP Half Function (MHF) value for MA Entry.
ethoam association ma_name domain md_name mhf {none | default | explicit | defer}

Syntax Definitions

ma_name Association name for the created Ethernet OAM Association.

md_name Specifies the domain name used while creating the management domain
for which this management association is created.
none No MHFs can be created.
default MHFs can be created.
explicit MHFs can be created only if a MEP is created at some lower MD Level.
defer The creation of MHFs is determined by the corresponding MD object
‘dot1agCfmMdMhfCreation’.

Defaults

parameter default
none | explicit | default | defer defer

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• MA must be created before it is modified.

• On modification of ‘mhf’ for any MA, Automip shall also be invoked for all VLANS associated with
this primary VID.

Examples
-> ethoam association MA domain MD mhf-creation defer

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-11
ethoam association mhf Ethernet OAM Commands

Related Commands

show ethoam domain Displays the information of a specified MA in a Management

association Domain configured on the bridge.
show ethoam default-domain Displays the information of the default MA.

MIB Objects
dot1agCfmMaNetTable
dot1agCfmMaNetName
dot1agCfmMaCompTable
dot1agCfmMaCompMhfCreation

page 45-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam association id-permission

ethoam association id-permission

Configure id-permission value for MA Entry.
ethoam association ma_name domain md_namemd_name id-permission {none | chassisid | defer}

Syntax Definitions

md_name Association name for the created Ethernet OAM Association.

ma_namema_name Specifies the domain name used while creating the management domain
for which this management association is created.
none Sender ID TLV is not to be sent.
chassisid Chassis ID Length, Chassis ID Subtype and Chassis ID TLV are to be
present.
defer The contents of the Sender ID TLV are determined by the corresponding
MD object ‘dot1agCfmMdIdPermission’.

Defaults

parameter default
none |chassisid | defer defer

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
MA must be created before it is modified.

Examples
-> ethoam association MA domain MD id-permission defer

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-13
ethoam association id-permission Ethernet OAM Commands

Related Commands

show ethoam domain Displays the information of a specified MA in a Management

association Domain configured on the bridge.
show ethoam domain Displays the information of a specific Management Domain
configured on the bridge.

MIB Objects
dot1agCfmMaNetTable
dot1agCfmMaNetName
dot1agCfmMaCompTable
dot1agCfmMaCompMIdPermission

page 45-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam association ccm-interval

ethoam association ccm-interval

Modifies the Continuity Check Message (CCM) transmission interval of an Ethernet OAM Maintenance
Association.
ethoam association association_name domain {domain_name | mac_address} ccm-interval {interval-
invalid | interval100ms | interval1s | interval10s | interval1m | interval10m}

Syntax Definitions

ma_name Name of the Ethernet OAM Association. Up to 48 (minus the domain

name length) characters may be used.
md_name Specifies the domain name. For more information on the different
formats of the domain name, refer to ethoam domain command on
page 45-5.
interval-invalid Specifies that no CCMs are sent by a MEP
interval100ms Specifies the CCMs are sent every 100 milli seconds.
interval1s Specifies that CCMs are sent every 1 second.
interval10s Specifies that CCMs are sent every 10 seconds.
interval1m Specifies that CCMs are sent every minute.
interval10m Specifies that CCMs are sent every 10 minutes.

Defaults

parameter default
interval-invalid | interval10s
interval100ms | interval1s |
interval10s | interval1m |
interval10m

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The ma_name should be unique amid all those used by or available to the service provider within a
domain.

Examples
-> ethoam association MA domain MD ccm-interval interval10s

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-15
ethoam association ccm-interval Ethernet OAM Commands

Related Commands

show ethoam domain Displays the information of a specific Management Domain

configured on the bridge.

MIB Objects
dot1agCfmMaNetTable
dot1agCfmMaNetName
dot1agCfmMaCompTable
dot1agCfmMaCompMIdPermission

page 45-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam association endpoint-list

ethoam association endpoint-list

Modifies the MEP list of an Ethernet OAM Maintenance Association.
ethoam association ma_name domain {md_name | mac_add} endpoint-list mep_id[-mep_id2]
no ethoam association ma_name domain {md_name | mac_add} endpoint-list mep_id[-mep_id2]

Syntax Definitions

ma_name Name of the Ethernet OAM Association. Up to 48 (minus domain name

length) characters may be used.
md_name Specifies the domain name. For more information on the different
formats of the domain name, refer to ethoam domain command on
page 45-5
mac_add Specifies the CFM system MAC address.
mep_id Specifies the MEP number.
mep_id2 Last MEP number in a range of MEPs to configure.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the MEP list.

• Note that only the MEP that is associated with the MEP list of the MA can be configured locally on the
bridge or monitored remotely.
• The ma_name should be unique within a domain.

Examples
-> ethoam association MA domain MD endpoint-list 100-200
-> no ethoam association MA domain MD endpoint-list 100-200

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-17
ethoam association endpoint-list Ethernet OAM Commands

Related Commands

show ethoam domain Displays the information of a specified MA in a Management

association Domain configured on the bridge.

MIB Objects
dot1agCfmMdTable
dot1agCfmMdName
dot1agCfmMaNetTable
dot1agCfmMaNetName
Dot1agCfmMaMepList
dot1agCfmMaMepListIdentifier
dot1agCfmMaMepListRowStatus

page 45-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands clear ethoam statistics

clear ethoam statistics

Clear statistics for all MEPs or for a particular MEP.
clear ethoam statistics [domain md_name association ma_name endpoint mep-id]

Syntax Definitions

md_name Specifies the domain name. For more information on the different
formats of the domain name, refer to ethoam domain command on
page 45-5
ma_name Name of the Ethernet OAM Association. Up to 48 (minus domain name
length) characters may be used.
mep-id MEP Identifier. Valid Range is 1-8191.

Defaults
By default, statistics for all MEPs are cleared.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the optional domain, association, and endpoint keywords to clear statistics for a specific MEP.

Examples
-> clear ethoam statistics
-> clear ethoam statistics domain MD association MA endpoint 10

Release History
Release 8.1.1; command was introduced.

Related Commands

show ethoam statistics Displays the statistics of all the MAs and matching MEPs for all the
MDs.

MIB Objects
dot1agCfmMdTable
dot1agCfmMdName
dot1agCfmMaNetTable
dot1agCfmMaNetName
dot1agCfmMepTable
dot1agCfmMepIdentifier
alaCfmMepClearStats
alaCfmGlobalClearStats

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-19
ethoam default-domain level Ethernet OAM Commands

ethoam default-domain level

Configures the effective level of all default domain entries with the level value set to no level.
ethoam default-domain level {num}
no ethoam default-domain

Syntax Definitions

num The MD level. The valid range is 0-7.

Defaults
Default value is 0.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ethoam default-domain level 1

Release History
Release 8.1.1; command was introduced.

Related Commands

show ethoam default-domain Displays the values of scalar Default-MD objects.

configuration

MIB Objects
Dot1agCfmDefaultMdLevel

page 45-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam default-domain mhf

ethoam default-domain mhf

Configure the effective MHF value for all default domain entries with MHF value set to defer.
ethoam default-domain mhf {none | default | explicit}
no ethoam default-domain

Syntax Definitions

none No MHFs can be created.

default MHFs can be created.
explicit MHFs can be created only if a MEP is created at some lower MD Level.
Defaults

Defaults
Default value is none.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ethoam default-domain mhf default

Release History
Release 8.1.1; command was introduced.

Related Commands

show ethoam default-domain Displays the values of scalar Default-MD objects.

configuration

MIB Objects
dot1agCfmDefaultMdDefMhfCreation

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-21
ethoam default-domain id-permission Ethernet OAM Commands

ethoam default-domain id-permission

Configures the effective ID permission value for all default domain entries with the ID permission value
set to defer.
ethoam default-domain id-permission {none | chassisid}
no ethoam default-domain

Syntax Definitions

none Sender ID TLV is not to be sent.

chassisid Chassis ID Length, Chassis ID Subtype and Chassis ID TLV are to be
present.

Defaults
Default value is none.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> ethoam default-domain id-permission chassisid

Release History
Release 8.1.1; command was introduced.

Related Commands

show ethoam default-domain Displays the default domain configuration.

configuration

MIB Objects
dot1agCfmDefaultMdDefIdPermission

page 45-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam default-domain primary-vlan

ethoam default-domain primary-vlan

Configures the default domain settings for the specified primary VLAN.
ethoam default-domain primary-vlan {vlan-id} [level {no-level | num}] [mhf {none | default | explicit |
defer}] [id-permission {none | chassisid | defer}]
no ethoam default-domain

Syntax Definitions

vlan-id VLAN Identifier.

no-level MD level is inherited from the default domain level.
num MD Level. Valid range is 0 to 7.
none No MHFs can be created.
default MHFs can be created.
explicit MHFs can be created only if a MEP is created at some lower MD Level.
defer MHF defers to the default domain MHF value.
none Sender ID TLV is not to be sent.
chassisid Chassis ID Length, Chassis ID Subtype and Chassis ID TLV are to be
present.
defer ID permission defers to the default domain ID permission value.

Defaults

parameter default
no-level | num no-level
none | explicit | default | defer defer
none | chassisid | defer defer

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
On modification of MHF for any primary VID, Automip is invoked for all VLANS associated with this
primary VID.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-23
ethoam default-domain primary-vlan Ethernet OAM Commands

Examples
-> ethoam default-domain primary-vlan 10 id-permission chassid level 3 mhf default.
-> ethoam default-domain primary-vlan 10 id-permission chassid
-> ethoam default-domain primary-vlan 10 level 3
-> ethoam default-domain primary-vlan 10 mhf default
-> ethoam default-domain primary-vlan 10 level 3 mhf default

Release History
Release 8.1.1; command was introduced..

Related Commands

show ethoam default-domain Displays the information of all the default MD.

MIB Objects
dot1agCfmDefaultMdTable
dot1agCfmDefaultMdComponentId
dot1agCfmDefaultMdPrimaryVid
dot1agCfmDefaultMdLevel

page 45-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam endpoint

ethoam endpoint
Creates a Maintenance End Point (MEP) and virtual MEP.
ethoam endpoint mep-id domain md_name association ma_name direction { up | down }
{port {chassis//slot/port | virtual | linkagg agg_id} [primary-vlan vlan_id]
no ethoam endpoint mep-id domain md_name association ma_name

Syntax Definitions

mep_id Specifies the Maintenance Association End Point. The valid range is 1–
8191.
md_name Specifies the domain name used while creating the management domain
for which this management association is created.
ma_name Association name for the created Ethernet OAM Association.
up For UP MEP.
down For DOWN MEP.
chassis The chassis identifier.
slot/port Physical slot and port number on which MEP needs to be created.
virtual Keyword for creating virtual MEP.
agg_id Linkagg Identifier on which MEP needs to be created.
vlan_id VLAN identifier.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete a maintenance endpoint.

• The mep_id must be unique amid all those used by or available to the service provider in the specified
MA.
• The direction for virtual MEP must always be up.

• For creating a virtual MEP the value of port must be given the keyword “virtual”.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-25
ethoam endpoint Ethernet OAM Commands

Examples
-> ethoam endpoint 10 domain MD association MA direction up port 1/1
-> ethoam endpoint 10 domain MD association MA direction down linkagg 1
-> ethoam endpoint 10 domain MD association MA direction down linkagg 1 vlan 10
-> ethoam endpoint 1 domain md1 association ma1 direction up port virtual primary-
vlan 100
-> no ethoam endpoint 10 domain MD association MA

Release History
Release 8.1.1; command was introduced.

Related Commands

show ethoam domain Displays the information of a specific MEP in a Management

association end-point Domain configured on the bridge.

MIB Objects
dot1agCfmMdTable
dot1agCfmMdName
dot1agCfmMaNetTable
dot1agCfmMaNetName
dot1a gCfmMepTable
dot1agCfmMepIdentifier
dot1agCfmMepDirection
dot1agCfmMepIfIndex
dot1agCfmMepPrimaryVid

page 45-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam endpoint admin-state

ethoam endpoint admin-state

Configures the administrative state of MEP.
ethoam endpoint mep_id domain {md_name | mac_address} association ma_name admin-state {enable
| disable}

Syntax Definitions

mep_id Specifies the Maintenance Association End Point. The valid range is 1–
8191.
md_name Specifies the domain name used while creating the management domain
for which this management association is created.
mac_address Specifies the CFM system MAC address.
ma_name Association name of the Ethernet OAM Association. Up to 48 (minus
the domain name length) characters may be used.
enable Administratively enables MEP.
disable Administratively disables MEP.

Defaults
The default value is disable.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The mep_id specified must already exist in the switch configuration.

Examples
-> ethoam endpoint 100 domain MD association MA admin-state enable

Release History
Release 8.1.1; command was introduced.

Related Commands

show ethoam domain Displays the information of a specific MEP in a Management

association end-point Domain configured on the bridge.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-27
ethoam endpoint admin-state Ethernet OAM Commands

MIB Objects
Dot1agCfmMep
dot1agCfmMepIndex
dot1agCfmMepIdentifier
dot1agCfmMepDirection
dot1agCfmMepPortNumber
dot1agCfmMepMacAddress
dot1agCfmMepAdminStatus
dot1agCfmMepFngState
dot1agCfmMepCcmEnabled
dot1agCfmMepCcmTransmitting
dot1agCfmMepCcmLtmPriority
dot1agCfmMepCcmNotReceived
dot1agCfmMepCcmStreamError
dot1agCfmMepCcmStreamOther
dot1agCfmMepRdiReceived
dot1agCfmMepLastCcmMaFault
dot1agCfmMepLastCcmCrossConnFault
dot1agCfmMepCcmOut
dot1agCfmMepLbmNextSeqNumber
dot1agCfmMepLbrIn
dot1agCfmMepLbrInOutOfOrder
dot1agCfmMepLbrOut
dot1agCfmMepLtmNextSeqNumber
dot1agCfmMepLtmIn
dot1agCfmMepLtrOut
dot1agCfmMepDefectsPresent
dot1agCfmMepDefectsAbsent
dot1agCfmMepRowStatus

page 45-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam endpoint rfp

ethoam endpoint rfp

Enables or disables the Remote Fault Propagation (RFP) on MEP.
ethoam endpoint mep_id domain {md_name | mac_address} association ma_name rfp {enable |
disable}

Syntax Definitions

mep_id Specifies the Maintenance Association End Point. The valid range is 1–
8191.
md_name Specifies the domain name used while creating the management domain
for which this management association is created.
mac_address Specifies the CFM system MAC address.
ma_name Association name of the Ethernet OAM Association. Up to 48 (minus
the domain name length) characters may be used.
enable Administratively enables RFP on MEP.
disable Administratively disables RFP on MEP.

Defaults
The default value of RFP is disable.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• The mep_id specified must already exist in the switch configuration.

• The domain and association must be created before RFP can be enabled.

• The MEP must be an UP MEP. If down MEP is specified, CLI returns with an error.

• The admin state of the MEP must be enabled in order to report faults.

• RFP cannot be enabled on virtual UP MEP since it is not associated with a physical interface.

• It is recommended that if RFP is enabled on a port, then any other violation feature (Link Monitoring
or Link Fault Propagation) should not be configured.
• It is recommended that if RFP is enabled on a port, then automatic recovery is disabled for that port.

• If Link Monitoring is configured on a RFP enabled port, then the wait-to-restore timer must be less
than the CCM interval.

Examples
-> ethoam endpoint 1 domain md1 association ma1 rfp enable

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-29
ethoam endpoint rfp Ethernet OAM Commands

Release History
Release 8.1.1; command was introduced.

Related Commands

show ethoam domain Displays the information of a specific MEP in a Management

association end-point Domain configured on the bridge.

MIB Objects
Dot1agCfmMDTable
dot1agCfmMdName
dot1agCfmMaNetTable
dot1agCfmMaNetName
dot1agCfmMepTable
dot1agCfmMepIdentifier
dot1agCfmRfpEnabled

page 45-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam endpoint ccm

ethoam endpoint ccm

Configures the MEP to generate Continuity Check Messages (CCM).
ethoam endpoint mep_id domain {md_name | mac_address} association ma_name ccm {enable |
disable}

Syntax Definitions

mep_id Specifies the Maintenance Association End Point. The valid range is 1–
8191.
md_name Specifies the domain name. For more information on the different
formats of the domain name, refer to ethoam domain.
mac_address Specifies the CFM system MAC address.
ma_name Name of the Ethernet OAM association. Up to 48 (minus the domain
name length) characters may be used.
enable Enables MEP to generate CCMs.
disable Disables MEP to generate CCMs.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The mep_id should be unique amid all those used by or available to the service provider in the specified
MA.

Examples
-> ethoam endpoint 100 domain MD association MA ccm enable

Release History
Release 8.1.1; command was introduced.

Related Commands

show ethoam domain Displays the information of a specific MEP in a Management

association end-point Domain configured on the bridge.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-31
ethoam endpoint ccm Ethernet OAM Commands

MIB Objects
Dot1agCfmMep
dot1agCfmMepIndex
dot1agCfmMepIdentifier
dot1agCfmMepDirection
dot1agCfmMepPortNumber
dot1agCfmMepMacAddress
dot1agCfmMepAdminStatus
dot1agCfmMepFngState
dot1agCfmMepCcmEnabled
dot1agCfmMepCcmTransmitting
dot1agCfmMepCcmLtmPriority
dot1agCfmMepCcmNotReceived
dot1agCfmMepCcmStreamError
dot1agCfmMepCcmStreamOther
dot1agCfmMepRdiReceived
dot1agCfmMepLastCcmMaFault
dot1agCfmMepLastCcmCrossConnFault
dot1agCfmMepCcmOut
dot1agCfmMepLbmNextSeqNumber
dot1agCfmMepLbrIn
dot1agCfmMepLbrInOutOfOrder
dot1agCfmMepLbrOut
dot1agCfmMepLtmNextSeqNumber
dot1agCfmMepLtmIn
dot1agCfmMepLtrOut
dot1agCfmMepDefectsPresent
dot1agCfmMepDefectsAbsent
dot1agCfmMepRowStatus

page 45-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam endpoint priority

ethoam endpoint priority

Configures the priority values for CCMs and Linktrace Messages (LTMs) transmitted by a MEP.
ethoam endpoint mep_id domain {md_name | mac_address} association ma_name priority
ccm_ltm_priority

Syntax Definitions

mep_id Specifies the Maintenance Association End Point. The valid range is 1–
8191.
md_name Specifies the domain name. For more information on the different
formats of the domain name, refer to ethoam domain command on
page 45-5.
mac_address Specifies the CFM system MAC address.
ma_name Name of the Ethernet OAM Association. Up to 48 (minus the domain
name length) characters may be used.
ccm_ltm_priority Priority value for CCMs and LTMs transmitted by the MEP. The valid
range is 0–7.

Defaults

parameter default
ccm_ltm_priority 7

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The mep_id should be unique amid all those used by or available to the service provider in the specified
MA.

Examples
-> ethoam endpoint 100 domain MD association MA priority 6

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-33
ethoam endpoint priority Ethernet OAM Commands

Related Commands

show ethoam domain Displays the information of a specific MEP in a Management

association end-point Domain configured on the bridge.

MIB Objects
Dot1agCfmMep
dot1agCfmMepIndex
dot1agCfmMepIdentifier
dot1agCfmMepDirection
dot1agCfmMepPortNumber
dot1agCfmMepMacAddress
dot1agCfmMepAdminStatus
dot1agCfmMepFngState
dot1agCfmMepCcmEnabled
dot1agCfmMepCcmTransmitting
dot1agCfmMepCcmLtmPriority
dot1agCfmMepCcmNotReceived
dot1agCfmMepCcmStreamError
dot1agCfmMepCcmStreamOther
dot1agCfmMepRdiReceived
dot1agCfmMepLastCcmMaFault
dot1agCfmMepLastCcmCrossConnFault
dot1agCfmMepCcmOut
dot1agCfmMepLbmNextSeqNumber
dot1agCfmMepLbrIn
dot1agCfmMepLbrInOutOfOrder
dot1agCfmMepLbrOut
dot1agCfmMepLtmNextSeqNumber
dot1agCfmMepLtmIn
dot1agCfmMepLtrOut
dot1agCfmMepDefectsPresent
dot1agCfmMepDefectsAbsent
dot1agCfmMepRowStatus

page 45-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam endpoint lowest-defect-priority

ethoam endpoint lowest-defect-priority

Configures the lowest priority fault alarm for the lowest priority defect for an MEP.
ethoam endpoint mep_id domain {md_name | mac_address} association ma_name lowest-defect-
priority lowest_defect_priority

Syntax Definitions

mep_id Specifies the Maintenance Association End Point. The valid range is 1–
8191.
md_name Specifies the domain name. For more information on the different
formats of the domain name, refer to ethoam domain command on
page 45-5.
mac_address Specifies the CFM system MAC address.
ma_name Name of the Ethernet OAM Association. Up to 48 (minus the domain
name length) characters may be used.
lowest_defect_priority The lowest defect priority that can generate a Fault alarm. Possible
values are xcon, rem-err-xcon, no-defect, mac-rem-err-xcon, err-
xcon, and all-defect.

Defaults

parameter default
lowest_defect_priority mac-rem-err-
xcon

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
The mep_id should be unique amid all those used by or available to the service provider in the specified
MA.

Examples
-> ethoam endpoint 100 domain esd.alcatel-lucent.com association alcatel-sales
lowest-defect-priority all-defect

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-35
ethoam endpoint lowest-defect-priority Ethernet OAM Commands

Related Commands

show ethoam domain Displays the information of a specific MEP in a Management

association end-point Domain configured on the bridge.

MIB Objects
Dot1agCfmMep
dot1agCfmMepIndex
dot1agCfmMepIdentifier
dot1agCfmMepDirection
dot1agCfmMepPortNumber
dot1agCfmMepMacAddress
dot1agCfmMepAdminStatus
dot1agCfmMepFngState
dot1agCfmMepCcmEnabled
dot1agCfmMepCcmTransmitting
dot1agCfmMepCcmLtmPriority
dot1agCfmMepCcmNotReceived
dot1agCfmMepCcmStreamError
dot1agCfmMepCcmStreamOther
dot1agCfmMepRdiReceived
dot1agCfmMepLastCcmMaFault
dot1agCfmMepLastCcmCrossConnFault
dot1agCfmMepCcmOut
dot1agCfmMepLbmNextSeqNumber
dot1agCfmMepLbrIn
dot1agCfmMepLbrInOutOfOrder
dot1agCfmMepLbrOut
dot1agCfmMepLtmNextSeqNumber
dot1agCfmMepLtmIn
dot1agCfmMepLtrOut
dot1agCfmMepDefectsPresent
dot1agCfmMepDefectsAbsent
dot1agCfmMepRowStatus

page 45-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam linktrace

ethoam linktrace
Enables the maintenance entity to initiate transmitting Link Trace Messages (LTM).
ethoam linktrace {target-macaddress mac_address | target-endpoint t_mepid} source-endpoint
s_mepid domain {md_name | mac_address} association ma_name [flag [fdb-mpdb | fdbonly]] [hop-
count hop_count]

Syntax Definitions

mac_address Target MAC address to be transmitted.

t_mepid Specifies the MEP for which the Loopback message is targeted.
s_mepid Specifies the MEP that transmits the Loopback message. The valid
range is 1–8191.
md_name Specifies the domain name. For more information on the different
formats of the domain name, refer to ethoam domain.
domain mac_address Specifies the CFM system MAC address.
ma_name Name of the Ethernet OAM Association. Up to 48 (minus the domain
name length) characters may be used.
fdbonly Specifies that only the MAC addresses learned in a bridge's active data
forwarding table will be used to decide the egress port.
hop_count Indicates the number of hops remaining in this LTM. Each bridge that
handles the LTM decreases the value by 1. This decreased value is
returned to the LTM. The valid range is 1–2^32.

Defaults

parameter default
flag fdbonly

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command allows an operator to generate a LTM for the specified MEP.

• This command signals the MEP that it should transmit a Linktrace message and detect the presence or
lack of the corresponding Linktrace messages.

Examples
-> ethoam linktrace target-macaddress 10:aa:ac:12:12:ad source 4 domain MD
association flag fdbonly hop-count 32
Transaction Id: 6943
-> ethoam linktrace target-endpoint 15 source 4 domain MD association
Transaction Id: 6934

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-37
ethoam linktrace Ethernet OAM Commands

Release History
Release 8.1.1; command was introduced.

Related Commands

show ethoam domain Displays the information of a specified Management Domain

configured on the bridge.

MIB Objects
Dot1agCfmMep
dot1agCfmMepIdentifier
dot1agCfmMepTransmitLtmFlags
dot1agCfmMepTransmitLtmTargetMacAddress
dot1agCfmMepTransmitLtmTargetMepId
dot1agCfmMepTransmitLtmTargetlsMepId
dot1agCfmMepTransmitLtmTtl
dot1agCfmMepTransmitLtmResult
dot1agCfmMepTransmitEgressIdentifier

page 45-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam loopback

ethoam loopback
Initiates the transmission of loopback messages from the specified source MEP to the specified target
MEP or MAC address. Also triggers the source MEP to detect the presence or lack of a corresponding
loopback reply from the target.
ethoam loopback {target-endpoint t_mepid | target-macaddress mac_add} source-endpoint s_mepid
domain md_name association ma_name [number num] [data string] [vlan-priority vlan_priority]
[drop-eligible {true | false}]

Syntax Definitions

t_mepid Specifies the MEP for which the Loopback message is targeted. The
valid range is 1-8191.
mac_add Target MAC address to be transmitted.
s_mepid Specifies the MEP that transmits the Loopback message. The valid
range is 1–8191.
md_name Specifies the domain name. For more information on the different
formats of the domain name, refer to ethoam domain.
ma_name Name of the Ethernet OAM Association. Up to 48 (minus the domain
name length) characters may be used.
num Number of loopback messages. Valid range is 1–10.
string Specifies the amount of data to be included in the Data Type Length
Value (TLV), if the Data TLV is selected to be sent. The valid range is
1–255.
vlan_priority VLAN Priority. Valid range is 0–7.
true Sets the drop eligibility bit in the VLAN tag to true.
false Sets the drop eligibility bit in the VLAN tag to false.

Defaults

parameter default
num 1
vlan_priority CCM priority
drop-eligible {true | false} true

Platforms Supported
OmniSwitch 6860, 6860E

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-39
ethoam loopback Ethernet OAM Commands

Usage Guidelines
• Source and target MEP-ID, MD and MA must already exist before loopback is initiated.

• If data TLV is not set, then it is not sent in the loopback message.

Examples
-> ethoam loopback target-endpoint 10 source-endpoint 20 domain MD association MA
number 3
Reply from 00:0E:B1:6B:43:89: bytes=64 seq=0 time=100ms
Reply form 00:0E:B1:6B:43:89: bytes=64 seq=0 time=112ms
Request timed out.
----00:E0:B1:6B:43:89 ETH-LB Statistics----
3 packets transmitted, 2 packets received, 33% packet loss
round-trip (ms) min/avg/max = 100/106/112

Release History
Release 8.1.1; command was introduced.

Related Commands

show ethoam domain Displays the information of a specified Management Domain

configured on the bridge.

MIB Objects
dot1agCfmMdTable
dot1agCfmMdName
dot1agCfmMaNetTable
dot1agCfmMaNetName
dot1agCfmMepTable
dot1agCfmMepIdentifier
dot1agCfmMepTransmitLbmDestMacAddress
dot1agCfmMepTransmitLbmDestMepId
dot1agCfmMepTransmitLbmDestIsMepId
dot1agCfmMepTransmitLbmMessages
dot1agCfmMepTransmitLbmDataTlv
dot1agCfmMepTransmitLbmVlanPriority
dot1agCfmMepTransmitLbmVlanDropEnable
dot1agCfmMepTransmitLbmStatus

page 45-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam fault-alarm-time

ethoam fault-alarm-time
Configures the timeout value for the Fault Notification Generation Alarm time that specifies the time
interval during which one or more defects should be detected before the fault alarm is issued.
ethoam fault-alarm-time centiseconds endpoint endpoint_id domain {md_name | mac_address}
association ma_name
no ethoam fault-alarm-time endpoint endpoint_id domain {md_name | mac_address} association
ma_name

Syntax Definitions

centiseconds The Fault Notification Generation Alarm timeout value, in centi

seconds. The valid range is 250–1000.
endpoint_id Specifies the MEP of a specific MA. The valid range is 1–8191.
md_name Specifies the domain name. For more information on the different
formats of the domain name, refer to ethoam domain command on
page 45-5.
ma_name Name of the Ethernet OAM Association. Up to 48 (minus the domain
name length) characters may be used.

Defaults

parameter default
centiseconds 250

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to restore the Fault Notification Generation Alarm timeout value to
the default value.
• The Fault Notification Generation Alarm timeout value is configurable per MEP.

Examples
-> ethoam fault-alarm-time 500 endpoint 100 domain esd.alcatel-lucent.com
association alcatel_sales
-> no ethoam fault-alarm-time endpoint 100 domain esd.alcatel-lucent.com
association alcatel_sales

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-41
ethoam fault-alarm-time Ethernet OAM Commands

Related Commands

show ethoam domain Displays the information of a specific MEP in a Management

association end-point Domain configured on the bridge.

MIB Objects
Dot1agCfmMep
dot1agCfmMepFngAlarmTime

page 45-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam fault-reset-time

ethoam fault-reset-time
Configures the timer value for the Fault Notification Generation Reset time that specifies the time interval
during which the fault alarm is re-enabled to process faults. The fault alarm will only be re-enabled if no
new faults are received during this time interval.
ethoam fault-reset-time centiseconds endpoint endpoint_id domain {mac_address | md_name}
association ma_name
no ethoam fault-reset-time endpoint endpoint_id domain {mac_address | md_name} association
ma_name

Syntax Definitions

centiseconds The Fault Notification Generation Reset timer value, in centi seconds.
The valid range is 250–1000.
mep_id Specifies the MEP of a specific MA. The valid range is 1–8191.
md_name Specifies the domain name. For more information on the different
formats of the domain name, refer to ethoam vlan command on
page 45-3.
ma_name Name of the Ethernet OAM Association. Up to 48 (minus the domain
name length) characters may be used.

Defaults

parameter default
centiseconds 1000

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to restore the Fault Notification Generation Reset timeout value to
the default value.
• The Fault Notification Generation Reset timer value is configurable per MEP.

Examples
-> ethoam fault-reset-time 250 end-point 100 domain esd.alcatel-lucent.com
association alcatel_sales
-> no ethoam fault-reset-time end-point 100 domain esd.alcatel-lucent.com
association alcatel_sales

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-43
ethoam fault-reset-time Ethernet OAM Commands

Related Commands

ethoam fault-alarm-time Configures the timeout value for the Fault Notification Generation
Alarm time.
show ethoam domain Displays the information of a specific MEP in a Management
association end-point Domain configured on the bridge.

MIB Objects
Dot1agCfmMep
dot1agCfmMepFngResetTime

page 45-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam one-way-delay

ethoam one-way-delay
Initiates a one-way-delay measurement (1DM) to determine the one-way frame delay (latency) and delay
variation (jitter) between two MEPs.
ethoam one-way-delay {target-endpoint t_mepid | target-macaddress mac_address} source-endpoint
s_mepid domain md_name association ma_name [vlan- priority vlan_priority]

Syntax Definitions

t_mepid Target MEP-ID. Valid Range 1-8191.

mac_address Target MAC-Address.
s_mepid Source MEP-ID. Vaild Range 1-8191.
md_name The maintenance domain name.
ma_name The maintenance association name.
vlan_priority VLAN Priority. Valid Range is 0-7.

Defaults

parameter default
vlan_priority 7

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Source MEP-ID, MD and MA must be created before initiating 1DM.

• When target-endpoint is specified then entry must be present in the RMEP table, no matter if its status
is RMEP_OK or RMEP_FAILED, before initiating 1DM. So target-macaddress can be used to
bypass such a restriction.
• Although the OmniSwitch implementation of Ethernet frame delay measurement (ETH-DM) is
compliant with ITU-T Y.1731, delay measurement can be performed for both ITU-T Y.1731 and IEEE
802.1ag MEPs.
• If the 1DM is initiated with a target-macaddress and an egress port is found for this MAC address,
then the 1DM frames are transmitted from that port. Otherwise, 1DM frames are flooded in the MEP’s
VLAN.
• One-way delay measurement requires NTP clock synchronization between the sending and receiving
MEPs.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-45
ethoam one-way-delay Ethernet OAM Commands

Examples
-> ethoam one-way-delay target-endpoint 10 source-endpoint 12 domain MD association
MA vlan-priority 4
-> ethoam one-way-dealy target-macaddress 00:e0:b1:6a:52:4c source-endpoint 12
domain MD association MA vlan-priority 4

Release History
Release 8.1.1; command was introduced.

Related Commands

show ethoam one-way-delay Displays the one-way-delay and jitter parameters for all entries or
for the MAC address of a specific MEP.

MIB Objects
dot1agCfmMdTable
dot1agCfmMdName
dot1agCfmMaNetTable
dot1agCfmMaNetName
dot1agCfmMepTable
dot1agCfmMepIdentifier
alaCfmMepTable
alaCfmMepOWDTMacAddress
alaCfmMepOWDTMepIdentifier
alaCfmMepOWDTPriority

page 45-46 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands ethoam two-way-delay

ethoam two-way-delay
Initiate a two-way-delay measurement to determine the round-trip latency and jitter between two MEPs.
The initiating MEP sends delay measurement message (DMM) frames to the receiving MEP. The receiv-
ing MEP responds with delay measurement reply (DMR) frames.
ethoam two-way-delay {target-endpoint t_mepid | target-macaddress mac_address} source-endpoint
s_mepid domain md_name association ma_name [vlan- priority vlan_priority]

Syntax Definitions

t_mepid Target MEP-ID. Valid Range 1-8191.

mac_address Target MAC-Address.
s_mepid Source MEP-ID. Vaild Range 1-8191.
md_name The maintenance domain name.
ma_name The maintenance association name.
vlan_priority VLAN Priority. Valid Range is 0-7.

Defaults

parameter default
vlan-priority 7

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Source MEP-ID, MD and MA must be created before initiating a two-way delay measurement.

• When target-endpoint is specified then entry must be present in the RMEP table, no matter if the
status is RMEP_OK or RMEP_FAILED, before initiating two-way-delay. So target-macaddress can
be used to bypass such a restriction.
• The CLI console will pause until all DMRs are received or maximum of 3 seconds to ensure that all the
DMRs have been returned. If the operation fails, then the appropriate message is displayed. If the oper-
ation is successful, no message is displayed.
• If the DMM is initiated by UP MEP with a target-macaddress and the egress port is found for this
MAC address, then DMM frames are transmitted from that port. Otherwise, DMM frames are flooded
in the MEP’s VLAN.
• Two-way delay measurement does not require NTP clock synchronization on the sending and receiv-
ing MEPs.
• Although the OmniSwitch implementation of Ethernet frame delay measurement (ETH-DM) is
compliant with ITU-T Y.1731, delay measurement can be performed for both ITU-T Y.1731 and IEEE
802.1ag MEPs.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-47
ethoam two-way-delay Ethernet OAM Commands

• This command initiates an on-demand OAM performance measurement. To set up continuous two-way
delay measurement, see the “Service Assurance Agent Commands” chapter for information about how
to configure a SAA for continuous two-way frame delay measurement.

Examples
-> ethoam two-way-delay target-endpoint 10 source-endpoint 12 domain MD associa-
tion MA vlan-priority 4
Reply from 00:0E:B1:6B:43:89 delay=2584us jitter=282us
-> ethoam two-way-delay target-macaddress 00:e0:b1:6a:52:4c source-endpoint 12
domain MD association MA vlan-priority 4
Reply form 00:E0:B1:6A:52:4C: delay=2584us jitter=282us

Release History
Release 8.1.1; command was introduced.

Related Commands

show ethoam two-way-delay Displays the two-way-delay delay and jitter parameters for all
entries or for the MAC address of a specific MEP.

MIB Objects
dot1agCfmMdTable
dot1agCfmMdName
dot1agCfmMaNetTable
dot1agCfmMaNetName
dot1agCfmMepTable
dot1agCfmMepIdentifier
alaCfmMepTable
alaCfmMepTWDTMacAddress
alaCfmMepTWDTMepIdentifier
alaCfmMepTWDTPriority

page 45-48 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands clear ethoam

clear ethoam
Delete all the one-way-delay or two-way-delay entries.
clear ethoam {one-way-delay-table | two-way-delay-table}

Syntax Definitions

one-way-delay-table Deletes all the one-way-delay entries.

two-way-delay-table Deletes all the two-way delay entries.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> clear ethoam one-way-delay-table
-> clear ethoam two-way-delay-table

Release History
Release 8.1.1; command was introduced.

Related Commands

ethoam one-way-delay Initiates the two one-way-delay messages from a particular MEP to
an RMEP.

MIB Objects
alaCfmGlobalOWDClear
alaCfmGlobalTWDClear

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-49
show ethoam Ethernet OAM Commands

show ethoam
Displays the information of all the Management Domains (MD) configured on the bridge.
show ethoam

Syntax Definitions

N/A

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
This command displays all the MAs for all the MDs.

Examples
-> show ethoam
System Configuration
Ethernet OAM system mac address: 00:D0:95:EC:84:B0,
Number of Maintenance Domains: 1
Maintenance Domain: esd.alcatel-lucent.com
Maintenance Association: alcatel-sales

output definitions
Ethernet OAM system mac The MAC address of the Ethernet OAM system.
address
Number of Maintenance The number of maintenance domains configured on the bridge.
Domains
Maintenance Domain The name of the maintenance domain.
Maintenance Association The name of the maintenance association.

Release History
Release 8.1.1; command was introduced.

Related Commands

ethoam domain Creates an Ethernet domain with a specific name.

page 45-50 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands show ethoam

MIB Objects
Dot1agCfmMd
dot1agCfmMdName
Dot1agCfmMa
dot1agCfmMaName

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-51
show ethoam domain Ethernet OAM Commands

show ethoam domain

Displays the information of a specific Management Domain configured on the bridge.
show ethoam domain md_name

Syntax Definitions

md_name Specifies the domain name used while creating the management domain
for which this management association is created.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ethoam domain MD
Total number of MAs configured in this MD = 1
MD Attributes
MD-Format : string,
MD-Level : level-3,
MD-MHFstatus : mhfNone,
MD-IdPermission : sendIdNone
Maintenance Association : MA
MA-Format : string,
Primary Vlan : 199,
Associated Vlan-list : none,
Total Number of Vlans : 1,
MA-MHFstatus : mhfNone,
MA-IdPermission : sendIdNone,
CCM-interval : interval10s,
MEP-List(MEP-Id) : 10

output definitions
MD-level The level at which the MD was created.
MD-MHFstatus Indicates whether the maintenance entity can create MHFs for this MD.
Options include none, explicit, or default.
Maintenance Association The name of the maintenance association.
Vlan The VLAN ID monitored by this MA. If the MA is not attached to any
VLAN, 0 will be displayed.
MA-MHFstatus Indicates whether the maintenance entity can create MHFs for this MA.
Options include none, explicit, or default.

page 45-52 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands show ethoam domain

output definitions (continued)

CCM-interval The interval between the CCM transmissions.
MEP-Id Indicates the Maintenance End Point.

Release History
Release 8.1.1; command was introduced.

Related Commands

show ethoam Displays the information of all the Management Domains (MD)
configured on the bridge.
ethoam domain Creates an Ethernet domain with a specific name.

MIB Objects
Dot1agCfmMd
dot1agCfmMdLevel
dot1agCfmMdMhfCreation
Dot1agCfmMa
dot1agCfmMaName
dot1agCfmMaVid
dot1agCfmMaMhfCreation
dot1agCfmMaCcmInterval
Dot1agCfmMep
dot1agCfmMepIdentifier

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-53
show ethoam domain association Ethernet OAM Commands

show ethoam domain association

Displays the information of a specific MA in a Management Domain configured on the bridge.
show ethoam domain md_name association ma_name

Syntax Definitions

md_name Specifies the domain name.

ma_name Name of the Ethernet OAM Association.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ethoam domain MD association MA
Total number of MEPs configured in this MA = 1
MA-Format : string,
Primary Vlan : 100,
Associated Vlan-list : none,
Total Number of Vlans : 1,
MA-MHFstatus : mhfDefer,
MA-IdPermission : sendIdDefer,
CCM-interval : interval10s,
MEP-List(MEP-Id) : 1-5,

Legend: MEP-Id: * = Inactive Endpoint

MEP-ID Admin State Direction Mac-Address Port Primary Vlan

--------+-----------+----------+-------------------+----------+----------------
1 disable up 00:E0:B1:A0:78:A3 virtual 100

output definitions
Primary Vlan The VLAN ID monitored by this MA. If the MA is not attached to any
VLAN, 0 will be displayed.
MA-MHFstatus Indicates whether the maintenance entity can create MHFs for this MA.
Options include none, explicit, or default.
CCM-interval The interval between the CCM transmissions.
MEP-ID Indicates the Maintenance End Point.

page 45-54 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands show ethoam domain association

output definitions (continued)

Admin State Indicates the administrative state (up or down) of the MEP.
Direction The direction of the MEP.
MAC Address The MAC address of the MEP.
Port The slot/port number of the Bridge port to which the MEP is attached.

Release History
Release 8.1.1; command was introduced.

Related Commands

ethoam association Creates an Ethernet OAM Maintenance Association in the specified

domain.

MIB Objects
Dot1agCfmMa
dot1agCfmMaVid
dot1agCfmMaMhfCreation
dot1agCfmMaCcmInterval
Dot1agCfmMep
dot1agCfmMepIdentifier
dot1agCfmMepActive
dot1agCfmMepDirection
dot1agCfmMepIfIndex
dot1agCfmMepMacAddress

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-55
show ethoam domain association end-point Ethernet OAM Commands

show ethoam domain association end-point

Displays the information of a specific MEP in a Management Domain configured on the bridge.
show ethoam domain md_name association ma_name end-point mep_id

Syntax Definitions

md_name Specifies the domain name.

ma_name Name of the Ethernet OAM Association.
mep_id Specifies the MEP of a specific MA. The valid range is 1–8191.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ethoam domain MD association MA endpoint 10
Admin State : disable,
Direction : up,
Slot/Port: virtual,
MacAddress: 00:E0:B1:A0:78:A3,
Fault Notification : FNG_RESET,
CCM Enabled : disabled,
RFP Status : enabled,
CCM Linktrace Priority : 7,
CCM Not Received : false,
CCM Error defect : false,
CCM Xcon defect : false,
MEP RDI defect : false,
MEP Last CCM Fault : not specified,
MEP Xcon Last CCM Fault : not specified,
MEP Error Mac Status : false,
MEP Lbm NextSeqNumber : 0,
MEP Ltm NextSeqNumber : 32157,
Fault Alarm Time : 250,
Fault Reset Time : 1000,
Lowest PrDefect Allowed : DEF_MAC_REM_ERR_XCON,
Highest PrDefect Present : DEF_NONE

output definitions
Admin State Indicates the administrative state (up or down) of the MEP.
Direction The direction of the MEP.

page 45-56 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands show ethoam domain association end-point

output definitions (continued)

Slot/Port The slot/port number of the Bridge port to which the MEP is attached.
If the value is virtual, it indicates a virtual port.
MAC Address The MAC address of the MEP.
Fault Notification Indicates the current state of the MEP Fault Notification Generator
State Machine, which can be FNG_RESET, FNG_DEFECT,
FNG_REPORT_DEFECT, FNG_DEFECT_REPORTED, or
FNG_DEFECT_CLEARING.
RFP Status Indicates the status of the RFP.
CCM Enabled Indicates whether the MEP generates CCMs (enabled) or not
(disabled).
CCM Linktrace Priority Indicates the priority value for CCMs and LTMs transmitted by the
MEP.
CCM Not Received Indicates if CCMs are not being received (true) or received (false)
from at least one of the configured remote MEPs.
CCM Error defect Indicates if a stream of erroneous CCMs is being received (true) or not
(false) from a MEP in this MA.
CCM Xcon defect Indicates if a stream of CCMs is being received (true) or not (false)
from a MEP that belongs to another MA.
MEP RDI Received Indicates that any other MEP in this MA is transmitting the RDI bit.
Options include true or false.
MEP Last CCM Fault The last-received CCM that triggered a MA fault.
MEP Xcon Last CCM Fault The last-received CCM that triggered a cross-connect fault.
MEP Error Mac Status Indicates a port status TLV. Options include true or false.
MEP Lbm NextSeqNumber The next Transaction Identifier or Sequence Number to be sent in an
LBM.
MEP Ltm NextSeqNumber The next Transaction Identifier or Sequence Number to be sent in an
LTM.
Fault Alarm Time The time interval during which one or more defects should be detected
before the fault alarm is issued
Fault Reset Time The time interval during which the fault alarm is re-enabled to process
faults
Lowest PrDefect Allowed The lowest priority defect that allowed to generate fault alarm.
Highest PrDefect Present The highest priority defect since the MEPs Fault Notification Generator
in reset state.

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-57
show ethoam domain association end-point Ethernet OAM Commands

Related Commands

ethoam endpoint Creates an Ethernet OAM Maintenance End Point in the specified
MA.
ethoam endpoint admin-state Configures the administrative state of MEP.

MIB Objects
Dot1agCfmMep
dot1agCfmMepActive
dot1agCfmMepDirection
dot1agCfmMepPortNumber
dot1agCfmMepMacAddress
dot1agCfmMepFngState
dot1agCfmMepCcmEnabled
dot1agCfmMepCcmLtmPriority
dot1agCfmMepSomeRMepCcmDefect
dot1agCfmMepErrorCcmDefect
dot1agCfmMepXconCcmDefect
dot1agCfmMepSomeRdiDefect
dot1agCfmMepErrorCcmLastFailure
dot1agCfmMepXconCcmLastFailure
dot1agCfmMepErrMacStatus
dot1agCfmMepLtmNextSeqNumber
dot1agCfmMepFngAlarmTime
dot1agCfmMepFngAlarmTime
dot1agCfmMepLowPrDef
dot1agCfmMepHighestPrDefect

page 45-58 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands show ethoam default-domain configuration

show ethoam default-domain configuration

Displays the level, MHF, and ID permission values for the default domain.
show ethoam default-domain configuration

Syntax Definitions

N/A

Defaults
N/A.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ethoam default-domain configuration
Level : 3,
MHF-Creation : mhfdefault,
ID-Permission : sendIdnone

output definitions
Level The level assigned to the default domain. Configured through the
ethoam default-domain level command.
MHF-creation Indicates the MHF value for a VLAN that is part of the default MD
Options include none, explicit, or default. Configured through the
ethoam default-domain mhf command.
ID-Permission The ID permision of the default domain. Configured through the
ethoam default-domain id-permission command.

Release History
Release 8.1.1; command was introduced.

Related Commands

show ethoam default-domain Displays the primary VLAN configuration for the default domain.

MIB Objects
dot1agCfmMaDefualtMdDefLevel
dot1agCfmMaDefualtMdDefMhfCreation

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-59
show ethoam default-domain configuration Ethernet OAM Commands

dot1agCfmMaDefualtMdDefIdPermission

page 45-60 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands show ethoam default-domain

show ethoam default-domain

Displays all the default MD information for all the primary VLANs or for a specific primary VLAN.
show ethoam default-domain [primary-vlan vlan_id]

Syntax Definitions

vlan_id The primary VLAN ID.

Defaults
By default, the default MD information for all primary VLANs is displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the vlan_id parameter with this command to view information about the default MD for a specific
primary VLAN.

Examples
-> show ethoam default-domain

Primary-Vlan Mhf-creation Level Id-Permission Status

--------------+-------------+-----------+--------------+--------
1 mhfDefer no-level sendIdDefer true
10 mhfDefault 3 sendIdNone true

-> show ethoam default-domain primary-vlan 10

Primary-Vlan Mhf-creation Level Id-Permission Status
--------------+-------------+-----------+--------------+--------
10 mhfDefault 3 sendIdNone true

output definitions
Primary Vlan The primary VLAN ID of the default MD.
Mhf-creation The primary VLAN ID MHF value (none, explicit, or default).
Level The primary VLAN level (no-level, 0–7).
Id-Permission The primary VLAN ID permission (none, chassid, or defer).

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-61
show ethoam default-domain Ethernet OAM Commands

Related Commands

ethoam default-domain Modifies the default domain for the specified primary VLAN.
primary-vlan

MIB Objects
Dot1agCfmDefaultMdLevel
dot1agCfmDefaultMdLevelVid
dot1agCfmDefaultMdLevelMhfCreation
dot1agCfmDefaultMdLevelLevel

page 45-62 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands show ethoam remote-endpoint domain

show ethoam remote-endpoint domain

Displays the information of all remote MEPs learned as a part of the CCM message exchange.
show ethoam remote-endpoint domain md_name association ma_name end-point s_mepid [remote-
mep r_mepid]

Syntax Definitions

md_name Specifies the domain name.

ma_name Specifies the name of the Ethernet OAM Association.
s_mepid Specifies the MEP of a specific MA. The valid range is 1–8191.
r_mepid The remote MEP. The valid range is 1–8191.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ethoam remote-endpoint domain MD association MA endpoint 10
Legends: PortStatusTlv: 1 = psBlocked, 2 = psUp, 0 = psNoTlv
InterfaceStatusTlv: 1 = ifUp, 2 = ifDown, 4 = ifUnknown, 0=ifNoTlv

RMEP-ID RMEP OkFailed Mac Address port I/f RDI Ch-id Ch-id
Status Time Tlv Tlv value Subtype
------+---------+------+-----------------+---+----+-----+--------+------
20 RMEP_OK 634600 00:E0:B1:6E:41:65 2 1 false LCL-ASND DUT-1
30 RMEP_OK 334600 00:E0:B1:6E:41:64 2 1 false LCL-ASND DUT-2

output definitions
MEP-ID Indicates the Maintenance End Point.
RMEP Status The operational state of the remote MEP Remote State machines for
this MEP, which can be RMEP_IDLE, RMEP_START,
RMEP_FAILED, or RMEP_OK.
OkFailed Time The time (SysUpTime) when the Remote MEP state machine last
entered either the RMEP_FAILED or RMEP_OK.
MacAddress The MAC address of the remote MEP.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-63
show ethoam remote-endpoint domain Ethernet OAM Commands

output definitions (continued)

Port Status Tlv The MAC status TLV last received.
I/f Status Tlv The interface status TLV last received.

Note: - Output shown above is not accurate as it is adjusted to display it in the

single row. Following are modified:
P/S Tlv - Port Status Tlv
I/F Tlv - I/F Status Tlv
Ch-id Subtype - Chassis ID Subtype
Ch-id - Chassis ID
LCL-ASND - LOCALLY_ASSIGNED

Release History
Release 8.1.1; command was introduced.

Related Commands

show ethoam domain Displays the information of a specific MEP in a Management

association end-point Domain configured on the bridge.

MIB Objects
dot1agCfmMepDbTable
dot1agCfmMepDbRMepIdentifier
dot1agCfmMepDbRMepState
dot1agCfmMepDbRMepFailedOkTime
dot1agCfmMepDbRdi
dot1agCfmMepDbPortStatusTlv
dot1agCfmMepDbInterfaceStatusTlv
dot1agCfmMepDbChassisIdSubtype
dot1agCfmMepDbChassisId

page 45-64 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands show ethoam cfmstack

show ethoam cfmstack

Displays the contents of CFM Stack Managed Object, which determines the relationships among MEPs
and MIPs on a specific bridge port.
show ethoam cfmstack {port chassis//slot/port | virtual | linkagg agg_num}

Syntax Definitions

chassis/slot/port The chassis ID, slot, and port number (3/1/1) for a specific port.
virtual Virtual port.
agg_num The aggregate ID for which the contents of the configured MEP or MIP
will be displayed.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ethoam cfmstack port 1/3
Up MHF Configured:
Vlan-id: 100,
Direction: up,
MAC-Address: 00:D0:95:EC:84:B0,
Maintenance Association: alcatel-sales,
Maintenance Domain: esd.alcatel-lucent.com,
MD-level: 3

Down MHF Configured:

Vlan-id: 100,
Direction: down,
MAC-Address: 00:D0:95:F6:33:DA,
Maintenance Association: alcatel-sales,
Maintenance Domain: esd.alcatel-lucent.com,
MD-level: 3

-> show ethoam cfmstack port virtual

MEP-Id 32 - Vlan 30:
Direction: up,
MAC-Address: 00:E0:B1:A5:F2:34,
Maintenance Association: MA4,
Maintenance Domain: MD4,
MD-level: 4

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-65
show ethoam cfmstack Ethernet OAM Commands

output definitions
Vlan-id The VLAN ID to which the MEP is attached.
Direction Indicates the direction (Inward or Outward) of the Maintenance Point
(MP) on the Bridge port.
MAC-Address The MEP ID configured on this port.
Maintenance Domain The name of the maintenance domain.
Maintenance Association The name of the maintenance association.
MD-level The MD level at which the MD was created.

Release History
Release 8.1.1; command was introduced.

Related Commands

ethoam endpoint admin-state Creates an Ethernet OAM Maintenance End Point in the specified
MA.

MIB Objects
Dot1agCfmMd
dot1agCfmMdName
Dot1agCfmMa
dot1agCfmMaName
Dot1agCfmStack
dot1agCfmStackVlanIdOrNone
dot1agCfmStackDirection
dot1agCfmStackMacAddress
dot1agCfmStackMdLevel

page 45-66 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands show ethoam linktrace-reply

show ethoam linktrace-reply

Displays the content of the Linktrace reply (LTR) returned by a previously transmitted LTM. This
command displays the LTR based on the transaction identifier or sequence number of the LTM for which
the LTR is to be displayed.
show ethoam linktrace-reply domain md_name association ma_name endpoint s_mepid tran-id num

Syntax Definitions

md_name Specifies the domain name.

ma_name Name of the Ethernet OAM Association.
s_mepid Specifies the MEP for which LTR is to be displayed. The valid range is
1–8191.
num Specifies the Transaction ID or sequence number returned from a
previously transmitted LTM.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• “LTM operation successful. Target is reachable.” – This message suggests that LTM has reached the
target and all the expected LTRs have been received.
• “LTM operation unsuccessful. Target not reachable.” – This message suggests that LTM is success-
fully initiated but the target is not reachable.
• “LTM operation unsuccessful. Target is reachable.” – This message suggest that Target is reachable
but at least one of the LTR from intermediate hop is not received.
• “LTM operation in progress.” – This message suggests that LTM operation is in progress. This
message will appear if show CLI is fired before LTM Time-out time.
• “LTM Timed out.”- This message suggests that either LTM is not initiated properly or when none of
the expected LTRs is received in LTM Time-out duration which is 5 seconds.

Examples
-> show ethoam linktrace-reply domain MD association MA endpoint 10 tran-id 1256
LTM operation successful. Target is reachable.
Ttl : 63,
LTM Forwarded : yes,
Terminal MEP : no,
Last Egress Identifier : 00-00:00:D0:95:EA:79:62,
Next Egress Identifier : 00-00:00:D0:95:EA:9E:BA,
Relay Action : RLY_FDB,
Chassis ID Subtype : LOCALLY_ASSIGNED,

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-67
show ethoam linktrace-reply Ethernet OAM Commands

Chassis ID : DUT-2,
Ingress Action : ING_OK,
Ingress Mac : 00:D0:95:EA:9E:D4,
Ingress Port ID Subtype : LOCALLY_ASSIGNED,
Ingress Port ID : 1/1,
Egress Action : EGR_OK,
Egress Mac : 00:D0:95:EA:9E:D5,
Egress Port ID Subtype : LOCALLY_ASSIGNED,
Egress Port ID : 1/2

Ttl : 62,
LTM Forwarded : no,
Terminal MEP : yes,
Last Egress Identifier : 00-00:00:D0:95:EA:9E:BA,
Next Egress Identifier : 00-00:00:00:00:00:00:00,
Relay Action : RLY_HIT,
Chassis ID Subtype : LOCALLY_ASSIGNED,
Chassis ID : DUT-3,
Ingress Action : ING_OK,
Ingress Mac : 00:D0:95:EA:AB:D2,
Ingress Port ID Subtype : LOCALLY_ASSIGNED,
Ingress Port ID : 1/1,
Egress Action : EGR_NONE,
Egress Mac : 00:00:00:00:00:00,
Egress Port ID Subtype : NONE,
Egress Port ID : none

output definitions
Ttl Time to live field for the returned LTR.
LTM Forwarded Indicates whether the LTM was forwarded or not.
Terminal MEP Indicates whether the MP reported in the reply Ingress/Egress TLV is a
MEP.
Last Egress Identifier Identifies the MEP linktrace initiator that originated, or the responder
that forwarded, the LTM to which this LTR is the response.
Next Egress Identifier Identifies the linktrace responder that transmitted this LTR, and can
forward the LTM to the next hop.
Relay Action Indicates how the dataframe targeted by the LTM would be passed to
Egress bridge port. Options include RLY_HIT, RLY_FDB, or
RLY_MPDB.
Ingress Action Indicates how the dataframe targeted by the LTM would be received on
the receiving MP. Options include ING_NONE, ING_OK,
ING_DOWN, ING_BLOCKED, or ING_VID.
Ingress Mac The MAC address returned in the ingress MAC address field.
Egress Action Indicates how the dataframe targeted by the LTM would be passed
through Egress bridge port. Options include ING_NONE, ING_OK,
ING_DOWN, ING_BLOCKED, or ING_VID.
Egress Mac The MAC address returned in the egress MAC address field.

Release History
Release 8.1.1; command was introduced.

page 45-68 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands show ethoam linktrace-reply

Related Commands

ethoam linktrace Enables the maintenance entity to initiate transmitting of Link Trace
Messages (LTM).

MIB Objects
Dot1agCfmLtr
dot1agCfmLtrTtl
dot1agCfmLtrForwarded
dot1agCfmLtrTerminalMep
dot1agCfmLtrLastEgressIdentifier
dot1agCfmLtrNextEgressIdentifier
dot1agCfmLtrRelay
dot1agCfmLtrIngress
dot1agCfmLtrIngressMac
dot1agCfmLtrEgress
dot1agCfmLtrEgressMac

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-69
show ethoam linktrace-tran-id Ethernet OAM Commands

show ethoam linktrace-tran-id

Displays the transaction identifiers returned by previously generated LTMs from a specified MEP.
show ethoam linktrace-tran-id domain {md_name | mac_address} association ma_name endpoint
mep_id

Syntax Definitions

md_name Specifies the domain name.

mac_address Specifies the CFM system MAC address.
ma_name Name of the Ethernet OAM Association.
mep_id Specifies the MEP for which LTR is to be displayed. The valid range is
1-8191.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ethoam linktrace-tran-id domain esd.alcatel-lucent.com association alcatel-
sales endpoint 3
S.No Transaction Id
-------+-----------------------
1 13357,
2 13358,
3 13359,

output definitions
S.No Indicates the sequence number.
Transaction Id Indicates the Transaction Identifier returned from a previously
transmitted LTM.

Release History
Release 8.1.1; command was introduced.

page 45-70 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands show ethoam linktrace-tran-id

Related Commands

ethoam linktrace Enables the maintenance entity to initiate transmitting of Link Trace
Messages (LTM).

MIB Objects
Dot1agCfmLtr
dot1agCfmLtrSeqNumber

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-71
show ethoam vlan Ethernet OAM Commands

show ethoam vlan

Displays the Ethernet OAM statistics of all the Management Domains configured on the bridge. Also,
displays the statistics of all the MAs and matching MEPs for all the MDs.
show ethoam vlan vlan_id

Syntax Definitions

vlan_id VLAN ID, primary or non-primary VID (e.g. ‘10’)

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ethoam vlan 10
Primary Vlan : 10,
Associated Vlan-list : 15-20 25 50-80

-> show ethoam vlan 15

Primary Vlan : 10,
Associated Vlan-list : 15-20 25 50-80

Release History
Release 8.1.1; command was introduced.

Related Commands

ethoam endpoint Enables the maintenance entity to initiate transmitting loopback

messages (LBMs) and obtaining loopback replies.

MIB Objects
dot1agCfmMaVlanTable
dot1agCfmVlanVid
dot1agCfmVlanPrimaryVid

page 45-72 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands show ethoam statistics

show ethoam statistics

Displays the Ethernet OAM of all the Management Domains configured on the bridge. Also, displays the
statistics of all the MAs and matching MEPs for all the MDs.
show ethoam statistics domain {md_name | mac_address} [association ma_name] [end-point mep_id]

Syntax Definitions

md_name Specifies the domain name.

mac_address Specifies the CFM system MAC address.
ma_name Specifies the name of Ethernet OAM Association.
mep_id Specifies a MEP for a specific MA.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ethoam statistics domain MD
MEP-ID CCM CCM Seq LBR LBR Out LBR LBR Bad Unexpected MA
Out Error In of order Out MSDU LTR In
------+------+-------+------+--------+------+--------+----------+---------
3 105 0 0 0 0 0 0 MA

-> show ethoam statistics domain MD association MA

MEP-ID CCM CCM Seq LBR LBR Out LBR LBR Bad Unexpected
Out Error In of order Out MSDU LTR In
------+------+-------+------+--------+------+--------+----------
3 105 0 0 0 0 0 0

-> show ethoam statistics domain MD association MA endpoint 3

MEP-ID CCM CCM Seq LBR LBR Out LBR LBR Bad Unexpected
Out Error In of order Out MSDU LTR In
------+------+-------+------+--------+------+--------+----------
3 105 0 0 0 0 0 0

output definitions
MEP-Id The MEP ID configured in the specified MA.
CCM Out The total number of CCMs transmitted.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-73
show ethoam statistics Ethernet OAM Commands

output definitions
CCM Seq Error The total number of out-of-sequence CCMs received from all remote
MEPs.
LBR In The total number of valid, in-order LBRs received.
LBR Out of order The total number of valid, out-of-order LBRs received.
LBR Out The total number of LBRs transmitted.
LBR Bad MSDU The total number of LBRs received whose mac_service_data_unit did
not match.
Unexpected LTR In The total number of unexpected LTRs received.

Release History
Release 8.1.1; command was introduced.

Related Commands

ethoam endpoint Enables the maintenance entity to initiate transmitting loopback

messages (LBMs) and obtaining loopback replies.

MIB Objects
Dot1agCfmMep
dot1agCfmMepIdentifier
dot1agCfmMepCcmOut
dot1agCfmMepRCcmSequenceErrors
dot1agCfmMepLbrIn
dot1agCfmMepLbrInOutOfOrder
dot1agCfmMepLbrOut
dot1agCfmMepLbrBadMsdu
dot1agCfmMepUnexpLtrIn

page 45-74 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands show ethoam config-error

show ethoam config-error

Displays the configuration error for a specified VLAN and port or linkagg.
show ethoam config-error [vlan vlan_id] [{port chassis//slot/port | linkagg agg_id}]

Syntax Definitions

vlan_id VLAN Identifier.

chassis/slot/port The chassis ID, slot, and port number (3/1/1) for a specific port.
agg_id Logical Linkagg Identifier.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
N/A

Examples
-> show ethoam config-error
Vlan Port Error-type
------+------+------------
10 1/1/2 CFMleak
10 1/1/10 CFMleak
30 1/1/2 CFMleak

cli> show ethoam config-error vlan 10

vlan port error-type
------+------+------------
10 1/1/2 CFMleak
10 1/1/10 CFMleak

cli> show ethoam config-error port 1/2

vlan port error-type
------+------+------------
10 1/1/2 CFMleak
30 1/1/2 CFMleak

cli> show ethoam config-error vlan 10 port 1/2

vlan port error-type
------+------+------------
10 1/1/2 CFMleak

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-75
show ethoam config-error Ethernet OAM Commands

output definitions
vlan VLAN identifier number.
port Chassis, slot, and port number.
error-type Type of an error.

Release History
Release 8.1.1; command was introduced.

Related Commands

ethoam linktrace Enables the maintenance entity to initiate transmitting of Link Trace
Messages (LTM).

MIB Objects
dot1agCfmConfigErrorListTable
dot1agCfmConfigErrorListVid
dot1agCfmConfigErrorListIfIndex
dot1agCfmConfigErrorListErrorType

page 45-76 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands show ethoam one-way-delay

show ethoam one-way-delay

Displays the one-way ETH-DM delay (latency) and jitter parameters either for all entries or for a speci-
fied MAC address for a particular source MEP-ID.
show ethoam one-way-delay domain md_name association ma_name endpoint s_mepid [mac-address
mac_address]

Syntax Definitions

md_name Specifies the domain name used while creating the management domain
for which this management association is created.association Physical
slot and port.
ma_name Association name for the created Ethernet OAM Association.
s_mepid Source MEP-ID. Valid Range 1-8191.
mac_address MAC-Address of the remote MEP.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Dash (‘-‘) in the output in Jitter column signifies that the value can not be calculated as the previous
delay value is unknown. This will happen only when 1DM is received for the first time.
• Maximum entries that Delay Result table can store are 1024. After that, the oldest entry is deleted from
the table whenever a new entry is required.

Examples
-> show ethoam one-way-delay domain MD association MA endpoint 10
Legend: Jitter: - = undefined value

Remote Mac address Delay (us) Jitter (us)

--------------------------+-------------+--------------------------------
00:d0:95:ef:44:44 2369 1258
00:d0:95:ef:66:88 5896 282
00:d0:95:ef:88:88 2584 -
00:d0:95:ef:66:55 2698 4782

cli> show ethoam one-way-delay domain MD association MA endpoint 10 mac-address

00:d0:95:ef:44:44
Legend: Jitter: - = undefined value

Remote Mac address Delay (us) Jitter (us)

--------------------+-------------+-------------------
00:d0:95:ef:44:44 2369 1258

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-77
show ethoam one-way-delay Ethernet OAM Commands

output definitions
Remote Mac address Remote MAC address.
Delay Physical slot and port number.
eJitter Type of an error.

Release History
Release 8.1.1; command was introduced.

Related Commands

ethoam one-way-delay Initiates one-way-delay messages from a particular MEP to an

RMEP.

MIB Objects
dot1agCfmMdTable
dot1agCfmMdName
dot1agCfmMaNetTable
dot1agCfmMaNetName
dot1agCfmMepTable
dot1agCfmMepIdentifier
alaDot1agCfmMepDelayRsltTable
alaDot1agCfmMepDelayRMepMacAddress
alaCfmMepDelayTestType
alaCfmMepDelayTestDelay
alaCfmMepDelayVariation

page 45-78 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands show ethoam two-way-delay

show ethoam two-way-delay

Displays the two-way ETH-DM delay and jitter parameters for a specific remote MAC-Address or for all
the MAC-Addresses for which two-way-delay was initiated for a particular source MEP-ID.
show ethoam two-way-delay domain md_name association ma_name endpoint s_mepid [mac-address
mac_address]

Syntax Definitions

md_name Specifies the domain name used while creating the management domain
for which this management association is created.association Physical
slot and port.
ma_name Association name for the created Ethernet OAM Association.
s_mepid Source MEP-ID. Vaild Range 1-8191.
mac_address MAC-Address of the remote MEP.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• If ‘0’ appears in the output in RMEP-ID column signifies that the DMM was initiated with target-
macaddress. As multiple RMEPs can have same mac-address.
• If a dash (‘-‘) appears in the output in Jitter column signifies that the value can not be calculated as the
previous delay value is unknown, i.e. if only one reply for DMM (DMR) is received and this was the
first time DMM was initiated from the MEP, then jitter will not be calculated.
• Maximum entries that Delay Result table can store are 1024. After that, the DMM request shall be
rejected if a new entry needs to be created for the MEP. If entry for the MEP already exists in the table,
that entry shall be updated with the new one.

Examples
-> show ethoam two-way-delay domain MD association MA endpoint 10 mac-address
00:d0:95:ef:44:44
Legend: Jitter: - = undefined value
: RMEP-ID: 0 = two-way-delay was initiated with target mac-address

Remote Mac address RMEP-ID Delay (us) Jitter (us)

-------------------+--------+--------------+--------------
00:d0:95:ef:44:44 12 2369 1258

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-79
show ethoam two-way-delay Ethernet OAM Commands

-> show ethoam two-way-delay domain MD association MA endpoint 10 remote-mep 0

Legend: Jitter: - = undefined value
: RMEP-ID: 0 = two-way-delay was initiated with target mac-address

Remote Mac address RMEP-ID Delay (us) Jitter (us)

-------------------+--------+--------------+------------
00:d0:95:ef:66:88 0 5896 282
00:d0:95:ef:88:88 0 2584 1856

-> show ethoam two-way-delay domain MD association MA endpoint 10 remote-mep 15

Legend: Jitter: - = undefined value
: RMEP-ID: 0 = two-way-delay was initiated with target mac-address

Remote Mac address RMEP-ID Delay (us) Jitter (us)

-------------------+--------+--------------+------------
00:d0:95:ef:66:55 15 2736 -

-> show ethoam two-way-delay domain MD association MA endpoint 10

Legend: Jitter: - = undefined value
: RMEP-ID: 0 = two-way-delay was initiated with target mac-address

Remote Mac address RMEP-ID Delay (us) Jitter (us)

-------------------+--------+--------------+------------
00:d0:95:ef:44:44 12 2369 1258
00:d0:95:ef:66:88 0 5896 282
00:d0:95:ef:88:88 0 2584 1856
00:d0:95:ef:66:55 15 2736 -

output definitions
Remote Mac address Remote MAC address.
RMEP-ID Value of RMEP-ID
Delay Physical slot and port number.
Jitter Type of an error.

Release History
Release 8.1.1; command was introduced.

Related Commands

ethoam two-way-delay Initiate two-way-delay messages from a particular MEP to an

RMEP using target-endpoint or target-MAC address.

page 45-80 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Ethernet OAM Commands show ethoam two-way-delay

MIB Objects
dot1agCfmMdTable
dot1agCfmMdName
dot1agCfmMaNetTable
dot1agCfmMaNetName
dot1agCfmMepTable
dot1agCfmMepIdentifier
alaDot1agCfmMepDelayRsltTable
alaCfmMepDelayRMepMacAddress
alaCfmMepDelayTestType
alaCfmMepDelayTestDelay
alaDot1agCfmMepDelayVariation

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 45-81
show ethoam two-way-delay Ethernet OAM Commands

page 45-82 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 46 VLAN Stacking
Commands

The VLAN Stacking feature provides a method for tunneling multiple customer VLANs (CVLAN)
through a service provider network using one or more service provider VLANs by way of 802.1Q double
tagging or VLAN Translation. This feature enables service providers to provide their customers with
Transparent LAN Services (TLS). This service is multipoint in nature to support multiple customer sites or
networks distributed over the edges of a service provider network.
MIB information for the VLAN Stacking commands is as follows:
Filename: AlcatelIND1VlanStacking.MIB
Module: Alcatel-IND1-VLAN-STACKING-MIB
Filename: AlcatelIND1VlanManager.MIB
Module: Alcatel-IND1-VLAN-MGR-MIB
A summary of the available commands is listed here:

VLAN Stacking Service Mode ethernet-service svlan

ethernet-service uni-profile
ethernet-service service-name
ethernet-service nni
ethernet-service svlan nni
ethernet-service sap
ethernet-service sap uni
ethernet-service sap cvlan
ethernet-service sap-profile
ethernet-service sap sap-profile
ethernet-service uni-profile
ethernet-service uni uni-profile
show ethernet-service vlan
show ethernet-service
show ethernet-service sap
show ethernet-service
show ethernet-service nni
show ethernet-service uni
show ethernet-service uni-profile
show ethernet-service sap-profile

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-1
ethernet-service svlan VLAN Stacking Commands

ethernet-service svlan
Creates a VLAN Stacking VLAN (SVLAN) for tunneling customer traffic.
ethernet-service svlan {svlan_id[-svlan_id2]} [admin-state {enable | disable}] [stp {enable | disable}]
[name description]
no ethernet-service svlan {svlan_id [-svlan_id2]}

Syntax Definitions

svlan Creates an SVLAN for tunneling customer traffic.

svlan_id The VLAN ID number identifying the SVLAN.
[-svlan_id2] The last VLAN ID number in a range of SVLANs that you want to spec-
ify (for example 10-12 specifies VLANs 10, 11, and 12).
enable Enables the SVLAN administrative status.
disable Disables the SVLAN administrative status, which blocks all ports bound
to that SVLAN.
stp enable Enables the SVLAN Spanning Tree status for the service provider net-
work topology.
stp disable Disables the SVLAN Spanning Tree status for the service provider net-
work topology.
description An alphanumeric string. Use quotes around the string if the VLAN
name contains multiple words with spaces between them (for example,
“Alcatel-Lucent Engineering”).

Defaults
By default, the Spanning Tree status is enabled in both the per-vlan and flat mode when the SVLAN is
created

parameter default
enable | disable enable
stp enable | disable enable
description VLAN ID number

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete an SVLAN or a range of SVLANs. Note that SVLAN port
associations are also removed when the SVLAN is deleted.
• This command does not work if the svlan_id specified already exists as a standard VLAN..

page 46-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands ethernet-service svlan

Note. Spanning Tree status for an SVLAN only applies to the Spanning Tree topology calculations
for the service provider network. This status is not applied to customer VLANs (CVLANs) and does
not affect the customer network topology.

Examples
-> ethernet-service svlan 1001-1005 admin-state enable name “Customer ABC”
-> ethernet-service svlan 1001-1005 stp enable
-> no ethernet-service svlan 1001

Release History
Release 8.1.1; command introduced.

Related Commands

show ethernet-service vlan Displays a list of SVLANs configured from the switch

MIB Objects
vlanTable
vlanNumber
vlanDescription
vlanType
vlanAdmStatus
vlanStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-3
ethernet-service service-name VLAN Stacking Commands

ethernet-service service-name
Creates a VLAN Stacking service and associates the service with an SVLAN. A service can be carried
only on a single SVLAN. All traffic within the associated service is carried on the SVLAN.
ethernet-service service-name service_name svlan svlan_id
no ethernet-service service-name service_name svlan svlan_id

Syntax Definitions

service_name The name of the VLAN Stacking service; an alphanumeric string. Use
quotes around string if the service name contains multiple words with
spaces between them (for example, “Alcatel-Lucent Engineering”).
svlan_id The VLAN ID number that identifies an existing SVLAN to associate
with the VLAN Stacking service.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a VLAN Stacking service. Note that when a service is
removed, the SVLAN association with that service is also removed.
• If the VLAN Stacking service is associated with a Service Access Point (SAP), then remove the SAP
associations before attempting to remove the VLAN Stacking service.
• Each VLAN Stacking service is associated with one SVLAN. Specifying an additional VLAN ID for
an existing service is not allowed.

Examples
-> ethernet-service service-name Marketing svlan 10
-> no ethernet-service service-name Marketing svlan 10

Release History
Release 8.1.1; command introduced.

page 46-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands ethernet-service service-name

Related Commands

ethernet-service svlan Creates an SVLAN for customer traffic, a management VLAN for pro-
vider traffic for multicast traffic.

MIB Objects
alaEServiceTable
alaEServiceID
alaEServiceSVLAN
alaEServiceRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-5
ethernet-service nni VLAN Stacking Commands

ethernet-service nni
Configures a switch port or link aggregate as a VLAN Stacking Network Network Interface (NNI) and
optionally specifies the vendor TPID value and the legacy BPDU processing status for a VLAN Stacking
Network Network Interface (NNI).
ethernet-service nni {port chassis/slot/port[-port2] | linkagg linkagg_id[-linkagg_id2]} [tpid tpid_value]
[[stp | mvrp] legacy-bpdu {enable | disable}]
no ethernet-service nni {port chassis/slot/port[-port2] | linkagg linkagg_id[-linkagg_id2]}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
linkagg_id[-linkagg_id2] The link aggregate ID. Use a hyphen to specify a range of link aggregate
IDs (5-10).
tpid_value Specifies the TPID value of the port.
enable Enables the specified legacy BPDU support.
disable Disables the specified legacy BPDU support.

Defaults

parameter default
tpid_value 0x8100
stp legacy-bpdu enable | disable disable
mvrp legacy-bpdu enable | disable disable

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to revert the VLAN Stacking NNI port or link aggregate back to a
conventional switch port or aggregate.
• When this command is used, the default VLAN for the NNI port is changed to a VLAN reserved by the
switch for applications such as VLAN Stacking. The reserved VLAN cannot be configured using stan-
dard VLAN management commands.
• NNI ports can be 802.1q tagged with normal VLANs. In this case, the TPID of the packets tagged with
a normal VLAN must always be 0x8100 (regardless the TPID of the NNI port). This allows NNI port
to carry regular 802.1q tagged traffic as well as SVLAN tagged traffic.
• Enable legacy BPDU support only on VLAN Stacking network ports that are connected to legacy
BPDU switches. Enabling legacy BPDU between AOS switches can cause flooding or an unstable
network.

page 46-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands ethernet-service nni

• If legacy BPDU is enabled on a network port while at same time BPDU flooding is enabled on user
ports, make sure that tagged customer BPDUs are not interpreted by intermediate switches in the
provider network.
• Note that if the peer switch connected to the VLAN Stacking network port supports the Provider MAC
address (STP, 802.1ad/D6.0 MAC), then enabling legacy BPDU support is not required on the network
port. Refer to the following table to determine the type of STP MAC used:

STP
Customer MAC {0x01, 0x80, 0xc2, 0x00, 0x00, 0x00}
Provider MAC address (802.1ad/D6.0) {0x01, 0x80, 0xc2, 0x00, 0x00, 0x08}
Provider MAC address (Legacy MAC) {0x01, 0x80, 0xc2, 0x00, 0x00, 0x00}

• STP legacy BPDU are supported only when the flat Spanning Tree mode is active on the switch.

Examples
-> ethernet-service 10 nni port 1/1/3-5
-> ethernet-service 255 nni port 2/1/10-15 tpid 88a8
-> ethernet-service 500 nni port 1/13-5 stp legacy-bpdu enable
-> no ethernet-service 10 nni port 1/1/3
-> no ethernet-service 255 nni linkagg 12-15

Release History
Release 8.1.1; command introduced.

Related Commands

ethernet-service svlan nni Associates a switch port or link aggregate with a SVLAN.

MIB Objects
alaEServicePortTable
alaEServicePortID
alaEServicePortType
alaEServicePortVendorTpid
alaEServicePortLegacyStpBpdu
alaEServicePortRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-7
ethernet-service svlan nni VLAN Stacking Commands

ethernet-service svlan nni

Associates a NNI port with a SVLAN. A network port connects to another provider bridge and carries
both customer and provider traffic.
ethernet-service svlan {svlan_id[-svlan_id2]} nni {port chassis/slot/port[-port2] | linkagglinkagg_id[-
linkagg_id2]}
no ethernet-service svlan {svlan_id[-svlan_id2]} nni {port chassis/slot/port[-port2] | linkagglinkagg_id
[-linkagg_id2]}

Syntax Definitions

svlan_id The VLAN ID number identifying the SVLAN.

[-svlan_id2] The last VLAN ID number in a range of SVLANs that you want to spec-
ify (for example 10-12 specifies VLANs 10, 11, and 12).
chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
linkagg_id[-linkagg_id2] The link aggregate ID. Use a hyphen to specify a range of link aggregate
IDs (5-10).

Defaults
NA

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an association between an NNI port and an SVLAN.

• Only SVLAN IDs are accepted with this command. This SVLAN ID specified must already exist in the
switch configuration.
• This command only applies to ports or link aggregates configured as VLAN Stacking NNI ports.

• NNI ports can be tagged with normal VLANs. This allows NNI ports to carry regular 802.1q tagged
traffic as well as SVLAN tagged traffic.

Examples
-> ethernet-service svlan 10 nni port 1/1/3
-> ethernet-service svlan 255 nni port 2/1/10-15
-> ethernet-service svlan 500 nni linkagg 31-35
-> no ethernet-service svlan 10 nni port 1/1/3
-> no ethernet-service svlan 255 nni port 2/1/12

Release History
Release 8.1.1; command introduced.

page 46-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands ethernet-service svlan nni

Related Commands

ethernet-service svlan Creates an SVLAN for tunneling customer traffic.

ethernet-service nni Configures a switch port or link aggregate as a VLAN Stacking NNI.

MIB Objects
alaEServiceNniSvlanTable
alaEServiceNniSvlanNni
alaEServiceNniSvlanSvlan
alaEServiceNniSvlanRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-9
ethernet-service sap VLAN Stacking Commands

ethernet-service sap
Creates a VLAN Stacking Service Access Point (SAP) and associates the SAP with a VLAN Stacking
service.
ethernet-service sap sap_id service-name service_name
no ethernet-service sap sap_id

Syntax Definitions

sap_id The SAP ID number identifying the service instance.

service_name The name of the service to associate with this SAP.

Defaults
The “default-sap-profile” profile is automatically associated with the SAP ID when the SAP is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete a VLAN Stacking SAP. When a SAP is deleted, all port and
CVLAN associations with the SAP are also deleted.
• The service name specified with this command must already exist in the switch configuration. Use the
ethernet-service service-name command to create a service to associate with the SAP.
• Each SAP ID is associated with only one service; however, it is possible to associate one service with
multiple SAP IDs.

Examples
-> ethernet-service sap 10 service-name CustomerA
-> no ethernet-service sap 11

Release History
Release 8.1.1; command introduced.

page 46-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands ethernet-service sap

Related Commands

ethernet-service service-name Creates a VLAN Stacking service and associates the service with an
SVLAN.
ethernet-service sap-profile Creates a VLAN Stacking SAP profile.
ethernet-service sap sap-profile Associates a SAP profile with a SAP ID.

MIB Objects
alaEServiceSapTable
alaEServiceSapID
alaEServiceSapServiceID
alaEServiceSapProfile
alaEServiceSapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-11
ethernet-service sap uni VLAN Stacking Commands

ethernet-service sap uni

Configures the switch port as a VLAN Stacking User Network Interface (UNI) and associates the port
with a VLAN Stacking Service Access Point (SAP). A UNI port is a customer facing port on which traffic
enters the SAP.
ethernet-service sap {sap_id} uni {port chassis/slot/port[-port2] | linkagg linkagg_id[-linkagg_id2]}
no ethernet-service sap {sap_id} uni {port chassis/slot/port[-port2] | linkagg linkagg_id[-linkagg_id2]}

Syntax Definitions

sap_id The SAP ID number identifying the service instance.

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
linkagg_id[-linkagg_id2] The link aggregate ID. Use a hyphen to specify a range of link aggregate
IDs (5-10).

Defaults
A switch port or a link aggregate becomes a VLAN Stacking UNI port by default when the port or link
aggregate is associated with a VLAN Stacking SAP.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove an association between a UNI port and a SAP. Note that
when the last SAP association is removed, the UNI port converts back to a conventional switch port.
• Only fixed ports can be configured as UNI ports.

• The SAP ID specified with this command must already exist. Use the ethernet-service sap command
to create a SAP.
• When this command is used, the default VLAN for the UNI port is changed to a reserved VLAN and
all customer traffic received is dropped until the type of traffic for the port is configured using the
ethernet-service sap cvlan command.

Examples
-> ethernet-service sap 10 uni port 1/1/3
-> ethernet-service sap 10 uni port 2/1/10-15
-> ethernet-service sap 10 uni linkagg 31-40
-> no ethernet-service sap 10 uni port 1/1/10-15
-> no ethernet-service sap 10 uni linkagg 31

Release History
Release 8.1.1; command introduced.

page 46-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands ethernet-service sap uni

Related Commands

ethernet-service sap Creates a VLAN Stacking SAP and associates the SAP with a VLAN
Stacking SAP profile and service.
ethernet-service sap sap-profile Creates a UNI profile that is used to specify how to process control
packets ingressing on UNI ports.
ethernet-service uni uni-profile Associates a VLAN Stacking UNI profile with a UNI port.

MIB Objects
alaEServiceSapUniTable
alaEServiceSapUniSap
alaEServiceSapUniUni
alaEServiceSapUniRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-13
ethernet-service sap cvlan VLAN Stacking Commands

ethernet-service sap cvlan

Associates customer VLAN (CVLAN) traffic with a VLAN Stacking Service Access Point (SAP). The
parameter values configured with this command are applied to frames received on all SAP UNI ports and
determines the type of customer traffic that is accepted on the UNI ports and processed by the service.
ethernet-service sap {sap_id} cvlan {all | cvlan_id | cvlan_id1-cvlan_id2 | untagged}
no ethernet-service sap {sap_id} cvlan {all | cvlan_id | cvlan_id1-cvlan_id2 | untagged}

Syntax Definitions

sap_id The SAP ID number.

all Applies the SAP profile to tagged and untagged frames.
cvlan_id Applies the SAP profile to frames tagged with this CVLAN ID.
cvlan_id1-cvlan_id2 Applies the SAP profile to frames tagged with a CVLAN ID that falls
within this range of CVLAN IDs (for example, 10-12 specifies frames
tagged with CVLAN 10, 11, or 12).
untagged Applies the SAP profile only to untagged frames.

Defaults
By default, no CVLAN traffic is associated with the SAP ID when the SAP is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a CVLAN ID or the designation for all or untagged
frames from the SAP. Note that when the last CVLAN parameter is deleted from a SAP configuration,
the SAP is not automatically deleted.
• The all and untagged parameters are configurable in combination with a CVLAN ID. For example, if
untagged and a CVLAN ID are associated with the same SAP ID, then the SAP profile is applied to
only untagged traffic and traffic tagged with the specified CVLAN ID. All other traffic is dropped.
• The SAP ID specified with this command must already exist. Use the ethernet-service sap command
to create a SAP.
• Configuring the all and untagged parameters for the same SAP is not allowed. Specify only one of
these two parameters per SAP.
• Either the all or untagged parameters can be configured for the SAP. In such an instance, the default
VLAN for the UNI ports associated with the SAP is changed to the VLAN assigned to the SAP related
service.
• Only one SAP, with the all or untagged option, is allowed per UNI. For example, if UNI port 1/17 is
part of SAP 10 and SAP 20 and SAP 10 is configured for all traffic, then only untagged parameter or a
CVLAN ID is allowed for SAP 20.

page 46-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands ethernet-service sap cvlan

• If you do not specify all or untagged options with a UNI, then the default VLAN 4095 is set for the
UNI and all untagged, untagged control traffic and unmatched tag traffic is dropped.

Examples
-> ethernet-service sap 10 cvlan 200
-> ethernet-service sap 10 cvlan all
-> ethernet-service sap 11 cvlan 100-150
-> ethernet-service sap 11 cvlan untagged
-> no ethernet-service sap 10 cvlan 200
-> no ethernet-service sap 10 cvlan all
-> no ethernet-service sap 10 cvlan 100-150

Release History
Release 8.1.1; command introduced.

Related Commands

ethernet-service sap Creates a VLAN Stacking Service Access Point (SAP) and associates
the SAP with a VLAN Stacking service.

MIB Objects
alaEServiceSapCvlanTable
alaEServiceSapCvlanSapId
alaEServiceSapCvlanCvlan
alaEServiceSapCvlanMapType
alaEServiceSapRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-15
ethernet-service sap-profile VLAN Stacking Commands

ethernet-service sap-profile
Creates a profile for a VLAN Stacking Service Access Point (SAP). Profile attributes are used to define
traffic engineering policies that are applied to traffic serviced by the SAP.
ethernet-service sap-profile sap_profile_name [bandwidth not-assigned] [[shared | not-shared]
ingress-bandwidth mbps ] [cvlan-tag {preserve | translate}] priority [not-assigned | map-inner-to-
outer-p | map-dscp-to-outer-p | fixed value][egress-bandwidth mbps]
no ethernet-service sap-profile sap_profile_name

Syntax Definitions

sap_profile_name An alphanumeric string. Use quotes around string if the profile name
contains multiple words with spaces between them (for example, “Alca-
tel-Lucent Engineering”).
bandwidth not-assigned Specifies that the SAP profile does not allocate switch resources to
enforce bandwidth requirements. Applies only when the profile speci-
fies the default ingress bandwidth value (zero).
shared Shares the ingress bandwidth limit across all SAP ports and CVLANs.
not shared Applies the ingress bandwidth limit to individual SAP ports and
CVLANs; bandwidth is not shared.
ingress bandwidth mbps The maximum amount of bandwidth allowed for traffic received on
SAP ports, in megabits per second. This parameter can only be used
with the shared option or not-shared option.
preserve Retains the customer VLAN ID (inner tag) and double tags the frame
with the SVLAN ID (outer tag).
translate Replaces the customer VLAN ID with the SVLAN ID.
priority not-assigned Specifies that the SAP profile is not assigned with a priority value or
priority mapping.
map-inner-to-outer-p Maps the customer VLAN (inner tag) priority bit value to the SVLAN
(outer tag) priority bit value.
map-dscp-to-outer-p Maps the customer VLAN (inner tag) DSCP value to the SVLAN (outer
tag) priority bit value.
fixed value Sets the SVLAN (outer tag) priority bit to the specified value.
egress-bandwidth mbps The maximum amount of bandwidth allowed for traffic sent on SAP
ports, in megabits per second.

page 46-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands ethernet-service sap-profile

Defaults

parameter default
shared | not shared shared
mbps 0
preserve | translate preserve
not-assigned | map-inner-to- fixed 0
outer-p | map-dscp-to-outer-p |
fixed value

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to delete a SAP profile.

• If a profile is not specified when a SAP is created, a default profile (default-sap-profile) is automati-
cally associated with the SAP.
• Use the ethernet-service sap sap-profile command to associate a profile to a VLAN Stacking SAP.

• Only one SAP profile name is associated with each SAP ID; however, it is possible to associate the
same SAP profile name to multiple SAP IDs.
• Configure the ingress-bandwidth or egress-bandwidth parameters to define rate limiting values for
the SAP.

Examples
-> ethernet-service sap-profile video1 egress-bandwidth 10 cvlan-tag translate
priority map-inner-to-outer-p
-> ethernet-service sap-profile voice1 not-shared ingress-bandwidth 10 cvlan-tag
preserve
-> ethernet-service sap-profile voice2 shared ingress-bandwidth 10
-> no ethernet-service sap-profile video1

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-17
ethernet-service sap-profile VLAN Stacking Commands

Related Commands

ethernet-service sap Creates a VLAN Stacking SAP and associates the SAP with a service.
ethernet-service sap sap-profile Associates a SAP profile with a SAP ID.
show ethernet-service sap-profile Displays the profile attribute configuration for a SAP profile.

MIB Objects
alaEServiceSapProfileTable
alaEServiceSapProfileID
alaEServiceSapProfileCVLANTreatment
alaEServiceSapProfileIngressBW
alaEServiceSapProfileEgressBW
alaEServiceSapProfilePriorityMapMode
alaEServiceSapProfileFixedPriority
alaEServiceSapProfileBandwidthShare
alaEServiceSapRowStatus

page 46-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands ethernet-service sap sap-profile

ethernet-service sap sap-profile

Associates a VLAN Stacking Service Access Point (SAP) with a SAP profile. This command is also used
to change an existing SAP profile association.
ethernet-service sap sap_id sap-profile sap_profile_name
no ethernet-service sap sap_id

Syntax Definitions

sap_id The SAP ID number.

sap_profile_name The name of the SAP profile to associate with this SAP ID.

Defaults
The “default-sap-profile” profile is automatically associated with the SAP ID when the SAP is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command along with the SAP ID to remove the SAP profile.

• If a profile association already exists for the specified SAP ID, the current profile is replaced with the
profile specified with this command.
• To change the profile associated with the SAP back to the default profile, enter “default-sap-profile”
with this command.
• Do not specify a service name; doing so returns an error message. This command is only for associat-
ing an existing profile to a VLAN Stacking SAP.

Examples
-> ethernet-service sap 10 sap-profile CustomerC
-> ethernet-service sap 11 sap-profile CustomerD
-> ethernet-service sap 11 sap-profile default-sap-profile

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-19
ethernet-service sap sap-profile VLAN Stacking Commands

Related Commands

ethernet-service sap Creates a VLAN Stacking SAP and associates the SAP with a VLAN
Stacking SAP profile and service.
ethernet-service sap-profile Creates a VLAN Stacking SAP profile.

MIB Objects
alaEServiceSapTable
alaEServiceSapID
alaEServiceSapProfile
alaEServiceSapRowStatus

page 46-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands ethernet-service uni-profile

ethernet-service uni-profile
Creates a User Network Interface (UNI) profile that is used to specify how to process control packets
ingressing on UNI ports.
ethernet-service uni-profile uni-profile-name [l2-protocol {stp | 802.1x | 802.1ab | 802.3ad | mvrp |
amap} {peer | discard | tunnel}
no ethernet-service uni-profile uni-profile-name

Syntax Definitions

uni-profile-name Alphanumeric string. Use quotes around string if the profile name con-
tains multiple words with spaces between them (for example, “Alcatel-
Lucent Engineering”).
stp Specifies how Spanning Tree BPDU is processed on the UNI port.
802.1x Specifies how 802.1x control frames are processed on the UNI port.
802.1ab Specifies how 802.1ab control frames are processed on the UNI port.
802.3ad Specifies how 802.3ad and 802.3ah control frames are processed on the
UNI port.
mvrp Specifies how Multicast VLAN Registration Protocol packets are pro-
cessed on the UNI port.
amap Specifies how Alcatel Management Adjacency Protocol packets must be
processed on the UNI port.
peer Allows the UNI port to participate in the specified protocol.
discard Discards the specified PDU.
tunnel Tunnels the specified PDU across the provider network.

Defaults

parameter default
stp tunnel
mvrp tunnel
amap tunnel
802.1x tunnel
802.3ad tunnel
802.1ab tunnel

Platforms Supported
OmniSwitch 6860, 6860E

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-21
ethernet-service uni-profile VLAN Stacking Commands

Usage Guidelines
• Use the no form of this command to delete a UNI profile.

• Remove any UNI profile associations with UNI ports before attempting to modify or delete the profile.

• Up to five unique UNI profile combinations, including the default profile, are allowed per switch. If a
profile has the same processing settings as any other profile, then it is not considered unique.
• Not all of the protocol parameters are currently supported with the peer, tunnel, and discard parame-
ters. Use the following table to determine the parameter combinations that are supported:

peer discard tunnel

stp no yes yes
802.1x yes yes yes
802.3ad yes yes yes
802.1ab yes yes yes
mvrp no yes yes
amap no yes yes

• If a user-configured UNI profile is not associated with a UNI port, then the default profile (default-uni-
profile) is used to process control packets ingressing on the port.
• A uni-profile cannot be modified if it is associated with a UNI. The uni-profile cannot be deleted unless
the associations are deleted.

Examples
-> ethernet-service uni-profile uni_1 l2-protocol stp mvrp discard
-> no ethernet-service uni-profile uni_1

Release History
Release 8.1.1; command introduced.

Related Commands

ethernet-service uni uni-profile Associates a VLAN Stacking UNI profile with a UNI port.
ethernet-service sap uni Configures the switch port as a VLAN Stacking UNI and associates the
port with a VLAN Stacking Service Access Point (SAP).
show ethernet-service uni Displays the profile associations for VLAN Stacking UNI ports.
show ethernet-service uni- Displays the profile attribute configuration for VLAN Stacking UNI
profile profiles.

page 46-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands ethernet-service uni-profile

MIB Objects
alaEServiceUNIProfileTable
alaEServiceUNIProfileID
alaEServiceUNIProfileStpBpduTreatment
alaEServiceUNIProfile8021xTreatment
alaEServiceUNIProfile8021ABTreatment
alaEServiceUNIProfile8023adTreatment
alaEServiceUNIProfileMvrpTreatment
alaEServiceUNIProfileAmapTreatment
alaEServiceUNIProfileRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-23
ethernet-service uni uni-profile VLAN Stacking Commands

ethernet-service uni uni-profile

Associates a VLAN Stacking User Network Interface (UNI) profile with a UNI port.
ethernet-service uni {port chassis/slot/port[-port2] | linkagg linkagg_id[-linkagg_id2]} uni-profile uni-
profile-name
no ethernet-service uni-profile uni-profile-name

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
linkagg_id[-linkagg_id2] The link aggregate ID. Use a hyphen to specify a range of link aggregate
IDs (5-10).
uni_profile_name Alphanumeric string. Use quotes around string if the profile name con-
tains multiple words with spaces between them (for example, “Alcatel-
Lucent Engineering”).

Defaults
The default profile (default-uni-profile) is used to process control packets ingressing on a UNI port. This
profile is assigned at the time a port is configured as a VLAN Stacking UNI.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command along with the uni-profile name to delete the uni-profile.

• This UNI specified with this command must already exist in the switch configuration.

• To change the profile associated with a UNI port, use this command and specify a different profile
name than the one currently associated with the port. The last profile associated with the port, is the
profile that is applied to UNI port traffic.
• To change the profile associated with a UNI port back to the default profile, enter “default-uni-profile”
with this command.

Examples
-> ethernet-service uni port 1/1/3 uni-profile uni_1
-> ethernet-service uni linkagg 1-5 uni-profile uni_2
-> ethernet-service uni port 2/1/10-15 uni-profile default-uni-profile
-> no ethernet-service uni-profile uni_1

Release History
Release 8.1.1; command introduced.

page 46-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands ethernet-service uni uni-profile

Related Commands

ethernet-service sap sap-profile Creates a UNI profile that is used to specify how to process control
packets ingressing on UNI ports.
ethernet-service sap uni Configures the switch port as a VLAN Stacking UNI and associates the
port with a VLAN Stacking Service Access Point (SAP).

MIB Objects
alaEServicePortTable
alaEServicePortID
alaEServicePortType
alaEServicePortUniProfile
alaEServiceSapUniRowStatus

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-25
show ethernet-service vlan VLAN Stacking Commands

show ethernet-service vlan

Displays a list of SVLANs configured on the switch.
show ethernet-service vlan [svlan_id-[svlan_id2]]

Syntax Definitions

svlan_id The VLAN ID number identifying the SVLAN.

-svlan_id2 The last VLAN ID number in a range of SVLANs that you want to spec-
ify (for example 10-12 specifies VLANs 10, 11, and 12).

Defaults
By default, all SVLANs are displayed if an SVLAN or range of SVLANs are not specified with this
command.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Specify a single SVLAN ID or a range of SVLAN IDs to display configuration information for the
specific SVLANs.

Examples
-> show ethernet-service vlan

vlan Type name

+--------+------------+-------------------------+
4010 svlan Customer ABC
4020 mgmt Provider Management
4021 svlan Customer XYZ

-> show ethernet-service vlan 1001

Name : VLAN 1001,

Type : Service Vlan,
Administrative State : enabled,
Operational State : disabled,
IP Router Port : disabled,
IP MTU : 1500

-> show ethernet-service vlan 1000-1004

vlan type admin oper ip mtu name

-----+------+-----+-----+-----+-------+------------
1000 vstk Ena Dis Dis 1500 VLAN 1000
1001 vstk Ena Dis Dis 1500 VLAN 1001
1002 vstk Ena Dis Dis 1500 VLAN 1002
1003 vstk Ena Dis Dis 1500 VLAN 1003
1004 vstk Ena Dis Dis 1500 VLAN 1004

page 46-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands show ethernet-service vlan

output definitions
vlan The SVLAN ID number identifying the instance.
type The type of SVLAN.
admin The administrative state of the VLAN. (Ena or Dis).
oper The operation status of the VLAN ( Ena or Dis).
ip The status of the IP router port (Ena or Dis).
mtu The IP MTU value configured for the VLAN.
name The user-defined text description for the SVLAN. By default, the
SVLAN ID is specified for the description.

Release History
Release 8.1.1; command introduced.

Related Commands

ethernet-service svlan Creates a VLAN Stacking VLAN (SVLAN) for tunneling customer traf-
fic, a management SVLAN for provider traffic application uses to dis-
tribute multicast traffic.
show ethernet-service Displays configuration information for VLAN Stacking Ethernet ser-
vices.

MIB Objects
vlanTable
vlanNumber
vlanDescription
vlanSvlanTrafficType

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-27
show ethernet-service VLAN Stacking Commands

show ethernet-service
Displays configuration information for VLAN Stacking Ethernet services.
show ethernet-service [service-name service_name | svlan svlan_id]

Syntax Definitions

service_name The name of an existing VLAN Stacking service. Use quotes around
string if the service name contains multiple words with spaces between
them (for example, “Alcatel-Lucent Engineering”).
svlan_id The VLAN ID number that identifies an existing SVLAN .

Defaults
By default, all services are displayed if a service name or SVLAN ID is not specified with this command.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enter the name of a service to display configuration information for a specific service.

• Enter an SVLAN ID to display configuration information for all services that are associated with a
specific SVLAN.

Examples
-> show ethernet-service

Service Name : VideoOne

SVLAN : 300
NNI(s) : 2/1/1, 3/1/2
SAP Id : 20
UNIs : 1/1/1, 1/1/2
CVLAN(s) : 10, 20
sap-profile : sap-video1
SAP Id : 30
UNIs : 1/1/3
CVLAN(s) : untagged, 40
sap-profile : sap-video2

Service Name : CustomerABC

SVLAN : 255
NNI(s) : 1/1/22
SAP Id : 10
UNIs : 2/1/10, 2/1/11
CVLAN(s) : 500, 600
sap-profile : default-sap-profile

page 46-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands show ethernet-service

-> show ethernet-service service-name CustomerABC

Service Name : CustomerABC

SVLAN : 255
NNI(s) : 1/1/22
SAP Id : 10
UNIs : 2/1/10, 2/1/11
CVLAN(s) : 500, 600
sap-profile : default-sap-profile

-> show ethernet-service svlan 300

Service Name : VideoOne

SVLAN : 300
NNI(s) : 2/1/1, 3/1/2
SAP Id : 20
UNIs : 1/1/1, 1/1/2
CVLAN(s) : 10, 20
sap-profile : sap-video1
SAP Id : 30
UNIs : 1/1/3
CVLAN(s) : 30, 40
sap-profile : sap-video2

output definitions
Service Name The name of the VLAN Stacking service.
SVLAN Displays the SVLAN ID associated with the service. Note. SVLAN
appears as the field name if the VLAN ID is an SVLAN.
NNI(s) VLAN Stacking Network Network Interface ports associated with the
service to tunnel SVLAN customer traffic.
SAP Id The ID number for the VLAN Stacking Service Access Point that is
applied to the service.
UNIs VLAN Stacking User Network Interface ports that receive customer
traffic.
CVLAN(s) Customer VLAN IDs ingressing on UNI ports.
sap-profile The name of the SAP profile associated with the SAP.

Release History
Release 8.1.1; command introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-29
show ethernet-service VLAN Stacking Commands

Related Commands

ethernet-service service-name Creates a VLAN Stacking service and associates the service with an
SVLAN.
show ethernet-service vlan Displays a list of all or a range of configured SVLANs or the parameters
of a specified SVLAN.

MIB Objects
alaEServiceTable
alaEServiceID
alaEServiceSVLAN
alaEServiceNniSvlanTable
alaEServiceNniSvlanNni
alaEServiceSapTable
alaEServiceSapID
alaEServiceSapUniTable
alaEServiceSapUniUni
alaEServiceSapCvlanTable
alaEServiceSapCvlanCvlan
alaEServiceSapCvlanMapType
alaEServiceSapProfileTable
alaEServiceProfileID

page 46-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands show ethernet-service sap

show ethernet-service sap

Displays configuration information for VLAN Stacking Service Access Points (SAP).
show ethernet-services sap [sap_id]

Syntax Definitions

sap_id The SAP ID number identifying the service instance.

Defaults
By default, all SAPs are displayed if a SAP ID is not specified with this command.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Specify a single SAP ID to display configuration information for a specific SAP.

Examples
-> show ethernet-services sap

SAP Id : 10
UNIs : 2/1/10, 2/1/11
CVLAN(s) : 500, 600
sap-profile : default-sap-profile

SAP Id : 20
UNIs : 1/1/1, 1/1/2
CVLAN(s) : 10, 20
sap-profile : sap-video1

SAP Id : 30
UNIs : 1/13
CVLAN(s) : 30, 40
sap-profile : sap-video2

-> show ethernet-service sap 10

SAP Id : 10
UNIs : 2/1/10, 2/1/11
CVLAN(s) : 500, 600
sap-profile : default-sap-profile

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-31
show ethernet-service sap VLAN Stacking Commands

output definitions
SAP Id The ID number for the VLAN Stacking Service Access Point that is
applied to the service.
UNIs VLAN Stacking User Network Interface ports that receive customer
traffic.
CVLAN(s) Customer VLAN IDs ingressing on UNI ports.
sap-profile The name of the SAP profile associated with the SAP.

Release History
Release 8.1.1; command introduced.

Related Commands

ethernet-service sap Creates a VLAN Stacking Service Access Point (SAP) and associates
the SAP with a VLAN Stacking SAP profile and service.
show ethernet-service Displays configuration information for VLAN Stacking Ethernet ser-
vices.
show ethernet-service sap-profile Displays the profile attribute configuration for SAP profiles.

MIB Objects
alaEServiceSapTable
alaEServiceSapID
alaEServiceSapUniTable
alaEServiceSapUniUni
alaEServiceSapCvlanTable
alaEServiceSapCvlanCvlan
alaEServiceSapCvlanMapType
alaEServiceSapProfileTable
alaEServiceProfileID

page 46-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands show ethernet-service

show ethernet-service
Displays configuration information for a VLAN Stacking service port.
show ethernet-service port {chassis/slot/port | linkagg linkagg_id}

Syntax Definitions

chassis/slot/port The chassis ID, slot, and port number (3/1/1) for a specific port.
linkagg_id The link aggregate ID.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Specifying a chassis/slot/port or link aggregate ID number is required with this command.

Examples
-> show ethernet-service port 1/1/10

Interface : 1/1/10
Port Type : UNI
UNI Profile : default-uni-profile
Default SVLAN : 4095

Service Name : svlan_service

SVLAN : 20
NNI(s) : No NNIs configured
SAP Id : 1
UNIs : 1/1/10
CVLAN(s) : 200
sap-profile : translate_profile

-> show ethernet-service port 1/1/22

Interface : 1/1/22
Port Type : NNI

Service Name : CustomerABC

SVLAN : 255
NNI(s) : 1/1/22
SAP Id : 10
UNIs : 2/1/10, 2/1/11
CVLAN(s) : 500, 600
sap-profile : default-sap-profile

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-33
show ethernet-service VLAN Stacking Commands

Service Name : Video-Service

SVLAN : 300
NNI(s) : 1/1/22, 3/1/2
SAP Id : 20
UNIs : 1/1/1, 1/1/2
CVLAN(s) : 10, 20
sap-profile : sap-video1
SAP Id : 30
UNIs : 1/1/3
CVLAN(s) : 30, 40
sap-profile : sap-video2

output definitions
Interface The chassis ID, slot, and port number or link aggregate ID for the spec-
ified interface.
Port Type The type of VLAN Stacking port (UNI or NNI).
Service Name The name of the VLAN Stacking service.
SVLAN Displays the SVLAN ID associated with the service. Note that SVLAN
appears as the field name if the VLAN ID is an SVLAN.
NNI(s) VLAN Stacking Network Network Interface ports associated with the
service to tunnel SVLAN customer traffic.
SAP Id The ID number for the VLAN Stacking Service Access Point that is
applied to the service.
UNIs VLAN Stacking User Network Interface ports that receive customer
traffic.
CVLAN(s) Customer VLAN IDs ingressing on UNI ports.
sap-profile The name of the SAP profile associated with the SAP.

Release History
Release 8.1.1; command introduced.

Related Commands

ethernet-service svlan nni Configures the switch port as a VLAN Stacking NNI port and associates
the port with a customer SVLAN, management SVLAN.
ethernet-service sap uni Configures the switch port as a VLAN Stacking UNI and associates the
port with a VLAN Stacking SAP.
show ethernet-service Displays configuration information for VLAN Stacking Ethernet ser-
vices.

page 46-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands show ethernet-service

MIB Objects
alaEServiceTable
alaEServiceID
alaEServiceSVLAN
alaEServiceNniSvlanTable
alaEServiceNniSvlanNni
alaEServiceSapTable
alaEServiceSapID
alaEServiceSapUniTable
alaEServiceSapUniUni
alaEServiceSapCvlanTable
alaEServiceSapCvlanCvlan
alaEServiceSapCvlanMapType
alaEServiceSapProfileTable
alaEServiceProfileID

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-35
show ethernet-service nni VLAN Stacking Commands

show ethernet-service nni

Displays configuration information for VLAN Stacking Network Network Interface (NNI) ports.
show ethernet-service nni [port chassis/slot/port | linkagg linkagg_id]

Syntax Definitions

chassis/slot/port The chassis ID, slot, and port number (3/1/1) for a specific port.
linkagg_id The link aggregate ID.

Defaults
By default, all NNI ports are displayed if a slot/port or link aggregate ID number is not specified.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Specify a chassis/slot/port or link aggregate ID number to display information for a single port or link
aggregate ID.

Examples
-> show ethernet-service nni

Port TPID Legacy BPDU

stp mvrp
--------+--------+-----------------------+
1/1/22 0x8100 Disable Disable
1/1/23 0x8100 Disable Disable

-> show ethernet-service nni 1/23

Port TPID Legacy BPDU

stp mvrp
--------+--------+-----------------------+
1/1/23 0x8100 Disable Disable

output definitions
Port The chassis/slot/port number or link aggregate ID for the NNI port.
TPID The vendor TPID value configured for the NNI port.
stp Whether or not Spanning Tree legacy BPDU processing is enabled for
the NNI port.
mvrp Whether or not MVRP legacy BPDU processing is enabled for the
port.

page 46-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands show ethernet-service nni

Release History
Release 8.1.1; command introduced.

Related Commands

ethernet-service svlan nni Configures the switch port as a VLAN Stacking NNI port and associates
the port with a customer SVLAN, management SVLAN.
ethernet-service nni Configures the vendor TPID value and the legacy BPDU processing sta-
tus for a VLAN Stacking Network Network Interface (NNI).
show ethernet-service Displays configuration information for VLAN Stacking Ethernet ser-
vices.

MIB Objects
alaEServicePortTable
alaEServicePortID
alaEServicePortVendorTpid
alaEServicePortLegacyStpBpdu
alaEServicePortLegacyGvrpBpdu

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-37
show ethernet-service uni VLAN Stacking Commands

show ethernet-service uni

Displays a list of UNI ports configured for the switch and the profile association for each port.
show ethernet-service uni [port chassis/slot/port | linkagg linkagg_id]

Syntax Definitions

chassis/slot/port The chassis ID, slot, and port number (3/1/1) for a specific port.
linkagg_id The link aggregate ID number.

Defaults
By default, profile information for all UNI ports is displayed if a slot/port or link aggregate ID number is
not specified.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Specify a slot/port or link aggregate ID number to display information for a single slot/port or link
aggregate ID.

Examples
-> show ethernet-service uni

Port UNI Profile

---------+--------------------+
1/1/1 uni-profile-default
1/1/2 multi-site
1/1/3 multi-site

-> show ethernet-service uni port 1/1/3

Port UNI Profile

---------+--------------------+
1/1/3 multi-site

output definitions
Port The slot/port number or link aggregate ID for the UNI port.
UNI Profile The UNI profile associated with the port.

Release History
Release 8.1.1; command introduced.

page 46-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands show ethernet-service uni

Related Commands

ethernet-service sap sap-profile Creates a UNI profile that is used to specify how to process control
packets ingressing on UNI ports.
ethernet-service uni uni-profile Associates a VLAN Stacking UNI profile with a UNI port.
show ethernet-service uni- Displays the profile attribute configuration for VLAN Stacking User
profile Network Interface (UNI) profiles.

MIB Objects
alaEServiceUniProfileTable
alaEServicePortID
alaEServicePortProfileID

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-39
show ethernet-service uni-profile VLAN Stacking Commands

show ethernet-service uni-profile

Displays the profile attribute configuration for VLAN Stacking User Network Interface (UNI) profiles.
show ethernet-service uni-profile [uni-profile-name]

Syntax Definitions

uni-profile-name An alphanumeric string. Use quotes around the string if the profile name
contains multiple words with spaces between them (for example, “Alca-
tel-Lucent Engineering”).

Defaults
By default, all UNI profiles are displayed if a UNI profile name is not specified with this command.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Specify a UNI profile name to display attributes for a single UNI profile.

Examples
-> show ethernet-service uni-profile

Profile Name Stp 802.1x 802.3ad 802.1AB MVRP AMAP

+----------------+-------+--------+---------+----------+--------+---------+
uprofile-video1 tunnel drop peer drop tunnel drop

output definitions
Profile Name The name of the UNI profile.
Stp Indicates how Spanning Tree traffic control packets are processed.
802.1x Indicates how IEEE 802.1x control packets are processed.
802.3ad Indicates how IEEE 802.3ad control packets are processed.
802.1AB Indicates how IEEE 802.1AB control packets are processed.
MVRP Indicates how the Multiple VLAN Registration Protocol packets are
processed.
AMAP Indicates how Alcatel-Lucent Mapping Adjacency Protocol packets are
processed.

Release History
Release 8.1.1; command introduced.

page 46-40 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands show ethernet-service uni-profile

Related Commands

ethernet-service sap sap-profile Creates a UNI profile that is used to specify how to process control
packets ingressing on UNI ports.
ethernet-service uni uni-profile Associates a VLAN Stacking UNI profile with a UNI port.
show ethernet-service uni Displays the profile associations for VLAN Stacking User Network
Interface (UNI) ports.

MIB Objects
alaEServiceUNIProfileTable
alaEServiceUNIProfileID
alaEServiceUNIProfileStpBpduTreatment
alaEServiceUNIProfile8021xTreatment
alaEServiceUNIProfile8021ABTreatment
alaEServiceUNIProfile8023adTreatment
alaEServiceUNIProfileMvrpTreatment
alaEServiceUNIProfileAmapTreatment

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-41
show ethernet-service sap-profile VLAN Stacking Commands

show ethernet-service sap-profile

Displays the profile attribute configuration for VLAN Stacking Service Access Point (SAP) profiles.
show ethernet-service sap-profile sap_profile_name

Syntax Definitions

sap_profile_name An alphanumeric string. Use quotes around the string if the profile name
contains multiple words with spaces between them (for example, “Alca-
tel-Lucent Engineering”).

Defaults
By default, all SAP profiles are displayed if a SAP profile name is not specified with this command.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Specify a SAP profile name to display attributes for a single SAP profile.

• The ingress bandwidth value is displayed in megabytes.

Examples
-> show ethernet-service sap-profile

Profile Name Ingr/Egr Ingr Bw Inner Tag Priority Priority

Bw Sharing Option Mapping Value

-------------------+-----------+-----------+-----------+----------+-----------

default-sap-profile 0/0 Enable Preserve fixed 0

map_pbit 0/0 Enable Preserve in-out P
sap1 24324/0 NA Preserve NA NA
sap_1 0/0 NA Preserve NA NA

-> show ethernet-service sap-profile sap-video1

Profile Name Ingr/Egr Ingr Bw Inner Tag Priority Priority

Bw Sharing Option Mapping Value
--------------------+----------+-------------+-----------+----------+------------
sap-video1 20 Disable Preserve NA NA

output definitions
Profile Name The name of the SAP profile.
Ingr/Egr Bw Ingress Egress Bandwidth - The maximum amount of ingress and
egress bandwidth to allow for SAP ports.

page 46-42 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
VLAN Stacking Commands show ethernet-service sap-profile

output definitions
Ingr Bw Sharing Ingress Bandwidth Sharing - The status of bandwidth sharing
(enable, disable, or NA). If enabled, the ingress bandwidth value is
shared across all SAP ports and CVLANs. If disabled, the bandwidth
value is not shared and applied to individual SAP ports and CVLANs.
Inner Tag Option Indicates how the CVLAN tag is processed (translate or preserve). If
set to preserve, the CVLAN tag is retained and the SVLAN is added to
the frame. If set to translate, the CVLAN tag is changed to the SVLAN
tag.
Priority Mapping Indicates how the priority value is configured for the SVLAN (NA, in-
out or fixed). If set to in-out, the CVLAN priority value is mapped to
the SVLAN. If set to fixed, a user-specified priority value is used for
the SVLAN priority.
Priority Value Indicates the priority value mapped to the SVLAN (NA, default 0, a
number, P, or DSCP). A number indicates a fixed, user-specified value
is used; P indicates the CVLAN 802.1p bit value is used; DSCP indi-
cates the CVLAN DSCP value is used.

Release History
Release 8.1.1; command introduced.

Related Commands

ethernet-service sap-profile Creates a profile for a VLAN Stacking Service Access Point (SAP).
ethernet-service sap Creates a VLAN Stacking SAP and associates the SAP with a service
and SAP profile.
ethernet-service sap sap-profile Specifies a different SAP profile for the SAP.
show ethernet-service sap Displays configuration information for VLAN Stacking SAPs.

MIB Objects
alaEServiceSapProfileTable
alaEServiceSapProfileID
alaEServiceSapProfileCVLANTreatment
alaEServiceSapProfilePriorityMapMode
alaEServiceSapProfileFixedPriority
alaEServiceSapProfileIngressBW
alaEServiceSapProfileEgressBW
alaEServiceSapProfileBandwidthShare

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 46-43
show ethernet-service sap-profile VLAN Stacking Commands

page 46-44 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
 47 Service Manager
Commands

The Alcatel-Lucent OmniSwitch supports Shortest Path Bridging MAC (SPBM), as defined in the IEEE
802.1aq standard. SPB-M uses the Provider Backbone Bridge (PBB) network model to encapsulate (using
IEEE 802.1ah headers) and tunnel customer traffic through the network backbone. The shortest path trees
(SPTs) upon which the PBB network infrastructure operates are determined using a version of the
Intermediate System-to-Intermediate System (IS-IS) link state protocol that supports TLV extensions for
SPB (ISIS-SPB).
The SPBM network topology consists of two layers: the backbone infrastructure (control plane) layer and
the services (data plane) layer. ISIS-SPB builds the backbone layer by defining loop-free, SPTs through
the backbone network. The service layer is based on the PBB framework as defined in the IEEE 802.1ah
standard. SPBM supports the 802.1ah MAC-in-MAC method for data encapsulation. SPBM services
transport the encapsulated traffic over the ISIS-SPB infrastructure.
The OmniSwitch Service Manager application provides the ability to configure and manage a service-
based architecture consisting of the following logical entities that are required to provision a service:
• Service Instance Identifier (I-SID). A backbone service instance that will tunnel the encapsulated
data traffic through the PBB network. The I-SID is bound to a SPB backbone VLAN (BVLAN) ID and
a Service Manager SPB service ID when the service is created.
• Access Port. A port or link aggregate configured as an SPB access port. This type of port defines the
point at which traffic from other provider networks or directly from customer networks enters the PBB
network. The access port is also associated with a Layer 2 profile that specifies how to process proto-
col control frames received on the port
• Service Access Point (SAP). A SAP is a logical service entity (also refered to as a virtual port) that
binds an access port to an SPB service ID and specifies the type of customer traffic ((untagged, single-
tagged, double-tagged, or all) to encapsulate and tunnel through the PBB network.
• Service Distribution Points (SDPs). A SDP provides a logical point at which customer traffic is
directed from one PE to another PE through a one-way service tunnel.
Once the SPB service-based architecture is defined, the following service components are dynamically
created by the OmniSwitch. No user-configuration is required.
• Service Distribution Point (SDP)—A SDP provides a logical point at which customer traffic is
directed from one backbone edge switch to another. SDPs are used to set up distributed services, which
consist of at least one SAP on a local node, one SAP on a remote node, and an SDP binding the service
on both nodes.
• Mesh SDP—A mesh SDP represents the binding of a SPB service instance to an SDP. The SDP then
distributes the service connectivity to other backbone edge switches through the ISIS-SPB shortest path
trees.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-1
 Service Manager Commands

This chapter documents the Command Line Interface (CLI) commands used to configure and verify the
SPB service-based architecture. For commands used to configure and verify the ISIS-SPB backbone, see
Chapter 8, “Shortest Path Bridging Commands.”
MIB information for the Service Manager commands is as follows:
Filename: AlcatelIND1ServiceMgr.MIB
Module: alcatelIND1ServiceMgrMIB
A summary of the available commands is listed here:

Service Commands service spb

service spb description
service spb stats
service spb admin-state
service spb multicast-mode
service spb vlan-xlation
service stats
Service Access Port service l2profile
Commands service access
service access l2profile
service access vlan-xlation
Service Access Point (SAP) service spb sap
Commands service spb sap description
service spb sap trusted
service spb sap admin-state
service spb sap stats
Clear Commands clear service spb counters
Show Commands show service l2profile
show service access
show service
show service spb ports
show service spb sap
show service sdp
show service mesh-sdp
show service spb debug-info
show service spb counters

page 47-2 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Service Manager Commands service spb

service spb
Configures a Shortest Path Bridging (SPB) service and associates that service with a backbone service
instance identifier (I-SID) and BVLAN. A SPB service connects multiple customer sites together across a
provider-managed core network by creating a virtual zero-hop, Layer 2 switched domain.
service spb service_id isid instance_id bvlan bvlan_id
no service spb {service_id | all} [bvlan bvlan_id]

Syntax Definitions

service_id A unique numerical value to identify a specific SPB service. The valid
service ID range is 1–32767.
instance_id A service instance identifier (I-SID) that is used to identify the SPB ser-
vice in a provider backbone bridge (PBB) network. The valid range is
256–16777214.
bvlan_id The VLAN ID number of an existing SPB BVLAN.
all Specifies all SPB services.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• To remove a SPB service, administratively disable the service then use the no form of this command
and specify the service ID of the disabled service. Use the all parameter to remove all SPB services
from the bridge configuration.
• To remove SPB services from a specific BVLAN, use the no form of this command with the optional
bvlan parameter.
• SPB services created with this command are considered static services, which are identified by a
service ID number between 1 and 32767 (the valid range for this command). If the SPB service was
dynamically created by another OmniSwitch feature, such as Universal Network Profiles (UNP), a
service ID number between 32768 and 65534 is automatically assigned to the dynamic service.
• A SPB service provides E-LAN connectivity for customer traffic and is identified by an I-SID.
Services are bound to service access ports (SAPs) on the access side. On the network side they are
automatically bound to service distribution points by the ISIS-SPB protocol.
• Each SPB service is basically a Virtual Forwarding Instance (VFI) that is capable of learning customer
MAC addresses from the access side (SAPs) and from the network side (Mesh SDP) and then switch-
ing the traffic based on this information.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-3
service spb Service Manager Commands

Examples
-> service spb 1 isid 1000 bvlan 4001
-> no service spb 1

Release History
Release 8.1.1; command was introduced.

Related Commands

service spb description Configures a description for the specified SPB service.
service spb stats Configures the statistics collection status for the specified SPB service.
service spb admin-state Configures the administrative status of the specified SPB service.
service spb multicast-mode Configures the multicast replication mode for the specified SPB service.
service spb vlan-xlation Configures the status of egress VLAN translation for all the service
access points (SAPs) associated with the specified SPB service.
show service Displays the service configuration for the bridge.

MIB Objects
alaSvcBaseInfoTable
alaSvcId
alaSvcType
alaSvcIsid
alaSvcBVlan

page 47-4 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Service Manager Commands service spb description

service spb description

Configures a description for the specified SPB service.
service spb service_id description desc_info
service spb service_id no description

Syntax Definitions

service_id An existing SPB service ID number.

desc_info An ASCII text string up to 160 characters in length.

Defaults
By default, a description is not added when the SPB service is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the description from the specified service ID.

• This command adds or modifies a description for an existing SPB service. However, the description
parameter is also used to specify a description at the time the service is created.

Examples
Adding or modifying a description for an existing SPB service:
-> service spb 100 description "SPB Service for ISID 1234"
-> service spb 10 description SPB1-CustA
-> service spb 10 no description

Configuring a new service with a description:

-> service spb 100 isid 1234 bvlan 3000 description "SPB Service for ISID 1234"

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-5
service spb description Service Manager Commands

Related Commands

service spb Configures a SPB service.

service spb stats Configures the statistics collection status for the specified SPB service.
service spb admin-state Configures the administrative status of the specified SPB service.
service spb multicast-mode Configures the multicast replication mode for the specified SPB service.
service spb vlan-xlation Configures the status of egress VLAN translation for all the service
access points (SAPs) associated with the specified SPB service.
show service Displays the service configuration for the bridge.

MIB Objects
alaSvcBaseInfoTable
alaSvcId
alaSvcDescription

page 47-6 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Service Manager Commands service spb stats

service spb stats

Configures ingress and egress statistics collection for packets flowing through the service access point
(SAP) or service distribution point (SDP) bindings associated with the specified SPB service.
service spb {service_id | all} stats {enable | disable}

Syntax Definitions

service_id An existing SPB service ID number.

all Specifies all SPB services.
enable Administratively enables statistics gathering for the service.
disable Administratively disables statistics gathering for the service.

Defaults
By default, statistics collection is disabled when the service is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• This command configures statistics collection for an existing SPB service. However, the stats {enable |
disable} parameter is also used to specify the status at the time the service is created.
• SPB statistics collection is not active unless the statistics collection capability is enabled for the Switch
Manager application on the local switch. To enable this capability, use the service stats command
before administratively enabling statistics collection for SPB services.

Examples
Configuring statistics collection for an existing SPB service:
-> service spb 100 stats enable
-> service spb all stats enable
-> service spb 100 stats disable
-> service spb all stats disable

Configuring statistics collection for a new SPB service:

-> service spb 200 isid 2345 bvlan 3000 stats enable
-> service spb 300 isid 3456 bvlan 2000 stats disable

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-7
service spb stats Service Manager Commands

Related Commands

service spb Configures a SPB service.

service spb description Configures a description for the specified SPB service.
service spb admin-state Configures the administrative status of the specified SPB service.
service spb multicast-mode Configures the multicast replication mode for the specified SPB service.
service spb vlan-xlation Configures the status of egress VLAN translation for all the service
access points (SAPs) associated with the specified SPB service.
show service Displays the service configuration for the bridge.

MIB Objects
alaSvcBaseInfoTable
alaSvcId
alaSvcStatsAdminStatus

page 47-8 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Service Manager Commands service spb admin-state

service spb admin-state

Configures the administrative status of the specified SPB service.
service spb {service_id | all} admin-state {enable | disable}

Syntax Definitions

service_id An existing SPB service ID number.

all Specifies all SPB services.
enable Administratively enables the service.
disable Administratively disables the service.

Defaults
By default, the administrative status is disabled when the service is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Disable the administrative status of the service and any associated service access points (SAPs) and
service distribution points (SDPs) before attempting to remove a SPB service.
• Disabling the administrative status does not remove the SPB service configuration from the bridge.

• This command configures the administrative status for an existing SPB service. However, the admin-
state {enable | disable} parameter is also used to specify the status at the time the service is created.

Examples
Configuring the status for an existing SPB service:
-> service spb 100 admin-state enable
-> service spb all admin-state enable
-> service spb 100 admin-state disable
-> service spb all admin-state disable

Configuring the status for a new SPB service:

-> service spb 200 isid 2345 bvlan 3000 admin-state enable
-> service spb 300 isid 3456 bvlan 2000 admin-state disable

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-9
service spb admin-state Service Manager Commands

Related Commands

service spb Configures a SPB service.

service spb description Configures a description for the specified SPB service.
service spb stats Configures the statistics collection status for the specified SPB service.
service spb multicast-mode Configures the multicast replication mode for the specified SPB service.
service spb vlan-xlation Configures the status of egress VLAN translation for all the service
access points (SAPs) associated with the specified SPB service.
show service Displays the service configuration for the bridge.

MIB Objects
alaSvcBaseInfoTable
alaSvcId
alaSvcAdminStatus

page 47-10 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Service Manager Commands service spb multicast-mode

service spb multicast-mode

Configures the multicast replication mode for the specified SPB service.
service spb {service_id | all} multicast-mode {head-end | tandem}

Syntax Definitions

service_id An existing SPB service ID number.

all Specifies all SPB services.
head-end Specifies the head-in replication mode for the service.
tandem Specifies the tandem replication mode for the service.

Defaults
By default, the service is configured to use the head-end mode.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• When a SPB service is configured to use the head-in mode, a non-unicast packet received on an SPB
access port is replicated once for each receiver in the provider backbone bridge (PBB) network using
its unicast base MAC (BMAC) address.
• When a SPB service is configured to use the tandem mode, a non-unicast packet received on an SPB
access port is replicated once at each node using the multicast group address.
• Make sure that the same multicast mode is used across all nodes for a given BVLAN. Tandem nodes
and head-end nodes cannot communicate with each other.
• This command configures the multicast mode for an existing SPB service. However, the multicast-
mode {head-end | tandem} parameter is also used to specify the status at the time the service is
created.

Examples
Configuring the status for an existing SPB service:
-> service spb 100 multicast-mode tandem
-> service spb 150 multicast-mode head-end

Configuring the status for a new SPB service:

-> service spb 200 isid 2345 bvlan 3000 multicast-mode tandem

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-11
service spb multicast-mode Service Manager Commands

Related Commands

service spb Configures a SPB service.

service spb description Configures a description for the specified SPB service.
service spb stats Configures the statistics collection status for the specified SPB service.
service spb admin-state Configures the administrative status of the specified SPB service.
service spb vlan-xlation Configures the status of egress VLAN translation for all the service
access points (SAPs) associated with the specified SPB service.
show service Displays the service configuration for the bridge.

MIB Objects
alaSvcBaseInfoTable
alaSvcId
alaSvcMulticastMode

page 47-12 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Service Manager Commands service spb vlan-xlation

service spb vlan-xlation

Configures the status of egress VLAN translation for all the service access points (SAPs) associated with
the specified SPB service.
service spb {service_id | all} vlan-xlation {enable | disable}

Syntax Definitions

service_id An existing SPB service ID number.

all Specifies all SPB services.
enable Enables VLAN translation for the service.
disable Disables VLAN translation for the service.

Defaults
By default, VLAN translation is disabled when the service is created.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Enabling translation at the service level is only applicable if the corresponding access ports for the
SAPs also have VLAN translation enabled.
• This command configures the VLAN translation status for an existing SPB service. However, the vlan-
xlation {enable | disable} parameter is also used to specify the status at the time a service is created.

Examples
Configuring the status for an existing SPB service:
-> service spb 100 vlan-translation enable
-> service spb all vlan-translation enable
-> service spb 100 vlan-translation disable
-> service spb all vlan-translation disable

Configuring the status for a new SPB service:

-> service spb 200 isid 2345 bvlan 3000 vlan-translation enable
-> service spb 300 isid 3456 bvlan 2000 vlan-translation disable

Release History
Release 8.1.1; command was introduced.

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-13
service spb vlan-xlation Service Manager Commands

Related Commands

service spb Configures a SPB service.

service spb description Configures a description for the specified SPB service.
service spb stats Configures the statistics collection status for the specified SPB service.
service spb admin-state Configures the administrative status of the specified SPB service.
service spb multicast-mode Configures the multicast replication mode for the specified SPB service.
service access vlan-xlation Configures the status of VLAN Translation for the specified access port.
show service Displays the service configuration for the bridge.

MIB Objects
alaSvcBaseInfoTable
alaSvcId
alaSvcSapVlanXlation

page 47-14 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Service Manager Commands service stats

service stats
Configures the statistics collection capability for the Service Manager application. When enabled, this
capability is available only for the Shortest Path Bridging (SPB) feature. When disabled, this capability is
available only for the Application Monitoring and Enforcement (AppMon) feature.
service stats {enable | disable}

Syntax Definitions

enable Enables Service Manager statistics collection.

disable Disables Service Manager statistics collection.

Defaults
By default, statistics collection is enabled for the Service Manager application.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Disabling the Service Manager statistics collection capability is required to allow the switch to gather
statistics for the AppMon feature.
• When enabled for Service Manager use, the service spb stats command is still required to
administratively enable or disable statistics collection for one or more SPB services.

Examples
The following command enables stats for AppMon:
-> service stats disable
The following command enables stats for SPB:
-> service stats enable

Release History
Release 8.2.1; command was introduced.

Related Commands

service spb stats Configures the statistics collection status for the specified SPB service.
show service Displays the service configuration for the bridge.

MIB Objects
alaSvcMgrSysTable
alaSvcMgrStatsAdminState

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-15
service l2profile Service Manager Commands

service l2profile
Configures a Layer 2 profile that is applied to an access (customer facing) port. This profile is used to
specify how to process Layer 2 control frames ingressing on the access port.
service l2profile profile-name [stp | 802.1x | 802.1ab | 802.3ad | gvrp | mvrp | amap | pdu | vlan |
uplink] [peer | discard | tunnel]
no service l2profile profile-name

Syntax Definitions

profile-name Alphanumeric string of up to 32 characters. Use quotes around string if

the profile name contains multiple words with spaces between them
(e.g., “Alcatel-Lucent Engineering”).
stp Specifies how to process Spanning Tree BPDU.
802.1x Specifies how to process 802.1x control frames.
802.1ab Specifies how to process 802.1ab control frames.
802.3ad Specifies how to process 802.3ad control frames.
gvrp Specifies how to process GARP VLAN Registration Protocol packets.
mvrp Specifies how to process Multiple VLAN Registration Protocol packets.
amap Specifies how to process Alcatel-Lucent Management Adjacency Proto-
col packets.
peer Allows the access port to participate in the specified protocol. Control
packets are not sent to the network side of the node.
discard Discards the specified PDU.
tunnel Tunnels the specified PDU across the provider network.

Defaults
If no parameters are specified with this command, the new profile inherits all the following protocol
settings from the default profile (def-access-profile):

parameter default
stp tunnel
802.1x discard
802.1ab discard
802.3ad peer
gvrp tunnel
mvrp tunnel
amap discard

Platforms Supported
OmniSwitch 6860, 6860E

page 47-16 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Service Manager Commands service l2profile

Usage Guidelines
• Use the no form of this command to delete a Layer 2 profile. Removing the def-access-profile is not
allowed.
• Remove any profile associations with access ports before attempting to modify or delete the profile.

• Not all of the control protocols are currently supported with the peer, tunnel, and discard parameters.
Use the following table to determine the parameter combinations that are supported:

Protocol Reserved MAC peer discard tunnel

STP 01-80-C2-00-00-00 no yes yes
802.1x 01-80-C2-00-00-03 no yes yes
802.1ab 01-80-C2-00-00-0E no yes yes
802.3ad 01-80-C2-00-00-02 yes no no
GVRP 01-80-C2-00-00-21 no yes yes
MVRP — no yes yes
AMAP 00-20-DA-00-70-04 no yes no

• If a user-configured Layer 2 profile is not associated with an access port, then the def-access-profile is
used to process control packets ingressing on the port.

Examples
-> service l2profile sap_1_profile stp discard
-> no service l2profile sap_1_profile
-> service l2profile DropL2
-> service l2profile DropL2 stp discard gvrp discard 802.1ab discard

Release History
Release 8.1.1; command was introduced.

Related Commands

service access Configures a switch port or link aggregate as an access port.

service access l2profile Assigns a Layer 2 profile to the specified service access port.
show service l2profile Displays the Layer 2 profile configuration information for the bridge.

MIB Objects
alaServiceMgrPortProfileTable
alaServiceMgrPortProfileID
alaServiceMgrPortProfileStpBpduTreatment
alaServiceMgrPortProfile8021xTreatment
alaServiceMgrPortProfile8021ABTreatment
alaEServiceUNIProfileGvrpTreatment
alaServiceMgrPortProfileAmapTreatment
alaServiceMgrPortProfile8023ADTreatment

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-17
service access Service Manager Commands

service access
Configures a switch port or link aggregate as an access port for customer traffic.
service access {port chassis/slot/port[-port2] | linkagg agg_id[-agg_id2]} [description port_description]
service access {port chassis/slot/port[-port2] | linkagg agg_id[-agg_id2]} [no description]
no service access {port slot/port[-port2] | linkagg agg_id[-agg_id2]}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of ID
numbers (5-10).
port_description An alphanumeric string (1–128 characters).

Defaults

parameter default
port_description No description

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to revert the port mode back to the default mode (network).

• Access ports are required to configure a Service Access Point (SAP). A SAP is the point at which
customer traffic enters and exits the provider service. SAPs are not configured on network ports

Examples
-> service access port 1/1/3
-> service access linkagg 10
-> service access port 1/1/6 description "Voice Access Port"
-> service access port 2/1/6 description "L3 VPN Loopback Port"
-> service access linkagg 100 description "Server Access Port"
-> service access port 2/1/6 no description
-> no service access port 1/1/3
-> no service access linkagg 10

Release History
Release 8.1.1; command was introduced.

page 47-18 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Service Manager Commands service access

Related Commands

service l2profile Configures a Layer 2 profile that is used to specify how to process Layer
2 control frames ingressing on the access port.
service access l2profile Assigns a Layer 2 profile to the specified service access port.
show service l2profile Displays the Layer 2 profile configuration information for the bridge.
show service access Displays the access (customer-facing) port configuration for the bridge.

MIB Objects
alaServiceMgrPortTable
alaServiceMgrPortID
alaServiceMgrPortMode
alaServiceMgrPortLinkStatus
alaServiceMgrPortSapType
alaServiceMgrSapCount

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-19
service access l2profile Service Manager Commands

service access l2profile

Assigns an existing Layer 2 profile to the specified service access port. This profile determines how Layer
2 protocol frames ingressing on the access port are processed.
service access {port chassis/slot/port[-port2] | linkagg agg_id[-agg_id2]} l2profile {default |
profile_name}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of ID
numbers (5-10).
default Assigns the default profile to the specified port.
profile_name The name of an existing Layer 2 profile.

Defaults
By default, the default Layer 2 profile (def-access-profile) is assigned when a port is configured as a
service access port.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the default parameter with this command to revert the associated profile back to the default profile
settings.
• Specify only ports or link aggregates that are configured as service access ports. This command does
not apply to network ports.
• Specify a profile name that already exists in the switch configuration.

Examples
-> service access port 1/1/3 l2profile sap_1_profile
-> service access linkagg 10 l2profile sap_1_profile
-> service access port 1/1/3 l2profile default
-> service access linkagg 10 l2profile default

Release History
Release 8.1.1; command was introduced.

page 47-20 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Service Manager Commands service access l2profile

Related Commands

service access Configures a switch port or link aggregate as an access port.

service l2profile Configures a Layer 2 profile that is used to specify how to process Layer
2 control frames ingressing on the access port.
show service l2profile Displays the Layer 2 profile configuration information for the bridge.
show service access Displays the access (customer-facing) port configuration for the switch.

MIB Objects
alaServiceMgrPortTable
alaServiceMgrPortID
alaServiceMgrPortMode
alaServiceMgrPortPortProfileID

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-21
service access vlan-xlation Service Manager Commands

service access vlan-xlation

Configures the status of egress VLAN translation for all the service access points (SAPs) associated with
the specified access port.
service access {port chassis/slot/port[-port2] | linkagg agg_id[-agg_id2]} vlan-xlation {enable | disable}

Syntax Definitions

chassis/slot/port[-port2] The chassis ID, slot, and port number (3/1/1) for a specific port. Use a
hyphen to specify a range of ports (3/1/1-8).
agg_id[-agg_id2] The link aggregate ID number. Use a hyphen to specify a range of ID
numbers (5-10).
enable Enables VLAN translation for the specified port.
disable Disables VLAN translation for the specified port.

Defaults
By default, VLAN translation is disabled when a port or link aggregate is configured as an access port.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Specify only ports or link aggregates that are configured as service access ports. This command does
not apply to SPB interfaces (network ports).
• Enabling VLAN translation on a access port implicitly enables translation for all SAPs associated with
that port. However, translation must also be enabled for the services associated with these SAPs. This
ensures that all SAPs associated with a service will apply VLAN translation.

Examples
-> service access port 1/1/3 vlan-xlation enable
-> service access linkagg 10 vlan-xlation enable
-> service access port 1/1/3 vlan-xlation disable
-> service access linkagg 10 vlan-xlation disable

Release History
Release 8.1.1; command was introduced.

page 47-22 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Service Manager Commands service access vlan-xlation

Related Commands

service access Configures a switch port or link aggregate as an access port.

service spb vlan-xlation Configures the status of egress VLAN translation for the specified SPB
service.
show service access Displays the access (customer-facing) port configuration for the switch.

MIB Objects
alaServiceMgrPortTable
alaServiceMgrPortID
alaServiceMgrPortMode
alaServiceMgrPortVlanXlation

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-23
service spb sap Service Manager Commands

service spb sap

Configures a Service Access Point (SAP) by associating a SAP ID with a SPB service. A SAP ID is
comprised of a customer-facing port (referred to as an access port) and an encapsulation value that is used
to identify the type of customer traffic to map to the associated service.
service spb service_id sap {port chassis/slot/port | linkagg agg_id} [:0 | :all | :qtag | |
:outer_qtag.inner_qtag]
service spb service_id no sap {port chassis/slot/port | linkagg agg_id} [:0 | :all | :qtag |
:outer_qtag.inner_qtag]

Syntax Definitions

service_id An existing SPB service ID number.

chassis/slot/port The chassis ID, slot, and port number (3/1/1) of a service access port.
agg_id The link aggregate ID number of a service access link aggregate.
:0 Specifies a null encapsulation value for the SAP. Only untagged traffic
is mapped to this SAP.
:all Specifies a wildcard SAP. All tagged traffic that is not classified into
another SAP is mapped to the wildcard SAP.
:qtag Specifies a VLAN ID tag for traffic ingressing on the access port. Only
traffic with this tag is mapped to this SAP.
:outer_qtag.inner_qtag Specifies an outer VLAN ID tag and an inner VLAN tag for traffic
ingressing on the access port. Only double-tagged (QinQ) traffic with
the specified outer and inner tags is mapped to this SAP.

Defaults

parameter default
:0 | :all | :qtag | :outer_qtag.inner_qtag :0 (null - untagged traffic)

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove a a SAP.

• The :all (wildcard) parameter is also configurable as the inner tag value for double-tagged packets (for
example, “10:all” specifies double-tagged packets with an outer tag equal to 10 and an inner tag with
any value).
• Specify only ports or link aggregates that are configured as service access ports (see service access).
This command does not apply to network ports.
• Configuring SAPs with different encapsulation types for the same access port is allowed.

page 47-24 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Service Manager Commands service spb sap

Examples
-> service spb 100 sap port 1/1/1:0
-> service spb 100 sap port 1/1/1:50
-> service spb 100 sap port 2/1/10:100.200
-> service apb 100 sap port 2/1/10:500.all
-> service spb 100 sap linkagg 5:10
-> service spb 200 sap port 2/1/1:20.30
-> service spb 200 sap linkagg 9:all
-> service spb 100 no sap 2/1/10:100.200
-> service spb 200 no sap linkagg 9:all

Release History
Release 8.1.1; command was introduced.

Related Commands

service spb sap description Configures a description for the specified SAP ID.
service spb sap trusted Configures the trust mode for the specified SAP ID.
service spb sap admin-state Configures the administrative status for the specified SAP ID.
service spb sap stats Configures statistics collection for the specified SAP ID.
show service spb ports Displays SAP configuration information for the specified service.

MIB Objects
alaSapBaseInfoTable
alaSapPortId
alaSapEncapValue
alaSapSvcId

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-25
service spb sap description Service Manager Commands

service spb sap description

Configures a description for the specified Service Access Point (SAP) ID. A SAP ID is comprised of a
customer-facing port (referred to as an access port) and an encapsulation value that is used to identify the
type of customer traffic to map to the associated service.
service spb service_id sap {port chassis/slot/port | linkagg agg_id} [:0 | :all | :qtag |
:outer_qtag.inner_qtag] description desc_info
service spb service_id no sap {port chassis/slot/port | linkagg agg_id} [:0 | :all | :qtag |
:outer_qtag.inner_qtag] no description

Syntax Definitions

service_id An existing SPB service ID number.

chassis/slot/port The chassis ID, slot, and port number (3/1/1) of a service access port.
agg_id The link aggregate ID number of a service access link aggregate.
:0 Specifies a null encapsulation value for the SAP. Only untagged traffic
is mapped to this SAP.
:all Specifies a wildcard SAP. All tagged traffic that is not classified into
another SAP is mapped to the wildcard SAP.
:qtag Specifies a VLAN ID tag for traffic ingressing on the access port. Only
traffic with this tag is mapped to this SAP.
:outer_qtag.inner_qtag Specifies an outer VLAN ID tag and an inner VLAN tag for traffic
ingressing on the access port. Only double-tagged (QinQ) traffic with
the specified outer and inner tags is mapped to this SAP.
desc_info An ASCII text string up to 160 characters in length.

Defaults
By default, a description is not added when the SAP is created.

parameter default
:0 | :all | :qtag | :outer_qtag.inner_qtag :0 (null - untagged traffic)

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the no form of this command to remove the description from the specified SAP.

• Specify the SPB service ID number associated with the specified SAP ID (access port/encapsulation).

Examples
-> service spb 10 sap port 1/1/2:10 description “CE1 to SPB10 SAP”
-> service spb 13 linkagg 20:100.200 description “CE2 to SPB13 SAP”

page 47-26 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Service Manager Commands service spb sap description

-> service spb 10 sap port 1/1/2:10 no description

-> service spb 13 linkagg 20:100.200 no description

Release History
Release 8.1.1; command was introduced.

Related Commands

service spb sap Configures a SAP by associating a SAP ID with a SPB service.
service spb sap trusted Configures the trust mode for the specified SAP ID.
service spb sap admin-state Configures the administrative status for the specified SAP ID.
service spb sap stats Configures statistics collection for the specified SAP ID.
show service spb ports Displays SAP configuration information for the specified service.

MIB Objects
alaSapBaseInfoTable
alaSapPortId
alaSapEncapValue
alaSapDescription
alaSapSvcId

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-27
service spb sap trusted Service Manager Commands

service spb sap trusted

Configures the trust mode for the specified Service Access Port (SAP) ID. A SAP ID is comprised of a
customer-facing port (referred to as an access port) and an encapsulation value that is used to identify the
type of customer traffic to map to the associated service.
A trusted SAP can accept 802.1p values in incoming packets; an untrusted SAP will set any 802.1p values
to zero in incoming packets, unless an 802.1p value is configured with this command.
service spb service_id sap {port chassis/slot/port | linkagg agg_id} [:0 | :all | :qtag |
:outer_qtag.inner_qtag] trusted
service spb service_id sap {port chassis/slot/port | linkagg agg_id} [:0 | :all | :qtag |
:outer_qtag.inner_qtag] no trusted priority value

Syntax Definitions

service_id An existing SPB ID number.

chassis/slot/port The chassis ID, slot, and port number (3/1/1) of a service access port.
agg_id The link aggregate ID number of a service access link aggregate.
:0 Specifies a null encapsulation value for the SAP. Only untagged traffic
is mapped to this SAP.
:all Specifies a wildcard SAP. All tagged traffic that is not classified into
another SAP is mapped to the wildcard SAP.
:qtag Specifies a VLAN ID tag for traffic ingressing on the access port. Only
traffic with this tag is mapped to this SAP.
:outer_qtag.inner_qtag Specifies an outer VLAN ID tag and an inner VLAN tag for traffic
ingressing on the access port. Only double-tagged (QinQ) traffic with
the specified outer and inner tags is mapped to this SAP.
trusted Allows the SAP to use the priority value obtained from tagged packets
ingressing on the SAP port. Untagged packets use the default port prior-
ity value.
value The priority value to set. Values range from 0 (lowest priority) to 7
(highest priority). This is the priority assigned to tagged and untagged
packets ingressing on an untrusted SAP.

Defaults
By default, the SAP is trusted with the priority set to best effort (zero). These default values are set when a
port is configured as an access port and then associated with the SAP.

parameter default
:0 | :all | :qtag | :outer_qtag.inner_qtag :0 (null - untagged traffic)

Platforms Supported
OmniSwitch 6860, 6860E

page 47-28 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Service Manager Commands service spb sap trusted

Usage Guidelines
• Use the no trusted form of this command with the priority value parameter to configure a priority
value to assign to packets ingressing on the SAP.
• Specify the SPB service ID number associated with the specified SAP ID (access port/encapsulation).

• Administratively disabling the SAP is not required to change the trust mode for the SAP.

• When the trust mode is changed from untrusted to trusted, the priority value is automatically set to the
default best effort priority value (zero).
• Note that untagged Layer 2 control packets (for example, BPDU, GVRP, and AMAP) are always
tunneled (if enabled) through the provider backbone bridge (PBB) network with the default EXP bits
set to 7, so that they can arrive at the destination bridge at the highest COS queue of 7. As a result,
trusted and untrusted SAPs configured on the access ports will not affect the Layer 2 control packets
ingressing on the access ports.
• Configuring the trust mode on an access port is not allowed. These settings are configured for the SAP
to which the access port is associated.

Examples
-> service spb 10 sap port 1/1/2:10 trusted
-> service spb 13 linkagg 20 trusted
-> service spb 10 sap port 1/1/2:10 no trusted priority 7
-> service spb 13 linkagg 20 no trusted

Release History
Release 8.1.1; command was introduced.

Related Commands

service spb sap Configures a SAP by associating a SAP ID with a SPB service.
service spb sap description Configures a description for the specified SAP ID.
service spb sap admin-state Configures the administrative status for the specified SAP ID.
service spb sap stats Configures statistics collection for the specified SAP ID.
show service spb ports Displays SAP configuration information for the specified service.

MIB Objects
alaSapBaseInfoTable
alaSapPortId
alaSapEncapValue
alaSapTrusted
alaSapPriority
alaSapSvcId

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-29
service spb sap admin-state Service Manager Commands

service spb sap admin-state

Configures the administrative status for the specified Service Access Point (SAP) ID. A SAP ID is
comprised of a customer-facing port (referred to as an access port) and an encapsulation value that is used
to identify the type of customer traffic to map to the associated service.
service spb service_id sap {port chassis/slot/port | linkagg agg_id} [:0 | :all | :qtag |
:outer_qtag.inner_qtag] admin-state {enable | disable}

Syntax Definitions

service_id An existing SPB ID number.

chassis/slot/port The chassis ID, slot, and port number (3/1/1) of a service access port.
agg_id The link aggregate ID number of a service access link aggregate.
:0 Specifies a null encapsulation value for the SAP. Only untagged traffic
is mapped to this SAP.
:all Specifies a wildcard SAP. All tagged traffic that is not classified into
another SAP is mapped to the wildcard SAP.
:qtag Specifies a VLAN ID tag for traffic ingressing on the access port. Only
traffic with this tag is mapped to this SAP.
:outer_qtag.inner_qtag Specifies an outer VLAN ID tag and an inner VLAN tag for traffic
ingressing on the access port. Only double-tagged (QinQ) traffic with
the specified outer and inner tags is mapped to this SAP.
enable Enables the administrative status of the SAP.
disable Disables the administrative status of the SAP.

Defaults
By default, the administrative status of the SAP is disabled.

parameter default
:0 | :all | :qtag | :outer_qtag.inner_qtag :0 (null - untagged traffic)

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Specify the SPB service ID number associated with the specified SAP ID (access port/encapsulation).

• Disabling the SAP administrative status does not remove the SAP configuration from the bridge.

• If an access port goes down, all SAPs associated with that port are operationally taken down as well.

Examples
-> service spb 10 sap port 1/1/2:10 admin-state enable
-> service spb 13 linkagg 20 admin-state enable

page 47-30 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Service Manager Commands service spb sap admin-state

-> service spb 10 sap port 1/1/2:10 admin-state disable

-> service spb 13 linkagg 20 admin-state disable

Release History
Release 8.1.1; command was introduced.

Related Commands

service spb sap Configures a SAP by associating a SAP ID with a SPB service.
service spb description Configures a description for the specified SAP ID.
service spb sap trusted Configures the trust mode for the specified SAP ID.
service spb sap stats Configures statistics collection for the specified SAP ID.
show service spb ports Displays SAP configuration information for the specified service.

MIB Objects
alaSapBaseInfoTable
alaSapPortId
alaSapEncapValue
alaSapAdminStatus
alaSapSvcId

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-31
service spb sap stats Service Manager Commands

service spb sap stats

Configures ingress and egress statistics collection for packets flowing through the specified SAP ID. A
SAP ID is comprised of a customer-facing port (referred to as an access port) and an encapsulation value
that is used to identify the type of customer traffic to map to the associated service.
service spb service_id sap {port chassis/slot/port | linkagg agg_num} [:0 | :all | :qtag1 |
:outer_qtag.inner_qtag] stats {enable | disable}

Syntax Definitions

service_id An existing SPB ID number.

chassis/slot/port The chassis ID, slot, and port number (3/1/1) of a service access port.
agg_id The link aggregate ID number of a service access link aggregate.
:0 Specifies a null encapsulation value for the SAP. Only untagged traffic
is mapped to this SAP.
:all Specifies a wildcard SAP. All tagged traffic that is not classified into
another SAP is mapped to the wildcard SAP.
:qtag Specifies a VLAN ID tag for traffic ingressing on the access port. Only
traffic with this tag is mapped to this SAP.
:outer_qtag.inner_qtag Specifies an outer VLAN ID tag and an inner VLAN tag for traffic
ingressing on the access port. Only double-tagged (QinQ) traffic with
the specified outer and inner tags is mapped to this SAP.
enable Enables statistics collection for the SAP.
disable Disables statistics collection for the SAP.

Defaults
By default, statistics collection is disabled for the SAP.

parameter default
:0 | :all | :qtag | :outer_qtag.inner_qtag :0 (null - untagged traffic)

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Specify the SPB service ID number associated with the specified SAP ID (access port/encapsulation).

page 47-32 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Service Manager Commands service spb sap stats

Examples
-> service spb 100 sap port 1/1/2:10 stats enable
-> service spb 101 sap linkagg 20:all stats enable
-> service spb 100 sap port 1/1/2:10 stats disable
-> service spb 101 sap linkagg 20:all stats disable

Release History
Release 8.1.1; command was introduced.

Related Commands

service spb sap Configures a SAP by associating a SAP ID with a SPB service.
service spb sap description Configures a description for the specified SAP ID.
service spb sap trusted Configures the trust mode for the specified SAP ID.
service spb sap admin-state Configures the administrative status for the specified SAP ID.
show service spb ports Displays SAP configuration information for the specified service.

MIB Objects

alaSapBaseInfoTable
alaSapPortId
alaSapEncapValue
alaSapStatsAdminStatus
alaSapSvcId

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-33
show service l2profile Service Manager Commands

show service l2profile

Displays the Layer 2 profile configuration information for the bridge. This type of profile is applied to
access (customer-facing) ports and specifies how to process Layer 2 protocol frames ingressing on such
ports.
show service l2profile [profile_name]

Syntax Definitions

profile_name An existing Layer 2 profile name. Use quotes around string if the profile
name contains multiple words with spaces between them (e.g., “Alcatel-
Lucent Engineering”).

Defaults
By default, all profiles are displayed if a profile name is not specified with this command.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the profile-name parameter to display information for a specific profile. Entering a profile name is
case sensitive.
• If there are no profiles configured for the bridge, this command still displays the information for the
default profile (def-access-profile). This profile is applied to access ports that were not associated with
a specific profile.

Examples
-> show service l2profile
Profile Name: def-access-profile,
STP : tunnel, 802.1X : drop, 802.3AD : peer, 802.1AB : drop,
GVRP : tunnel, AMAP : drop, MVRP : tunnel

Profile Name: DropL2,

STP : drop, 802.1X : drop, 802.3AD : drop, 802.1AB : drop,
GVRP : drop, AMAP : drop, MVRP : tunnel

->show service l2profile DropL2

Profile Name: DropL2,
STP : drop, 802.1X : drop, 802.3AD : drop, 802.1AB : drop,
GVRP : drop, AMAP : drop, MVRP : tunnel

output definitions
Profile Name The name of the Layer 2 profile.
Stp Indicates how Spanning Tree traffic control packets are processed.
802.1x Indicates how IEEE 802.1x control packets are processed.
802.3ad Indicates how IEEE 802.3ad control packets are processed.

page 47-34 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Service Manager Commands show service l2profile

output definitions
802.1AB Indicates how IEEE 802.1AB control packets are processed.
GVRP Indicates how GARP VLAN Registration Protocol packets are pro-
cessed.
AMAP Indicates how Alcatel-Lucent Mapping Adjacency Protocol packets are
processed.
MVRP Indicates how Multiple VLAN Registration Protocol packets are pro-
cessed.

Release History
Release 8.1.1; command was introduced.

Related Commands

service l2profile Configures a Layer 2 profile that is applied to a service access port.
service access l2profile Assigns an existing Layer 2 profile to the specified service access port
show service access Displays the access (customer-facing) port configuration for the bridge.

MIB Objects
alaServiceMgrPortProfileTable
alaServiceMgrPortProfileID
alaServiceMgrPortProfileStpBpduTreatment
alaServiceMgrPortProfileGvrpTreatment
alaServiceMgrPortProfile8021xTreatment
alaServiceMgrPortProfile8021ABTreatment
alaEServiceUNIProfileGvrpTreatment
alaServiceMgrPortProfileAmapTreatment
alaServiceMgrPortProfile8023ADTreatment
alaServiceMgrPortProfileMvrpTreatment

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-35
show service access Service Manager Commands

show service access

Displays the access (customer-facing) port configuration for the bridge.
show service access [port chassis/slot/port | linkagg agg_id]

Syntax Definitions

chassis/slot/port The chassis ID, slot, and port number (3/1/1) of a service access port.
agg_id The link aggregate ID number of a service access link aggregate.

Defaults
By default, all service access ports are displayed if a port or link aggregate number is not specified.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
Use the port slot/port and linkagg agg-id parameters to display the configuration for a specific port or link
aggregate.

Examples
-> show service access
Port Link SAP SAP Vlan
Id Status Type Count Xlation L2Profile
---------+------+-------+-------+-------+------------------------------------
1/1/11 Up Manual 100 N def-access-profile
1/1/12 Up Manual 100 N def-access-profile
1/1/13 Down Manual 100 N def-access-profile
1/1/14 Down Manual 100 N def-access-profile

Total Access Ports: 4

-> show service access port 1/1/14

Port Link SAP SAP Vlan
Id Status Type Count Xlation L2Profile
---------+------+-------+-------+-------+------------------------------------
1/1/14 Down Manual 100 N def-access-profile

Total Access Ports: 4

output definitions
Port Id The access port number or link aggregate ID number.
Link Status The status of the link connection to the access port (Up or Down).
SAP Type Whether or not the SAP associate with the access port was created stat-
ically or dynamically (Manual or Dynamic).

page 47-36 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Service Manager Commands show service access

output definitions
SAP Count The number of service access points (SAPs) that are associated with the
access port.
VLAN Xlation Whether or not VLAN translation is enabled on the access port.
L2Profile The name of the Layer 2 profile associated with the access port. Con-
figured through the service l2profile command.

Release History
Release 8.1.1; command was introduced.

Related Commands

service access Configures a switch port or link aggregate as a service access port.
show service l2profile Displays the Layer 2 profile configuration for the bridge.

MIB Objects
alaServiceMgrPortTable
alaServiceMgrPortID
alaServiceMgrPortLinkStatus
alaServiceMgrPortSapType
alaServiceMgrPortSapCount
alaServiceMgrPortVlanXlation
alaServiceMgrPortPortProfileID

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-37
show service Service Manager Commands

show service
Displays the service configuration for the bridge.
show service [spb]

Syntax Definitions

spb Displays Shortest Path Bridging (SPB) services.

Defaults
By default, all services are displayed.

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• Use the spb parameter to display additional information about SPB services.

• The service ID is a unique number that identifies a specific SPB service. Information associated with
the service ID is displayed.

Examples
-> show service
Legend: * denotes a dynamic object
All Service Info

Svc SAP Bind

ServiceId Type Adm Opr Stats Count Count Description
-----------+-----+----+----+-----+------+-------+---------------------------
100 SPB Up Down Y 8 4 SPB Service 100
200 SPB Up Up Y 7 5 SPB Service 200
32768* SPB Up Up Y 23 4 SPB Dynamic Service 32768
32769* SPB Up Up Y 10 3 SPB Dynamic Service 32769

Total Services: 4

-> show service spb

Legend: * denotes a dynamic object
SPB Service Info
SystemId : 00e0.b1e7.0188, SrcId : 0x70188, SystemName : TOR-1

SAP Bind MCast

ServiceId Adm Oper Stats Count Count Isid BVlan Mode (T/R)
-----------+----+----+-----+-------+-------+---------+-----+--------------
100 Up Down Y 8 4 1000 4001 Headend (0/0)
200 Up Up Y 7 5 1001 4001 Headend (0/0)
32768* Up Up Y 23 4 1002 4001 Headend (0/0)
32769* Up Up Y 10 3 1003 4001 Headend (0/0)

page 47-38 OmniSwitch AOS Release 8 CLI Reference Guide November 2015
Service Manager Commands show service

output definitions
ServiceId The service ID number.
Svc Type The type of service (only SPB is supported).
Adm The administrative state of the service (Up or Down).
Opr The operational state of the service (Up or Down).
Stats Whether or not statistics collection is enabled for the service.
SAP Count The number of service access points (SDPs) associated with this SPB
service.
Bind Count The number of service distribution points (SDPs) bound to this SPB
service.
Description An optional description configured for the service.
ISID The service instance identifier that identifies the SPB service instance
within the provider backbone bridging (PBB) network.
BVLAN The VLAN ID number for the base VLAN to which the SPB service is
mapped.
Mcast Mode The multicast replication mode (Headend or Tandem) for the service.

Release History
Release 8.1.1; command was introduced.

Related Commands

show service sdp Displays the SDP configuration for the bridge.
show service mesh-sdp Displays the Mesh SDP bindings for the bridge.

MIB Objects
alaSvcBaseInfoTable
alaSvcId
alaSvcType
alaSvcAdminStatus
alaSvcOperStatus
alaSvcStatsAdminStatus
alaSvcNumSaps
alaSvcNumSdps
alaSvcDescription
alaSvcIsid
alaSvcBVlan
alaSvcMulticastMode

OmniSwitch AOS Release 8 CLI Reference Guide November 2015 page 47-39
show service spb ports Service Manager Commands

show service spb ports

Displays the virtual ports associated with the specified SPB service.
show service spb service_id ports

Syntax Definitions

service_id An existing SPB service ID number.

Defaults
N/A

Platforms Supported
OmniSwitch 6860, 6860E

Usage Guidelines
• A virtual port represents a Service Access Point (SAP) or a Service Distribution Point (SDP) that is
associated with the specified SPB service.
• In addition to the virtual port configuration, this command also provides the status and additional
configuration information for the SPB service.

Examples
-> show service spb 1525 ports
Legend: * denotes a dynamic object
SPB Service Info
Admin : Up, Oper : Up, Stats : N, Mtu : 1514, VlanXlation : N,
ISID : 2524, BVlan : 4004, MCast-Mode : Headend, Tx/Rx : 0/0

Sap Trusted:Priority/ Sap Description /

Identifier Adm Oper Stats Sdp SystemId:BVlan Intf Sdp SystemName
-----------------+----+----+-----+--------------------+--------+-------------------
sap:1/11:2524 Up Up