Software Reference for GS900MX/MPX Series Switches

Allied Telesis AT-GS948MX-50 User Manual

Displayed below is the user manual for AT-GS948MX-50 by Allied Telesis which is a product in the Network Switches category. This manual has pages.

Related Manuals

Allied Telesis AT-CV5001AC-60 Manual

Allied Telesis AT-CVMNT12 Manual

Allied Telesis AT-STACKXG-00 Manual

Allied Telesis AT-SBX31GS24 Manual

Allied Telesis AT-2911SX/LC-901 Manual

Allied Telesis MC102XLPCI Manual

Allied Telesis AT-9000/28SP-E-50 Manual

Allied Telesis 2716POE/FXSC Manual

Software Reference for GS900MX/MPX Series

Switches

AlliedWare Plus™ Operating System

Version 5.4.4E-1.x

C613-50065-01 REV B

AT-GS924MX

AT-GS924MPX

AT-GS948MX

AT-GS948MPX

Software Reference for GS900MX/MPX Series Switches

ii AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Acknowledgments

This product includes software developed by the University of California, Berkeley and its

contributors.

This product includes software developed by the OpenSSL Project for use in the OpenSSL

Toolkit. For information about this see www.openssl.org/

This product includes software licensed under the GNU General Public License available

from: www.gnu.org/licenses/gpl2.html

Source code for all GPL licensed software in this product can be obtained from the Allied

Telesis GPL Code Download Center at: www.alliedtelesis.com/support/default.aspx

Allied Telesis is committed to meeting the requirements of the open source licenses

including the GNU General Public License (GPL) and will make all required source code

available.

If you would like a copy of the GPL source code contained in Allied Telesis products, please

send us a request by registered mail including a check for US$15 to cover production and

shipping costs and a CD with the GPL code will be mailed to you.

GPL Code Request

Allied Telesis Labs (Ltd)

PO Box 8011

Christchurch

New Zealand

This documentation is subject to change without notice. No part of this publication may

be reproduced, stored in a retrieval system, or transmitted in any form or any means

electronic or mechanical, including photocopying and recording for any purpose other

than the purchaser’s internal use without the written permission of Allied Telesis, Inc.

Allied Telesis, AlliedWare Plus, EPSRing, SwitchBlade, and VCStack are trademarks or

registered trademarks in the United States and elsewhere of Allied Telesis, Inc. Adobe,

Acrobat, and Reader are either registered trademarks or trademarks of Adobe Systems

Incorporated in the United States and/or other countries. Additional brands, names and

products mentioned herein may be trademarks of their respective companies.

Getting the most from this manual

Although you can view this document using Acrobat version 5, to get the best from this

manual, we recommend using Adobe Acrobat Reader version 8 or later. You can download

Acrobat free from www.adobe.com/

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x iii

Table of Contents

Part 1: Setting up the Switch

Chapter 1: Getting Started

Introduction...................................................................................................................................................................... 1.2

How to Login.................................................................................................................................................................... 1.2

How to Get Command Help ....................................................................................................................................... 1.3

Viewing a List of Valid Parameters .................................................................................................................... 1.3

Completing Keywords ........................................................................................................................................... 1.5

Viewing Command Error Messages .................................................................................................................. 1.6

How to Work with Command Modes...................................................................................................................... 1.7

Entering Privileged Exec Commands when in a Configuration Mode................................................. 1.9

How to See the Current Configuration................................................................................................................. 1.10

Default Settings.............................................................................................................................................................1.11

The Default Configuration......................................................................................................................................... 1.12

How to Change the Password..................................................................................................................................1.13

How to Set Strong Passwords..................................................................................................................................1.14

How to Set an IP Address on VLAN 1.....................................................................................................................1.16

How to Save and Boot from the Current Configuration.................................................................................1.17

How to Save to the Default Configuration File...........................................................................................1.17

How to Create and Use a New Configuration File .....................................................................................1.17

How to Return to the Factory Defaults.................................................................................................................1.19

How to See System Information .............................................................................................................................1.20

Viewing Overall System Information..............................................................................................................1.20

Viewing Voltage, Fan Status, and Temperature .........................................................................................1.20

Viewing the Serial Number ................................................................................................................................ 1.21

How to Set System Parameters ...............................................................................................................................1.22

How to Change the Telnet Session Timeout ............................................................................................... 1.22

How to Name the Switch....................................................................................................................................1.23

How to Display a Text Banner at Login.......................................................................................................... 1.24

How to Set the Time and Date................................................................................................................................. 1.25

How to Show Current Settings ......................................................................................................................... 1.25

How to Set the Time and Date..........................................................................................................................1.25

How to Set the Timezone ................................................................................................................................... 1.26

How to Configure Summer-Time.....................................................................................................................1.26

How to Add and Remove Users...............................................................................................................................1.27

Pre-Encrypted Passwords ................................................................................................................................... 1.28

How to Undo Settings.................................................................................................................................................1.30

How to Use the no Parameter ...........................................................................................................................1.30

How to Use the default Parameter .................................................................................................................. 1.30

How to Upgrade the Firmware................................................................................................................................ 1.31

Save Power with the Eco-Friendly Feature..........................................................................................................1.32

The Eco-Friendly LED Feature ...........................................................................................................................1.32

The Eco-Friendly LPI Feature.............................................................................................................................1.32

Trouble-shoot Fiber and Pluggable Issues..........................................................................................................1.33

Using the Find Me feature.........................................................................................................................................1.34

Controlling “show” Command Output.................................................................................................................1.35

Software Reference for GS900MX/MPX Series Switches

iv AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Chapter 2: Command Syntax Conventions in this Software Reference

Chapter 3: Start-Up Sequence

AlliedWare Plus Start-Up.............................................................................................................................................. 3.2

Diagnostic Menu............................................................................................................................................................. 3.3

Bootloader Menu............................................................................................................................................................ 3.4

Start-Up Sequence .......................................................................................................................................................3.10

Chapter 4: CLI Navigation Commands

Command List.................................................................................................................................................................. 4.2

Chapter 5: User Access Commands

Introduction...................................................................................................................................................................... 5.2

Command List.................................................................................................................................................................. 5.2

Using plain passwords........................................................................................................................................... 5.5

Using encrypted passwords ................................................................................................................................ 5.5

Using hidden passwords....................................................................................................................................... 5.6

Using plain passwords........................................................................................................................................... 5.8

Using encrypted passwords ................................................................................................................................ 5.8

Using hidden passwords....................................................................................................................................... 5.9

Chapter 6: Creating and Managing Files

Introduction...................................................................................................................................................................... 6.2

USB Support ..................................................................................................................................................................... 6.2

Working with Files.......................................................................................................................................................... 6.2

Listing Files................................................................................................................................................................. 6.3

Displaying the Contents of Configuration and Text Files ......................................................................... 6.4

Navigating Through the File System ................................................................................................................ 6.4

Using the Editor........................................................................................................................................................ 6.6

Creating and Using Configuration Files ................................................................................................................. 6.8

Creating a Configuration File .............................................................................................................................. 6.8

Specifying the Start-Up Configuration Script................................................................................................ 6.8

Working with Configuration Files...................................................................................................................... 6.9

The Configuration File Fallback Order ...........................................................................................................6.10

Copying Files to and from Your Device................................................................................................................6.12

URL Syntax ...............................................................................................................................................................6.12

Copying Files...........................................................................................................................................................6.13

Copying from a Server to Running Configuration.....................................................................................6.17

The Autoboot Feature ................................................................................................................................................ 6.19

Restoring a Switch Using Autoboot from External Media ......................................................................6.20

Configure Autoboot ............................................................................................................................................. 6.22

Chapter 7: File Management Commands

Introduction...................................................................................................................................................................... 7.3

URL Syntax and Keyword Usage ........................................................................................................................ 7.3

Command List.................................................................................................................................................................. 7.5

Chapter 8: System Configuration and Monitoring Commands

Command List.................................................................................................................................................................. 8.2

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x v

Chapter 9: Debugging and Logging

Introduction...................................................................................................................................................................... 9.2

Debugging........................................................................................................................................................................ 9.2

Logging to a Terminal............................................................................................................................................ 9.2

Turning Off Debugging......................................................................................................................................... 9.3

Logging .............................................................................................................................................................................. 9.3

Log Outputs............................................................................................................................................................... 9.4

Chapter 10: Logging Commands

Command List................................................................................................................................................................ 10.2

Chapter 11: Scripting Commands

Command List................................................................................................................................................................ 11.2

Chapter 12: Interface Commands

Command List................................................................................................................................................................ 12.2

Chapter 13: Interface Testing Commands

Command List................................................................................................................................................................ 13.2

Part 2: Layer Two Switching

Chapter 14: Switching Introduction

Introduction....................................................................................................................................................................14.2

Physical Layer Information........................................................................................................................................14.3

Switch Ports .............................................................................................................................................................14.3

Activating and Deactivating Switch Ports ....................................................................................................14.4

Autonegotiation.....................................................................................................................................................14.4

Duplex Mode...........................................................................................................................................................14.4

Speed Options ........................................................................................................................................................14.4

MDI/MDIX Connection Modes..........................................................................................................................14.5

The Layer 2 Switching Process.................................................................................................................................14.7

The Ingress Rules ...................................................................................................................................................14.7

The Learning Process ...........................................................................................................................................14.8

The Forwarding Process......................................................................................................................................14.9

The Egress Rules.....................................................................................................................................................14.9

Layer 2 Filtering...........................................................................................................................................................14.11

Ingress Filtering....................................................................................................................................................14.11

Storm Control...............................................................................................................................................................14.12

Loop Protection...........................................................................................................................................................14.13

Loop Detection ....................................................................................................................................................14.13

Thrash Limiting.....................................................................................................................................................14.14

Support for Jumbo Frames .....................................................................................................................................14.16

Port Mirroring...............................................................................................................................................................14.17

Port Security .................................................................................................................................................................14.18

IEEE 802.1X.............................................................................................................................................................14.18

Static MAC Address.............................................................................................................................................14.18

Quality of Service........................................................................................................................................................14.19

IGMP Snooping............................................................................................................................................................14.20

Software Reference for GS900MX/MPX Series Switches

vi AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Chapter 15: Switching Commands

Command List................................................................................................................................................................ 15.2

Chapter 16: VLAN Introduction

VLANs Introduction...................................................................................................................................................... 16.2

Virtual LANs (VLANs)....................................................................................................................................................16.2

Configuring VLANs................................................................................................................................................ 16.3

Private VLANs.................................................................................................................................................................16.5

Private VLANs for Ports in Access Mode........................................................................................................16.5

Private VLAN Operation with Ports in Access Mode.................................................................................16.7

Access Mode Private VLAN Configuration Example ................................................................................. 16.8

Private VLANs for Trunked Ports ....................................................................................................................16.11

Trunked Port Private VLAN Configuration Example ...............................................................................16.12

Protocol Based VLAN Configuration Example ..........................................................................................16.16

Chapter 17: VLAN Commands

Command List................................................................................................................................................................ 17.2

Chapter 18: Spanning Tree Introduction: STP, RSTP, and MSTP

Introduction....................................................................................................................................................................18.2

Overview of Spanning Trees.....................................................................................................................................18.2

Spanning Tree Operation ................................................................................................................................... 18.2

Spanning Tree Modes .......................................................................................................................................... 18.4

Spanning Tree Protocol (STP)................................................................................................................................... 18.5

Configuring STP ............................................................................................................................................................18.6

Rapid Spanning Tree Protocol (RSTP) ...................................................................................................................18.8

Configuring RSTP.......................................................................................................................................................... 18.9

Multiple Spanning Tree Protocol (MSTP)...........................................................................................................18.11

Multiple Spanning Tree Instances (MSTI)....................................................................................................18.12

MSTP Regions........................................................................................................................................................18.13

Common and Internal Spanning Tree (CIST).............................................................................................18.15

MSTP Bridge Protocol Data Units (BPDUs) .................................................................................................18.17

Configuring MSTP.......................................................................................................................................................18.19

Chapter 19: Spanning Tree Commands

Command List................................................................................................................................................................ 19.3

Chapter 20: Link Aggregation Introduction and Configuration

Introduction and Overview.......................................................................................................................................20.2

Static and Dynamic (LACP) Link Aggregation....................................................................................................20.3

Static Channel Groups .........................................................................................................................................20.3

Dynamic (LACP) Channel Groups .................................................................................................................... 20.3

Link Aggregation Control Protocol (LACP)...................................................................................................20.3

Configuring an LACP Channel Group....................................................................................................................20.5

Minimal LACP Group Configuration ...............................................................................................................20.8

Configuring a Static Channel Group......................................................................................................................20.9

Chapter 21: Link Aggregation Commands

Introduction....................................................................................................................................................................21.2

Command List................................................................................................................................................................ 21.3

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x vii

Chapter 22: Power over Ethernet Introduction

Introduction....................................................................................................................................................................22.2

PoE Standards.........................................................................................................................................................22.2

PoE (all standards) .................................................................................................................................................22.3

PoE (IEEE 802.3af)...................................................................................................................................................22.3

Enhanced PoE .........................................................................................................................................................22.3

PoE+ (IEEE 802.3at)................................................................................................................................................22.3

Differences Between PoE and PoE+................................................................................................................22.5

LLDP-MED (TIA-1057) with PoE+ (IEEE 802.3at)..........................................................................................22.5

PoE and PoE+ Applications................................................................................................................................22.5

Power Device (PD) Discovery ............................................................................................................................22.5

Power Classes..........................................................................................................................................................22.6

Power through the Cable ...................................................................................................................................22.7

Cable Types.............................................................................................................................................................. 22.8

Static and Automatic Power Allocation.........................................................................................................22.8

PoE and PoE+ Implementation ...............................................................................................................................22.9

Power Capacity.......................................................................................................................................................22.9

PoE Port Allocation and Distribution.............................................................................................................. 22.9

Power Threshold....................................................................................................................................................22.9

Negotiating Power Requirements.................................................................................................................22.10

PoE Port Management.......................................................................................................................................22.10

Powered Device (PD) Detection.....................................................................................................................22.10

Port Prioritization.................................................................................................................................................22.10

Software Monitoring ..........................................................................................................................................22.12

PoE and PoE+ Configuration..................................................................................................................................22.13

Add a Description for a PoE or PoE+ Port ...................................................................................................22.13

Configuring Capacity and Priority on a PoE or PoE+ Port.....................................................................22.14

Remotely Monitoring Power for all Connected PDs ...............................................................................22.15

Chapter 23: Power over Ethernet Commands

Introduction....................................................................................................................................................................23.2

Command List................................................................................................................................................................23.2

Part 3: IP and IPv6

Chapter 24: Internet Protocol (IP) Addressing and Protocols

Introduction....................................................................................................................................................................24.2

Address Resolution Protocol (ARP) ........................................................................................................................ 24.3

Static ARP Entries...................................................................................................................................................24.3

Timing Out ARP Entries ....................................................................................................................................... 24.3

Deleting ARP Entries.............................................................................................................................................24.4

ARP Logging............................................................................................................................................................ 24.5

DNS Client .......................................................................................................................................................................24.6

Internet Control Message Protocol (ICMP)..........................................................................................................24.8

Checking IP Connections...........................................................................................................................................24.9

Ping.............................................................................................................................................................................24.9

Traceroute ................................................................................................................................................................ 24.9

Chapter 25: IP Addressing and Protocol Commands

Introduction....................................................................................................................................................................25.2

Command List................................................................................................................................................................25.3

Software Reference for GS900MX/MPX Series Switches

viii AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Chapter 26: IPv6 Introduction

Introduction....................................................................................................................................................................26.2

Overview..........................................................................................................................................................................26.2

IPv6 Addresses and Prefixes .....................................................................................................................................26.3

Address Types.........................................................................................................................................................26.3

IPv6 Headers............................................................................................................................................................26.4

The Internet Control Message Protocol (ICMPv6)...................................................................................... 26.7

IPv6 Routing ..........................................................................................................................................................26.10

Integration of IPv4 and IPv6 ............................................................................................................................26.10

IPv6 on your Switch ...................................................................................................................................................26.11

Enabling IPv6.........................................................................................................................................................26.11

IPv6 Stateless Address Autoconfiguration (SLAAC)................................................................................26.11

IPv6 EUI-64 Addressing......................................................................................................................................26.11

IPv6 Link-local Addresses..................................................................................................................................26.12

Chapter 27: IPv6 Commands

Command List................................................................................................................................................................ 27.2

Chapter 28: Route Selection

Introduction....................................................................................................................................................................28.2

Types of Routes .............................................................................................................................................................28.2

Interface Routes .....................................................................................................................................................28.2

Static Routes............................................................................................................................................................28.2

RIP Routes.................................................................................................................................................................28.3

RIB and FIB Routing Tables........................................................................................................................................28.4

Understanding the Routing Information Base (RIB).................................................................................. 28.4

Administrative Distance...................................................................................................................................... 28.5

Metric .........................................................................................................................................................................28.6

Equal Cost Multipath Routing...........................................................................................................................28.7

How AlliedWare Plus Deletes Routes .............................................................................................................28.7

How AlliedWare Plus Adds Routes ..................................................................................................................28.8

Troubleshooting Routes not Installed in the RIB .......................................................................................28.9

Troubleshooting Routes not Installed in the FIB........................................................................................28.9

Chapter 29: Routing Commands

Introduction....................................................................................................................................................................29.2

Command List................................................................................................................................................................29.3

Chapter 30: RIP Configuration

Introduction....................................................................................................................................................................30.2

Enabling RIP.................................................................................................................................................................... 30.2

Specifying the RIP Version......................................................................................................................................... 30.4

RIPv2 Authentication (Single Key).......................................................................................................................... 30.6

RIPv2 Text Authentication (Multiple Keys)..........................................................................................................30.8

RIPv2 md5 authentication (Multiple Keys) ........................................................................................................30.12

Chapter 31: RIP Commands

Introduction....................................................................................................................................................................31.2

Command List................................................................................................................................................................31.3

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x ix

Part 4: Multicast Applications

Chapter 32: IGMP Snooping Introduction

Introduction....................................................................................................................................................................32.2

IGMP ..................................................................................................................................................................................32.3

Joining a Multicast Group (Membership Report)....................................................................................... 32.4

Staying in the Multicast Group (Query Message) ......................................................................................32.4

Leaving the Multicast Group (Leave Message)...........................................................................................32.4

IGMP Snooping..............................................................................................................................................................32.5

How IGMP Snooping Operates.........................................................................................................................32.5

IGMP Snooping and Querier Configuration Example ..............................................................................32.6

Query Solicitation .........................................................................................................................................................32.9

How Query Solicitation Works ..........................................................................................................................32.9

Query Solicitation Operation............................................................................................................................. 32.9

Speeding up IGMP Convergence in a Non-Looped Topology............................................................32.12

Enabling Query Solicitation on Multiple Switches in a Looped Topology .....................................32.12

Chapter 33: IGMP Snooping Commands

Introduction....................................................................................................................................................................33.2

Command List................................................................................................................................................................33.2

Chapter 34: MLD Snooping Introduction and Configuration

Introduction....................................................................................................................................................................34.2

MLD Snooping........................................................................................................................................................ 34.2

Chapter 35: MLD Snooping Commands

Command List................................................................................................................................................................ 35.2

Part 5: Access and Security

Chapter 36: Access Control Lists Introduction

Introduction....................................................................................................................................................................36.2

Overview...................................................................................................................................................................36.2

ACL Rules ..................................................................................................................................................................36.3

ACL Source and Destination Addresses ........................................................................................................36.3

ACL Reverse Masking ...........................................................................................................................................36.3

Hardware and Software ACL Types........................................................................................................................36.4

Defining Hardware MAC ACLs ..........................................................................................................................36.5

Defining Hardware IP ACLs ................................................................................................................................36.6

Actions for Hardware ACLs.................................................................................................................................36.7

Attaching Hardware ACLs to Interfaces ........................................................................................................36.7

Hardware ACLs and QoS Classifications...............................................................................................................36.8

Classifying Your Traffic.........................................................................................................................................36.8

Security ACLs...........................................................................................................................................................36.8

QoS ACLs...................................................................................................................................................................36.9

Attaching Hardware ACLs Using QoS ............................................................................................................36.9

Filtering Hardware ACLs with QoS ................................................................................................................36.11

Using QoS Match Commands with TCP Flags...........................................................................................36.11

ACL Filter Sequence Numbers ...............................................................................................................................36.14

ACL Filter Sequence Number Behavior .......................................................................................................36.14

ACL Filter Sequence Number Applicability................................................................................................36.14

Software Reference for GS900MX/MPX Series Switches

xAlliedWare Plus

TM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

ACL Filter Sequence Number Types .............................................................................................................36.15

ACL Filter Sequence Configuration......................................................................................................................36.18

Creating ACLs in Global Configuration Mode...........................................................................................36.20

Display the ACL configuration details..........................................................................................................36.22

Chapter 37: IPv4 Hardware Access Control List (ACL) Commands

Introduction....................................................................................................................................................................37.2

IPv4 Hardware Access List Commands and Prompts ...................................................................................... 37.3

Command List................................................................................................................................................................ 37.4

Chapter 38: IPv4 Software Access Control List (ACL) Commands

Introduction....................................................................................................................................................................38.2

IPv4 Software Access List Commands and Prompts........................................................................................38.3

Command List................................................................................................................................................................ 38.4

Chapter 39: IPv6 Software Access Control List (ACL) Commands

Introduction....................................................................................................................................................................39.2

IPv6 Software Access List Commands and Prompts........................................................................................39.3

Command List................................................................................................................................................................ 39.4

Chapter 40: Quality of Service (QoS) Introduction

Introduction....................................................................................................................................................................40.2

QoS Operations ......................................................................................................................................................40.2

QoS Packet Information .............................................................................................................................................40.3

Link Layer QoS ........................................................................................................................................................ 40.3

Differentiated Services Architecture...............................................................................................................40.4

The Differential Services Field...........................................................................................................................40.5

Processing Pre-Marked Packets........................................................................................................................40.6

Applying QoS on Your Switch..................................................................................................................................40.7

Classifying Your Data ..................................................................................................................................................40.7

Class Maps ................................................................................................................................................................ 40.7

Policy Maps ............................................................................................................................................................40.10

Premarking and Remarking Your Traffic ............................................................................................................40.11

CoS to Egress Queue Premarking ..................................................................................................................40.11

DSCP to Egress Queue Premarking...............................................................................................................40.13

Policing (Metering) Your Data................................................................................................................................40.15

Single-Rate Three-Color Policing ...................................................................................................................40.15

Two-Rate Three-Color Policing.......................................................................................................................40.16

Configuring and Applying a Policer..............................................................................................................40.17

Remarking Your Data ................................................................................................................................................40.18

Configuring the Egress Queues.............................................................................................................................40.19

Egress Queues and QoS markers ...................................................................................................................40.19

Egress Queue Commands Hierarchy ............................................................................................................40.19

Egress Queue Shaping..............................................................................................................................................40.21

Scheduling .............................................................................................................................................................40.21

Drop Mode .............................................................................................................................................................40.22

Storm Protection.........................................................................................................................................................40.24

Chapter 41: QoS Commands

Command List................................................................................................................................................................ 41.2

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x xi

Chapter 42: Authentication Introduction and Configuration

Authentication Introduction ....................................................................................................................................42.2

Configuring a Guest VLAN..................................................................................................................................42.2

802.1X-Authentication ...............................................................................................................................................42.3

Web-Authentication....................................................................................................................................................42.4

What is Web-Authentication? ...........................................................................................................................42.4

Web-Authentication Basics................................................................................................................................42.4

Configuring Web-Authentication....................................................................................................................42.6

Starting a Web-Authentication Session ........................................................................................................ 42.8

Configuring an External Login Page.............................................................................................................42.10

Customizing Web-Authentication Login Page .........................................................................................42.13

Support for Protocols Underlying Web-Authentication .......................................................................42.15

Web-Authentication Timeout Connect .......................................................................................................42.20

Web Authorization Proxy..................................................................................................................................42.21

MAC-Authentication..................................................................................................................................................42.22

Why is MAC-Authentication Required? .......................................................................................................42.22

How Does MAC-Authentication Work? .......................................................................................................42.22

Configuring MAC-Authentication .................................................................................................................42.23

Tri-Authentication......................................................................................................................................................42.24

Tri-Authentication Configuration.........................................................................................................................42.25

Two-Step Authentication ........................................................................................................................................42.27

Ensuring Authentication Methods Require Different Usernames and Passwords .............................42.28

Roaming Authentication .........................................................................................................................................42.29

Roaming Authentication Overview ..............................................................................................................42.30

Roaming Authentication Feature Interactions .........................................................................................42.31

Unauthenticated Supplicant Traffic.....................................................................................................................42.32

Deciding When a Supplicant Fails Authentication..................................................................................42.34

Failed Authentication VLAN ............................................................................................................................42.35

Limitations on Allowed Feature Combinations........................................................................................42.35

Chapter 43: Authentication Commands

Command List................................................................................................................................................................ 43.3

Chapter 44: AAA Introduction and Configuration

AAA Introduction..........................................................................................................................................................44.2

Available Functions and Server Types ...........................................................................................................44.2

Server Groups and Method Lists......................................................................................................................44.3

Configuring AAA Login Authentication ............................................................................................................... 44.5

AAA Configuration Tasks ....................................................................................................................................44.5

Sample Authentication Configurations................................................................................................................44.7

Sample 802.1X-Authentication Configuration ........................................................................................... 44.7

Sample MAC-Authentication Configuration ...............................................................................................44.8

Sample Web-Authentication Configuration................................................................................................ 44.9

Sample Tri-Authentication Configuration..................................................................................................44.10

Chapter 45: AAA Commands

Command List................................................................................................................................................................ 45.2

Chapter 46: 802.1X Introduction and Configuration

Introduction....................................................................................................................................................................46.2

802.1X System Components .............................................................................................................................46.2

The 802.1X Implementation .....................................................................................................................................46.5

Configuring 802.1X ......................................................................................................................................................46.6

Software Reference for GS900MX/MPX Series Switches

xii AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Chapter 47: 802.1X Commands

Command List................................................................................................................................................................ 47.2

Chapter 48: RADIUS Introduction and Configuration

Introduction....................................................................................................................................................................48.2

RADIUS Packets ...................................................................................................................................................... 48.3

RADIUS Attributes .................................................................................................................................................48.4

RADIUS Security .....................................................................................................................................................48.5

RADIUS Proxy .......................................................................................................................................................... 48.6

RADIUS Accounting .............................................................................................................................................. 48.7

RADIUS Configuration ................................................................................................................................................ 48.9

Switch Configuration Tasks................................................................................................................................48.9

Switch to RADIUS Server Communication .................................................................................................48.10

AAA Server Groups Configuration.................................................................................................................48.12

RADIUS Configuration Examples ..........................................................................................................................48.15

RADIUS Authentication .....................................................................................................................................48.15

Single RADIUS Server Configuration ............................................................................................................48.16

Multiple RADIUS Server Configuration ........................................................................................................48.17

RADIUS Server Group Configuration............................................................................................................48.17

RADIUS Server Configuration using Server Groups ................................................................................48.18

Chapter 49: RADIUS Commands

Command List................................................................................................................................................................ 49.2

Chapter 50: TACACS+ Introduction and Configuration

Introduction....................................................................................................................................................................50.2

TACACS+ Overview......................................................................................................................................................50.2

The AlliedWare Plus TACACS+ Implementation ........................................................................................50.2

Authentication........................................................................................................................................................50.3

Authorization ..........................................................................................................................................................50.3

Accounting...............................................................................................................................................................50.4

Configuration.................................................................................................................................................................50.5

Configure TACACS+..............................................................................................................................................50.5

TACACS+ Configuration Example ...................................................................................................................50.7

Chapter 51: TACACS+ Commands

Command List................................................................................................................................................................ 51.2

Chapter 52: Secure Shell (SSH) Introduction

Introduction....................................................................................................................................................................52.2

Secure Shell on the AlliedWare Plus OS.........................................................................................................52.2

Configuring the SSH Server ......................................................................................................................................52.4

Creating a Host Key............................................................................................................................................... 52.4

Enabling the Server...............................................................................................................................................52.4

Modifying the Server............................................................................................................................................52.5

Validating the Server Configuration...............................................................................................................52.6

Adding SSH Users ..................................................................................................................................................52.6

Authenticating SSH Users...................................................................................................................................52.7

Adding a Login Banner........................................................................................................................................ 52.7

Monitoring the Server and Managing Sessions..........................................................................................52.8

Debugging the Server..........................................................................................................................................52.8

Configuring the SSH Client ....................................................................................................................................... 52.9

Modifying the Client.............................................................................................................................................52.9

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x xiii

Adding SSH Servers ............................................................................................................................................52.10

Authenticating with a Server...........................................................................................................................52.10

Connecting to a Server and Running Commands...................................................................................52.11

Copying files to and from the Server............................................................................................................52.11

Debugging the Client ........................................................................................................................................52.11

Chapter 53: Secure Shell (SSH) Configuration

SSH Server Configuration Example........................................................................................................................53.2

Chapter 54: Secure Shell (SSH) Commands

Introduction....................................................................................................................................................................54.2

Command List................................................................................................................................................................54.2

Chapter 55: DHCP Snooping Introduction and Configuration

Introduction....................................................................................................................................................................55.2

DHCP Snooping.............................................................................................................................................................55.2

DHCP Snooping Database..................................................................................................................................55.3

DHCP Relay Agent Option 82............................................................................................................................55.4

Traffic Filtering with DHCP Snooping ............................................................................................................55.6

ARP Security.............................................................................................................................................................55.8

MAC Address Verification ...................................................................................................................................55.8

DHCP Snooping Violations.................................................................................................................................55.8

Interactions with Other Features ............................................................................................................................55.9

Configuration...............................................................................................................................................................55.10

Configure DHCP Snooping...............................................................................................................................55.10

Disabling DHCP Snooping................................................................................................................................55.16

Related Features ..................................................................................................................................................55.16

Chapter 56: DHCP Snooping Commands

Command List................................................................................................................................................................ 56.2

Part 6: Network Availability

Chapter 57: EPSR Introduction and Configuration

Introduction....................................................................................................................................................................57.2

Ring Components and Operation ..........................................................................................................................57.2

Fault Detection and Recovery..................................................................................................................................57.4

Fault Recovery ........................................................................................................................................................ 57.4

Restoring Normal Operation .............................................................................................................................57.5

Managing Rings with Two Breaks....................................................................................................................57.6

Recovery When One Break is Restored.......................................................................................................... 57.8

Configuration Examples...........................................................................................................................................57.10

Single Domain, Single Ring Network............................................................................................................57.10

Single Ring, Dual Domain Network...............................................................................................................57.16

Interconnected Rings................................................................................................................................................57.17

Superloop Protection.........................................................................................................................................57.18

EPSR Superloop Prevention.............................................................................................................................57.19

Configuring a Basic Superloop Protected Two Ring EPSR Network..................................................57.22

Sample Show Output .........................................................................................................................................57.37

Adding a New Data VLAN to a Functioning Superloop Topology.....................................................57.41

EPSR and Spanning Tree Operation..............................................................................................................57.44

Software Reference for GS900MX/MPX Series Switches

xiv AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Chapter 58: EPSR Commands

Command List................................................................................................................................................................ 58.2

Chapter 59: RRP Snooping Introduction and Commands

RRP Snooping Introduction ......................................................................................................................................59.2

Command List................................................................................................................................................................ 59.3

Part 7: Network Management

Chapter 60: AMF Introduction and Configuration

Introduction to AMF .................................................................................................................................................... 60.2

AMF on GS900MX/MPX Series Switches: AMF Edge........................................................................................ 60.2

AMF Supported Products and Software Versions............................................................................................. 60.2

Key Benefits of AMF .....................................................................................................................................................60.4

Unified Command-Line ....................................................................................................................................... 60.4

Configuration Backup and Recovery.............................................................................................................. 60.4

Rolling-Reboot Upgrade ..................................................................................................................................... 60.4

Node Provisioning................................................................................................................................................. 60.5

AMF Terminology and Introduction......................................................................................................................60.6

AMF Network ..........................................................................................................................................................60.6

AMF Nodes...............................................................................................................................................................60.6

Node Licensing.......................................................................................................................................................60.6

Node Interconnection..........................................................................................................................................60.7

AMF Domains..........................................................................................................................................................60.7

AMF Network Operational Concepts ....................................................................................................................60.9

Retention and Use of the ‘Manager’ Username..........................................................................................60.9

Working-Set .............................................................................................................................................................60.9

AMF Restricted Login .........................................................................................................................................60.10

Loop-Free Data Plane.........................................................................................................................................60.10

Aggregators...........................................................................................................................................................60.10

VCStacks..................................................................................................................................................................60.10

AMF External Removable Media ....................................................................................................................60.10

AMF Interaction with QoS and ACLs.............................................................................................................60.11

NTP and AMF.........................................................................................................................................................60.11

Configuring AMF.........................................................................................................................................................60.13

Verifying the AMF Network.....................................................................................................................................60.19

Configuring Multiple Nodes at the Same Time: the Unified CLI................................................................60.21

Working-Set Groups ...........................................................................................................................................60.22

Executing Commands on Working-Sets......................................................................................................60.23

Interactive Commands ......................................................................................................................................60.26

AMF Backups ................................................................................................................................................................60.27

Using External Media Storage.........................................................................................................................60.27

Performing a Manual Backup..........................................................................................................................60.28

Backing up to Remote Servers........................................................................................................................60.29

Node Recovery ............................................................................................................................................................60.31

Automatic Node Recovery ...............................................................................................................................60.31

Restoring a Node to a “Clean” State..............................................................................................................60.32

Manual Node Recovery .....................................................................................................................................60.33

Node Recovery on VCStacks............................................................................................................................60.34

AMF Safe Configuration ...........................................................................................................................................60.35

Detecting AMF Safe Configuration Operation..........................................................................................60.35

AMF Safe Configuration Procedures ............................................................................................................60.35

Undoing an AMF Safe Configuration ...........................................................................................................60.36

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x xv

Rolling-Reboot Firmware Upgrade......................................................................................................................60.38

Performing a Rolling-Reboot Upgrade ........................................................................................................60.40

Node Provisioning......................................................................................................................................................60.42

Chapter 61: AMF Commands

Introduction....................................................................................................................................................................61.3

AMF on GS900MX/MPX Series Switches: AMF Edge.................................................................................61.3

AMF Naming Convention ...................................................................................................................................61.3

Chapter 62: NTP Introduction and Configuration

Introduction....................................................................................................................................................................62.2

Overview..........................................................................................................................................................................62.2

NTP on the Switch ........................................................................................................................................................ 62.3

Troubleshooting ...........................................................................................................................................................62.4

Configuration Example...............................................................................................................................................62.5

Chapter 63: NTP Commands

Command List................................................................................................................................................................ 63.2

Chapter 64: Dynamic Host Configuration Protocol (DHCP) Introduction

Introduction....................................................................................................................................................................64.2

DHCP .......................................................................................................................................................................... 64.2

DHCP Relay Agents ...............................................................................................................................................64.2

Configuring the DHCP Client....................................................................................................................................64.3

DHCP Relay Agent Introduction..............................................................................................................................64.4

Configuring the DHCP Relay Agent ................................................................................................................64.4

DHCP Relay Agent Information Option (Option 82) .................................................................................64.5

Chapter 65: Dynamic Host Configuration Protocol (DHCP) Commands

Command List................................................................................................................................................................ 65.2

Chapter 66: SNMP Introduction

Introduction....................................................................................................................................................................66.2

Network Management Framework........................................................................................................................66.2

Structure of Management Information ................................................................................................................66.4

Names ........................................................................................................................................................................66.5

Instances ................................................................................................................................................................... 66.6

Syntax ........................................................................................................................................................................66.7

Access ........................................................................................................................................................................66.7

Status .........................................................................................................................................................................66.7

Description...............................................................................................................................................................66.7

The SNMP Protocol ...................................................................................................................................................... 66.8

SNMP Versions........................................................................................................................................................66.8

SNMP Messages .....................................................................................................................................................66.9

Polling versus Event Notification.....................................................................................................................66.9

Message Format for SNMPv1 and SNMPv2c..............................................................................................66.10

SNMP Communities (Version v1 and v2c) ..................................................................................................66.11

SNMPv3 Entities ...................................................................................................................................................66.11

SNMPv3 Message Protocol Format...............................................................................................................66.12

SNMPv1 and SNMPv2c .............................................................................................................................................66.13

SNMP MIB Views for SNMPv1 and SNMPv2c .............................................................................................66.13

SNMP Communities............................................................................................................................................66.13

Software Reference for GS900MX/MPX Series Switches

xvi AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Configuration Example (SNMPv1 and v2) ..................................................................................................66.15

SNMPv3 ..........................................................................................................................................................................66.18

SNMP MIB Views for SNMPv3 ..........................................................................................................................66.18

SNMP Groups ........................................................................................................................................................66.18

SNMP Users............................................................................................................................................................66.18

Configuration Example (SNMPv3) .................................................................................................................66.19

Using SNMP to Manage Files and Software ......................................................................................................66.20

Copy a File to or from a TFTP Server.............................................................................................................66.20

Upgrade Software and Configuration Files................................................................................................66.22

Chapter 67: SNMP Commands

Command List................................................................................................................................................................ 67.2

Chapter 68: SNMP MIBs

Introduction....................................................................................................................................................................68.2

About MIBs...............................................................................................................................................................68.2

About SNMP ............................................................................................................................................................68.2

Obtaining MIBs.......................................................................................................................................................68.2

Loading MIBs...........................................................................................................................................................68.3

Allied Telesis Enterprise MIB..................................................................................................................................... 68.5

AT-ALMMON-MIB .................................................................................................................................................. 68.6

AT-ATMF-MIB ..........................................................................................................................................................68.8

AT-BOARDS-MIB...................................................................................................................................................68.13

AT-DHCPSN-MIB...................................................................................................................................................68.17

AT-DNS-CLIENT-MIB............................................................................................................................................68.20

AT-ENVMONv2-MIB.............................................................................................................................................68.21

AT-EPSRv2-MIB .....................................................................................................................................................68.29

AT-FILEv2-MIB .......................................................................................................................................................68.32

AT-IP-MIB ................................................................................................................................................................68.39

AT-LICENSE-MIB ...................................................................................................................................................68.41

AT-LOG-MIB ...........................................................................................................................................................68.44

AT-LOOPPROTECT-MIB ......................................................................................................................................68.46

AT-MIBVERSION-MIB...........................................................................................................................................68.48

AT-NTP-MIB............................................................................................................................................................68.49

AT-PRODUCTS-MIB..............................................................................................................................................68.52

AT-RESOURCE-MIB ..............................................................................................................................................68.55

AT-SETUP-MIB .......................................................................................................................................................68.57

AT-SMI-MIB.............................................................................................................................................................68.66

AT-SYSINFO-MIB...................................................................................................................................................68.68

AT-TRIGGER-MIB...................................................................................................................................................68.73

AT-USER-MIB .........................................................................................................................................................68.75

AT-VCSTACK-MIB .................................................................................................................................................68.77

Other Enterprise MIBs ...............................................................................................................................................68.82

Public MIBs....................................................................................................................................................................68.83

Chapter 69: LLDP, LLDP-MED and Voice VLAN Introduction and Configuration

Introduction....................................................................................................................................................................69.2

Link Layer Discovery Protocol..................................................................................................................................69.2

LLDP-MED........................................................................................................................................................................69.3

Voice VLAN...................................................................................................................................................................... 69.3

LLDP Advertisements..................................................................................................................................................69.4

Type-Length-Value (TLV) ....................................................................................................................................69.4

LLDP-MED: Location Identification TLV.........................................................................................................69.7

Transmission and Reception ....................................................................................................................................69.8

LLDP-MED Operation ...........................................................................................................................................69.9

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x xvii

Storing LLDP Information........................................................................................................................................69.10

Configuring LLDP .......................................................................................................................................................69.11

Configure LLDP.....................................................................................................................................................69.12

Configure LLDP-MED..........................................................................................................................................69.14

Configure Authentication for Voice VLAN..................................................................................................69.18

Chapter 70: LLDP Commands

Introduction....................................................................................................................................................................70.2

Command List................................................................................................................................................................70.2

Chapter 71: SMTP Commands

Command List................................................................................................................................................................ 71.2

Chapter 72: RMON Introduction and Configuration

Introduction....................................................................................................................................................................72.2

Overview..........................................................................................................................................................................72.2

RMON Configuration Example.................................................................................................................................72.3

Chapter 73: RMON Commands

Command List................................................................................................................................................................ 73.2

Chapter 74: Triggers Introduction

Introduction....................................................................................................................................................................74.2

Trigger Facility ...............................................................................................................................................................74.2

Configuring a Trigger..................................................................................................................................................74.2

Troubleshooting Triggers..........................................................................................................................................74.5

Chapter 75: Triggers Configuration

Introduction....................................................................................................................................................................75.2

Restrict Internet Access ..............................................................................................................................................75.2

Capture Unusual CPU and RAM Activity ..............................................................................................................75.4

See Daily Statistics........................................................................................................................................................75.6

Turn Off Power to Port LEDs .....................................................................................................................................75.7

Reduce Power Supplied to Ports.............................................................................................................................75.9

Capture Show Output and Save to a USB Storage Device ..........................................................................75.11

Load a Release File From a USB Storage Device..............................................................................................75.12

Chapter 76: Trigger Commands

Command List................................................................................................................................................................ 76.2

Chapter 77: Cable Fault Locator Introduction

Introduction to the Cable Fault Locator...............................................................................................................77.2

Capabilities...............................................................................................................................................................77.2

TDR Operating Principles....................................................................................................................................77.2

Using the Cable Fault Locator..................................................................................................................................77.3

Chapter 78: Cable Fault Locator Commands

Command List................................................................................................................................................................ 78.2

Software Reference for GS900MX/MPX Series Switches

xviii AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Chapter 79: Ping Polling Introduction and Configuration

Introduction....................................................................................................................................................................79.2

How Ping Polling Works............................................................................................................................................. 79.2

Configuring Ping Polling............................................................................................................................................ 79.4

Creating a Polling Instance ................................................................................................................................79.4

Customizing a Polling Instance ........................................................................................................................79.5

Troubleshooting Ping Polling ...........................................................................................................................79.6

Interaction with Other Protocols ............................................................................................................................79.7

Chapter 80: Ping-Polling Commands

Command List................................................................................................................................................................ 80.2

Part 8: Virtual Chassis Stacking

Chapter 81: VCStack Introduction

VCStack Introduction ..................................................................................................................................................81.2

Features of Virtual Chassis Stacking ...............................................................................................................81.2

VCStack Capable Switches ................................................................................................................................. 81.3

The Physical Stack .................................................................................................................................................81.3

Two-Switch Stack Configuration......................................................................................................................81.4

Multiple Switch Stack Configuration.............................................................................................................. 81.4

Resilient Stacked Topology................................................................................................................................81.5

Stack Formation ............................................................................................................................................................ 81.9

The Role of the Stack Master ............................................................................................................................. 81.9

Stack Management VLAN .................................................................................................................................81.10

Stack Member Failure and Recovery ...................................................................................................................81.13

Fixed or Virtual MAC Addressing ...................................................................................................................81.13

Stack Resiliency Link...........................................................................................................................................81.14

Stack Failure Recovery .......................................................................................................................................81.15

Stack Separation and Recovery ......................................................................................................................81.16

Stack Maintenance..............................................................................................................................................81.16

Disabled Master Monitoring (DMM) ....................................................................................................................81.18

Provisioning (Stack Members) ...............................................................................................................................81.20

Provisioned Board Classes................................................................................................................................81.20

Applying Hardware Provisioning...................................................................................................................81.20

Removing Hardware Provisioning.................................................................................................................81.22

Displaying Provisioned Configurations.......................................................................................................81.23

Provisioning and Configuration Management.........................................................................................81.24

Software Version Auto Synchronization ............................................................................................................81.25

Introduction...........................................................................................................................................................81.25

How Auto Synchronization Works ................................................................................................................81.25

Chapter 82: Stacking Commands

Introduction....................................................................................................................................................................82.2

Command List................................................................................................................................................................82.3

Command List

Glossary

Part 1: Setting up the Switch

■Chapter 1 Getting Started

■Chapter 2 Command Syntax Conventions in this Software

Reference

■Chapter 3 Start-Up Sequence

■Chapter 4 CLI Navigation Commands

■Chapter 5 User Access Commands

■Chapter 6 Creating and Managing Files

■Chapter 7 File Management Commands

■Chapter 8 System Configuration and Monitoring

Commands

■Chapter 9 Debugging and Logging

■Chapter 10 Logging Commands

■Chapter 11 Scripting Commands

■Chapter 12 Interface Commands

■Chapter 13 Interface Testing Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 1.1

Chapter 1: Getting Started

Introduction ...........................................................................................................................................1.2

How to Login .........................................................................................................................................1.2

How to Get Command Help.............................................................................................................1.3

Viewing a List of Valid Parameters..........................................................................................1.3

Completing Keywords.................................................................................................................1.5

Viewing Command Error Messages .......................................................................................1.6

How to Work with Command Modes ...........................................................................................1.7

Entering Privileged Exec Commands when in a Configuration Mode ......................1.9

How to See the Current Configuration ..................................................................................... 1.10

Default Settings ................................................................................................................................. 1.11

The Default Configuration ............................................................................................................. 1.12

How to Change the Password ......................................................................................................1.13

How to Set Strong Passwords....................................................................................................... 1.14

How to Set an IP Address on VLAN 1 ......................................................................................... 1.16

How to Save and Boot from the Current Configuration ..................................................... 1.17

How to Save to the Default Configuration File ............................................................... 1.17

How to Create and Use a New Configuration File.......................................................... 1.17

How to Return to the Factory Defaults...................................................................................... 1.19

How to See System Information .................................................................................................. 1.20

Viewing Overall System Information .................................................................................. 1.20

Viewing Voltage, Fan Status, and Temperature ............................................................. 1.20

Viewing the Serial Number..................................................................................................... 1.21

How to Set System Parameters....................................................................................................1.22

How to Change the Telnet Session Timeout ................................................................... 1.22

How to Name the Switch ........................................................................................................ 1.23

How to Display a Text Banner at Login .............................................................................. 1.24

How to Set the Time and Date ..................................................................................................... 1.25

How to Show Current Settings ............................................................................................. 1.25

How to Set the Time and Date .............................................................................................. 1.25

How to Set the Timezone........................................................................................................ 1.26

How to Configure Summer-Time......................................................................................... 1.26

How to Add and Remove Users ................................................................................................... 1.27

Pre-Encrypted Passwords ....................................................................................................... 1.28

How to Undo Settings ..................................................................................................................... 1.30

How to Use the no Parameter ............................................................................................... 1.30

How to Use the default Parameter....................................................................................... 1.30

How to Upgrade the Firmware .................................................................................................... 1.31

Save Power with the Eco-Friendly Feature.............................................................................. 1.32

The Eco-Friendly LED Feature ............................................................................................... 1.32

The Eco-Friendly LPI Feature ................................................................................................. 1.32

Trouble-shoot Fiber and Pluggable Issues .............................................................................. 1.33

Using the Find Me feature ............................................................................................................. 1.34

Controlling “show” Command Output...................................................................................... 1.35

Getting Started

Software Reference for GS900MX/MPX Series Switches

1.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Introduction

This chapter introduces a number of commonly-used management features of the

AlliedWare PlusTM Operating System (OS).

How to Login

Step 1: Set the console baud rate if necessary

The default baud rate is 9600.

By default the AlliedWare PlusTM OS supports VT100 compatible terminals on the console

port. This means that the terminal size is 80 columns by 24 rows.

Step 2: Login with manager/friend

The defaults are:

The switch logs you into User Exec mode. From User Exec mode, you can perform high-

level diagnostics (some show commands, ping, traceroute, for example), start sessions

(Telnet, SSH), and change mode.

username: manager

password: friend

Getting Started

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 1.3

How to Get Command Help

The following kinds of command help are available:

■lists of valid parameters with brief descriptions (the ? key)

■completion of keywords (the Tab key)

■error messages for incomplete or incorrect syntax

Command

Abbreviations

The AlliedWare PlusTM CLI contains a number of abbreviations for its commands. For

example, the show interface command can be entered in the abbreviated form shown

below:

Viewing a List of Valid Parameters

To get syntax help, type ? (i.e. “space question mark”) after:

■the prompt. This will list all commands available in the mode you are in.

■one or more parameters. This will list parameters that can come next in the partial

command.

■one or more letters of a parameter. This will list matching parameters.

Example To see which commands are available in Privileged Exec mode, enter “?” at the Privileged

Exec mode command prompt:

This results in output as shown in Figure 1-1below:

Example To see which show commands that start with “i” are available in Privileged Exec mode,

enter “?” after show i:

awplus# sh in vlan100

Note The AlliedWare PlusTM OS only displays one screenful of text at a time, with the

prompt “--More--” at the end of each screenful. Press the space bar to display

the next screenful or the Q key to return to the command prompt.

awplus# ?

Figure 1-1: Example output from the ? command

Exec commands:

activate Activate a script

cd Change the current working directory

clear Reset functions

clock Manage clock

configure Enter configuration mode

copy Copy from one file to another

awplus# show i?

Getting Started

Software Reference for GS900MX/MPX Series Switches

1.4 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

This results in the following output:

Examples To use the ? help to work out the syntax for the clock timezone command, enter the

following sequence of commands:

The above example demonstrates that the ? help only indicates what you can type next.

For commands that have a series of parameters, like clock timezone, the ? help does not

make the number of parameters obvious.

Figure 1-2: Example output from the show i? command

interface Select an interface to configure

ip Internet Protocol (IP)

ipv6 Internet Protocol version 6 (IPv6)

awplus(config)# clock ?

summer-time Manage summer-time

timezone Set clock timezone

awplus(config)# clock timezone ?

TIMEZONE Timezone name, up to 5 characters

awplus(config)# clock timezone NZST ?

minus negative offset

plus positive offset

awplus(config)# clock timezone NZST plus ?

<0-12> Time zone offset to UTC

awplus(config)# clock timezone NZST plus 12

Getting Started

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 1.5

Completing Keywords

To complete keywords, type the Tab key after part of the command.

If only one keyword matches the partial command, the AlliedWare PlusTM OS fills in that

keyword. If multiple keywords match, it lists them.

Examples In this example we use Tab completion in successive steps to build the complete

command show ip dhcp snooping. We have included “<Tab>” to show where to type the

Tab key — this is not displayed on screen.

Figure 1-3: Example output after entering the command show ip <Tab>

dhcp dhcp-relay domain-list

domain-name extcommunity-list filter

forwarding igmp interface

irdp mroute mvif

name-server nat

pim protocols rip

route rpf

Figure 1-4: Example output after entering the command, show ip d<Tab>

awplus#show ip d<Tab>

dhcp dhcp-relay domain-list domain-name

Figure 1-5: Example output from the show ip dhcp <Tab> command

awplus#show ip dhcp <Tab>

binding pool server snooping

Figure 1-6: Example output from the show ip dhcp s<Tab> command

awplus#show ip dhcp s<Tab>

server snooping

Getting Started

Software Reference for GS900MX/MPX Series Switches

1.6 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Viewing Command Error Messages

The switch displays the following generic error messages about command input:

% Incomplete command—this message indicates that the command requires more

parameters. Use the ? help to find out what other parameters are available.

% Invalid input detected at '^' marker—this indicates that the switch could not process

the command you entered. The switch also prints the command and marks the first invalid

character by putting a '^' under it. Note that you may get this error if you enter a

command in the wrong mode, as the following output shows.

% Unrecognized command—when you try to use ? help and get this message, it

indicates that the switch can not provide help on the command because it does not

recognize it. This means the command does not exist, or that you have entered it in the

wrong mode, as the following output shows.

awplus# interface

% Incomplete command.

awplus# interface port1.0.1

interface port1.0.1

% Invalid input detected at '^' marker.

awplus# interface ?

% Unrecognized command

Note The AlliedWare PlusTM OS does not tell you when commands are successful. If it

does not display an error message, you can assume the command was

successful.

Getting Started

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 1.7

How to Work with Command Modes

The following figure shows the command mode hierarchy and the commands you use to

move to lower-level modes.

Multiple users can telnet and issue commands using the User Exec mode and the

Privileged Exec mode. However, only one user is allowed to use the Configure mode at a

time. This prevents multiple users from issuing configuration commands simultaneously.

Figure 1-7: AlliedWare PlusTM CLI modes

User Exec mode User Exec mode is the mode you log into on the switch.

It lets you perform high-level diagnostics (show commands, ping, traceroute, for

example), start sessions (Telnet, SSH), and change mode.

The default User Exec mode prompt is awplus>

Privileged Exec

mode

To change from User Exec to Privileged Exec mode, enter the command:

Privileged Exec mode is the main mode for monitoring—for example, running show

commands and debugging. From Privileged Exec mode, you can do all the commands

from User Exec mode plus many system commands.

The default Privileged Exec mode prompt is awplus#

AlliedWare Plus CLI modes

User

Exec mode

Privileged

Exec mode

Interface

mode

enable Command used to

enter the next

command mode

Command mode

configure terminal

interface

[interface name]

Other

sub-modes

Global

Configuration

mode

awplus# enable

Getting Started

Software Reference for GS900MX/MPX Series Switches

1.8 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Global

Configuration

mode

To change from Privileged Exec to Global Configuration mode, enter the command:

From Global Configuration mode, you can configure most aspects of the switch.

The default Global Configuration mode prompt is awplus(config)#

Lower-level

configuration

modes

A number of features are configured by entering a lower-level mode from Global

Configuration mode.

Some protocols have commands in both Global Configuration mode and lower-level

configuration modes. For example, to configure MSTP, you use:

■Global Configuration mode to select MSTP as the spanning tree mode

■MST mode to create instances and specify other MSTP settings

■Interface Configuration mode to associate the instances with the appropriate ports.

Returning to

higher-level

modes

The following figure shows the commands to use to move from a lower-level mode to a

higher-level mode.

Figure 1-8: Returning to higher-level modes

awplus# configure terminal

AlliedWare Plus CLI modes - returning to higher-level modes

User

Exec mode

Privileged

Exec mode

mode

disable Command used to

return to this

command mode

Command mode

exit

Sub-modes

exit

end

or Ctrl+Z

or Ctrl+C

Global

Configuration

Getting Started

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 1.9

Examples To go from Interface Configuration to Global Configuration mode:

To go from Interface Configuration to Privileged Exec mode:

To go from Privileged Exec to User Exec:

Entering Privileged Exec Commands when in a

Configuration Mode

As you configure the switch you will be constantly entering various show commands to

confirm your configuration. This requires constantly changing between configuration

modes and Privileged Exec mode.

However, you can run Privileged Exec commands without changing mode, by using the

command:

You cannot use the ? help to find out command syntax when using the do command.

Example To display information about the IP interfaces when in Global Configuration mode, enter

the command:

This results in the following output:

Figure 1-9: Example output after entering the command “do show ip int brief”

awplus(config-if)# exit

awplus(config)#

awplus(config-if)# end

awplus#

awplus# exit

awplus>

do <command you want to run>

awplus(config)# do show ip int brief

Interface IP-Address Status Protocol

vlan1 unassigned admin up running

vlan2 unassigned admin up running

Getting Started

Software Reference for GS900MX/MPX Series Switches

1.10 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

How to See the Current Configuration

The current configuration is called the running-config. To see it, enter the following

command in either Privileged Exec mode or any configuration mode:

To see only part of the current configuration, enter the command:

This displays only the lines that contain word.

To start the display at a particular place, enter the command:

This searches the running-config for the first instance of word and begins the display from

that line.

awplus# show running-config

awplus# show running-config|include <word>

awplus# show running-config|begin <word>

Note The show running-config command works in all modes except User Exec

mode.

Getting Started

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 1.11

Default Settings

When the switch first starts up with the AlliedWare PlusTM OS, it applies default settings

and copies these defaults dynamically into its running-config.

These default settings mean that the AlliedWare PlusTM OS:

■encrypts passwords, such as user passwords

■records log message priority in log messages

■turns on the telnet server so that you can telnet to the switch

■enables the switch to look up domain names (but for domain name lookups to work,

you have to configure a DNS server)

■turns off L3 multicast packet switching in the switch’s hardware. This prevents L3

multicast from flooding the switch’s CPU in its default state as an L2 switch

■sets the maximum number of ECMP routes to 4

■turns on RSTP on all ports. Note that the ports are not set to be edge ports

■sets all the switch ports to access mode. This means they are untagged ports, suitable

for connecting to hosts

■creates VLAN 1and adds all the switch ports to it

■allows logins on the serial console port

■allows logins on VTY sessions (for telnet, for example)

■has switching enabled, so Layer 2 traffic is forwarded appropriately without further

configuration

■allocates all the routing table memory space to IPv4 and IPv6 routes

■has ports set to autonegotiate their speed and duplex mode

■has copper ports set to auto MDI/MDI-X mode

Getting Started

Software Reference for GS900MX/MPX Series Switches

1.12 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

The Default Configuration

Most of the above default settings are in the form of commands, which the switch copies

to its running-config when it first boots up.

For more information about start-up files, see “How to Save and Boot from the Current

Configuration” on page 1.17.

Getting Started

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 1.13

How to Change the Password

To change the password for the manager account, enter Global Configuration mode and

enter the following command:

The password can be up to 23 characters in length and include characters from up to four

categories. The password categories are:

■uppercase letters: A to Z

■lowercase letters: a to z

■digits: 0 to 9

■special symbols: all printable ASCII characters not included in the previous three

categories. The question mark ? cannot be used as it is reserved for help functionality.

awplus(config)# username manager password <new-password>

Getting Started

Software Reference for GS900MX/MPX Series Switches

1.14 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

How to Set Strong Passwords

The password security rules are disabled by default. To set password security rules for

users with administrative rights, or privilege level 15, enter Global Configuration mode.

You can then either specify whether the user is forced to change an expired password at

the next login, or specify whether the user is not allowed to login with an expired

password. You will need to specify a password lifetime greater than 0 before selecting

either of these features. Note that the security-password forced-change and the security-

password reject-expired-pwd commands cannot be enabled concurrently.

Password lifetime Enter the following command to specify the password lifetime in days:

Note that the value 0 will disable lifetime functionality and passwords will never expire. If

lifetime functionality is disabled, the security-password forced-change command and

the security-password warning command are also disabled.

Password forced

change

To specify that a user is forced to change an expired password at the next login, enter the

following command:

If the security-password forced-change command is enabled, users with expired

passwords are forced to change to a password that must comply with the current

password security rules at the next login.

Reject expired

password

To specify that a user is not allowed to login with an expired password, enter the following

command:

If the security-password reject-expired-pwd command is enabled, users with expired

passwords are rejected at login. Users then have to contact the Network Administrator to

change their password.

Use other password security rules to further configure password security settings.

Password warning To specify the number of days before the password expires that the user will receive a

warning message specifying the remaining lifetime of the password, enter the command:

The value 0 will disable warning functionality and the warning period must be less than,

or equal to, the password lifetime.

awplus(config)# security-password lifetime <0-1000>

awplus(config)# security-password forced-change

awplus(config)# security-password reject-expired-pwd

Caution Once all users’ passwords are expired you are unable to login to the device

again if the security-password reject-expired-pwd command has been

executed. You will have to reboot the device with a default configuration

file, or load an earlier software version that does not have the security

password feature.

We recommend you never have the command line “security-password

reject-expired-pwd” in a default config file.

awplus(config)# security-password warning <0-1000>

Getting Started

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 1.15

Password history To specify the number of previous passwords that are unable to be reused enter the

command:

The value 0 will disable history functionality. If history functionality is disabled, all users’

password history is reset and all password history is lost. A new password is invalid if it

matches a password retained in the password history.

Password minimum

length

To specify the minimum allowable password length, enter the command:

Password minimum

categories

To specify the minimum number of categories that the password must contain in order to

be considered valid, enter the command:

The password categories are:

■uppercase letters: A to Z

■lowercase letters: a to z

■digits: 0 to 9

■special symbols: all printable ASCII characters not included in the previous three

categories. The question mark ? cannot be used as it is reserved for help functionality

To ensure password security, the minimum number of categories should align with the

lifetime selected, i.e. the fewer categories specified the shorter the lifetime specified.

How to add a user is described in “How to Add and Remove Users” on page 1.27.

Display security

password settings

To list the configuration settings for the various security password rules, enter the

command:

To list users remaining lifetime or last password change, enter the command:

awplus(config)# security-password history <0-15>

awplus(config)# security-password minimum-length <1-23>

awplus(config)# security-password minimum-categories <1-4>

awplus(config)# show security-password configuration

awplus(config)# show security-password user

Getting Started

Software Reference for GS900MX/MPX Series Switches

1.16 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

How to Set an IP Address on VLAN 1

This section describes how to set an IP address on the default VLAN (vlan1).

Step 1: If desired, check the current configuration

After logging in, enter Privileged Exec mode by using the command:

Then check the current configuration by using one of the following commands:

The output looks like this:

This output looks like this:

Step 2: Enter Interface Configuration mode for the vlan1 interface

Enter Global Configuration mode and enter the command:

Step 3: Enter the IP address and mask

Enter the command:

For example, to set the address to 172.28.8.210/16, enter the command:

awplus# enable

awplus# show ip interface vlan1 brief

Interface IP-Address Status Protocol

vlan1 172.28.8.200 admin up running

awplus# show running-config interface vlan1

interface vlan1

ip address 172.28.8.200/16

awplus(config)# interface vlan1

awplus(config-if)# ip address <address/mask>

awplus(config-if)# ip address 172.28.8.210/16

Getting Started

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 1.17

How to Save and Boot from the Current

Configuration

This section tells you how to save your configuration and run the saved configuration

when the switch starts up.

You can either:

■save the configuration to the switch’s default configuration file (called “default.cfg”).

By default, the switch uses that file at start-up.

■create a new configuration file and set the switch to use the new configuration file at

start-up.

How to Save to the Default Configuration File

Enter Privileged Exec mode and enter the command:

The parameter startup-config is a short-cut for the current boot configuration file, which

will be the default configuration file unless you have changed it, as described in the next

section.

How to Create and Use a New Configuration File

Step 1: Copy the current configuration to a new file

Enter Privileged Exec mode and enter the command:

Example To save the current configuration in a file called example.cfg, enter the command

Step 2: Set the switch to use the new file at startup

To run the new file’s configuration when the switch starts up, enter Global Configuration

mode and enter the command:

Note that you can set the switch to use a configuration file on a USB storage device if you

have saved the configuration file to a USB storage device. You can only specify that the

configuration file is on a USB storage device if there is a backup configuration file already

specified in Flash.

To set a backup configuration file to load if the main configuration file cannot be loaded,

enter the command:

awplus# copy running-config startup-config

awplus# copy running-config <destination-url>

awplus# copy running-config example.cfg

awplus(config)# boot config-file <filepath-filename>

awplus(config)# boot config-file backup <filepath-filename>

Getting Started

Software Reference for GS900MX/MPX Series Switches

1.18 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

For an explanation of the configuration fallback order, see “The Configuration File

Fallback Order” on page 6.10.

Example To run the commands in example.cfg on startup, enter the command:

To set backup.cfg as the backup to the main configuration file, enter the command:

Step 3: Display the new settings

To see the files that the switch uses at startup, enter Privileged Exec mode and enter the

command:

The output looks like this:

Step 4: Continue updating the file when you change the configuration

When you next want to save the current configuration, enter Privileged Exec mode and

enter the command:

The parameter startup-config is a short-cut for the current boot configuration file.

awplus(config)# boot config-file flash:/example.cfg

awplus(config)# boot config-file backup flash:/backup.cfg

awplus# show boot

Boot configuration

----------------------------------------------------------------

Current software : GS900-5.4.4E-1.1.rel

Current boot image : flash:/GS900-5.4.4E-1.1.rel

Backup boot image : flash:/GS900-5.4.4E-1.1.rel

Default boot config: flash:/default.cfg

Current boot config: usb:/example.cfg (file exists)

Backup boot config: flash:/backup.cfg (file exists)

awplus# copy running-config startup-config

Getting Started

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 1.19

How to Return to the Factory Defaults

The switch dynamically adds the default settings to the running-config at start-up if the

default file is not present. This section describes how to use this feature to return to the

factory defaults.

Completely

restore defaults

To completely remove your configuration and return to the factory default configuration,

delete or rename the default file and make sure no other file is set as the start-up

configuration file.

To find the location of the default boot configuration file, enter Privileged Exec mode and

enter the command:

To delete the default file when it is the current boot configuration file, enter Privileged

Exec mode and enter either of the commands:

or:

Note that erasing startup-config deletes the current boot configuration file—it does not

simply stop the file from being the boot file.

To make sure that no other file is loaded at start-up, enter Global Configuration mode and

enter the command:

Partially restore

defaults

To partially restore the default settings, make a configuration file that contains the settings

you want to keep and set this as the start-up configuration file. On start-up, the switch will

add the missing settings to the running-config.

Note After reboot the show running-config output will show the default factory

settings for your switch once you have removed the default.cfg file. To recreate

the default.cfg file enter copy running-config startup-config. When you enter

copy running-config startup-config commands the default.cfg file is updated

with the startup-config.

awplus# show boot

awplus# delete force <filename>

awplus# erase startup-config

awplus(config)# no boot config-file

Getting Started

Software Reference for GS900MX/MPX Series Switches

1.20 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

How to See System Information

This section describes how to view the following system information:

■overview information

■details of temperature and voltage

■serial number

Viewing Overall System Information

To display an overview of the switch hardware, software, and system settings, enter User

Exec or Privileged Exec mode and enter the command:

The output looks like this:

Viewing Voltage, Fan Status, and Temperature

The switch monitors the environmental status of the switch and its power supplies and

fan. To display this information, enter User Exec or Privileged Exec mode and enter the

command:

awplus# show system

GS900#show system

Stack System Status Thu May 29 02:02:30 2014

Stack member 1

Board ID Bay Board Name Rev Serial number

--------------------------------------------------------------------------------

Base 392 GS948MX X1-0 A04939H131100021

--------------------------------------------------------------------------------

RAM: Total: 494848 kB Free: 399396 kB

Flash: 62.0MB Used: 45.4MB Available: 16.6MB

--------------------------------------------------------------------------------

Environment Status : Normal

Uptime : 0 days 00:02:30

Bootloader version : 3.0.3-devel

Current software : GS900-5.4.4E-1.1.rel

Software version : Version 5.4.4E-1

Build date : Thu May 29 01:32:39 NZST 2014

Current boot config: flash:/default.cfg (file exists)

System Name

GS900

System Contact

System Location

GS900#

awplus# show system environment

Getting Started

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 1.21

The output looks like this:

Viewing the Serial Number

The switch’s serial number is displayed in the output of the show system command on

page 8.46, but for convenience, you can also display it by itself. To do this, enter User Exec

or Privileged Exec mode and enter the command:

The output looks like this:

GS900#show system environment

Environment Monitoring Status

Overall Status: Normal

Resource ID: 1 Name: GS948MX

ID Sensor (Units) Reading Low Limit High Limit Status

1 Voltage: 1.8V (Volts) 1.810 1.612 1.975 Ok

2 Voltage: 1.0V (Volts) 1.011 0.891 1.090 Ok

3 Voltage: 3.3V (Volts) 3.351 3.028 3.545 Ok

4 Voltage: 5.0V (Volts) 5.079 4.477 5.498 Ok

5 Voltage: 1.2V (Volts) 1.215 1.046 1.292 Ok

6 Temp: CPU (Degrees C) 56 -11 75 Ok

7 Temp: System (Degrees C) 57 -11 80 Ok

GS900#

awplus# show system serialnumber

P1FY7502C

Getting Started

Software Reference for GS900MX/MPX Series Switches

1.22 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

How to Set System Parameters

You can set system parameters to personalize the switch and make it easy to identify it

when troubleshooting. This section describes how to configure the following system

parameters:

■telnet session timeout

■switch name

■login banner

How to Change the Telnet Session Timeout

By default, telnet sessions time out after 10 minutes of idle time. If desired, you can

change this.

To change the timeout for all telnet sessions, enter Global Configuration mode and enter

the commands:

The new timeout value only applies to new sessions, not current sessions.

Examples To set the timeout to 30 minutes, enter the command:

To set the timeout to 30 seconds, enter the command:

To set the timeout to infinity, so that sessions never time out, enter either of the

commands:

awplus(config)# line vty 0 32

awplus(config-line)# exec-timeout <new-timeout>

awplus(config-line)# exec-timeout 30

awplus(config-line)# exec-timeout 0 30

awplus(config-line)# no exec-timeout

awplus(config-line)# exec-timeout 0 0

Getting Started

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 1.23

How to Name the Switch

To give the switch a name, enter Global Configuration mode and enter the command:

For example, to name the switch “mycompany”:

The prompt displays the new name:

The name can contain hyphens and underscore characters, for example:

However, the name must be a single word, as the following example shows.

It also cannot be surrounded by quote marks, as the following example shows.

Removing the

name

To remove the hostname, enter the command:

The prompt changes back to the default prompt:

awplus(config)# hostname <name>

awplus(config)# hostname mycompany

mycompany(config)#

mycompany(config)#hostname mycompany_more_words

mycompany_more_words(config)#hostname mycompany-hyphenated

mycompany-hyphenated(config)

mycompany(config)#hostname mycompany more words

% Invalid input detected at '^' marker.

awplus(config)#hostname "mycompany more words"

% hostname contains invalid characters

mycompany(config)# no hostname

awplus(config)#

Getting Started

Software Reference for GS900MX/MPX Series Switches

1.24 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

How to Display a Text Banner at Login

By default, the switch displays the AlliedWare PlusTM OS version and build date before

To enter a new MOTD banner, enter Global Configuration mode and enter the command:

The text can contain spaces and other printable characters. You do not have to surround

words with quote marks.

Example To display “this is a new banner” when someone logs in, enter the command:

This results in the following output at login:

Removing the

banner

To return to the default banner (AlliedWare PlusTM OS version and build date), enter the

command:

To remove the banner instead of replacing it, enter the command:

awplus(config)# banner motd <banner-text>

awplus(config)# banner motd this is a new banner

awplus login: manager

Password:

this is a new banner

awplus>

awplus(config)# banner motd default

awplus(config)# no banner motd

Getting Started

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 1.25

How to Set the Time and Date

There are three aspects to setting the time and date:

■setting the current time and date (“How to Set the Time and Date” on page 1.25)

■setting the timezone (“How to Set the Timezone” on page 1.26)

■configuring the switch to automatically change the time when summer-time begins

and ends (“How to Configure Summer-Time” on page 1.26)

Instead of manually setting the time, you can use NTP to automatically get the time from

another device.

How to Show Current Settings

To display the current time, timezone and date, enter Privileged Exec mode and enter the

command:

The output looks like this:

How to Set the Time and Date

To set the time and date, enter Privileged Exec mode and enter the clock set command:

clock set <hh:mm:ss> <day> <month> <year>

:where:

■hh is two digits giving the hours in 24-hour format (e.g. 14)

■mm is two digits giving the minutes

■ss is two digits giving the seconds

■day is two digits giving the day of the month

■month is the first three letters of the month name (e.g. sep)

■year is four digits giving the year

Example To set the time to 14:00:00 on 25 January 2012, use the command:

awplus# show clock

UTC Time: Wed, 16 May 2013 16:08:14 +0000

Timezone: UTC

Timezone Offset: +00:00

Summer time zone: None

awplus# clock set 14:00:00 25 jan 2012

Getting Started

Software Reference for GS900MX/MPX Series Switches

1.26 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

How to Set the Timezone

To set the timezone, enter Global Configuration mode and enter the clock timezone

command:

clock timezone <timezone-name> {plus|minus} <0-12>

The <timezone-name> can be any string up to 6 characters long.

To return the timezone to UTC+0, enter the command:

Example To set the timezone to Eastern Standard Time, use the command:

How to Configure Summer-Time

There are two approaches for setting summer-time:

■recurring, when you specify the week when summer-time starts and ends and each

year the switch changes the time at those weeks. For example, Eastern Daylight Time

(EDT) starts at 2 am on the second Sunday in March and ends at 2 am on the first

Sunday in November.

■date-based, when you specify the start and end dates for summer-time for a particular

year. For example, Eastern Daylight Time (EDT) starts at 2 am on Sunday, 8 March 2008

and ends at 2 am on Sunday, 2 November 2008.

Recurring To set summer-time with recurring dates, enter Global Configuration mode and enter the

clock summer-time recurring command:

clock summer-time <zone-name> recurring <start-week> <start-

day> <start-month> <start-time> <end-week> <end-day>

<end-month> <end-time> <1-180>

The <zone-name> can be any string up to 6 characters long.

The <start-time> and <end-time> are in the form hh:mm, in 24-hour time.

Note that if you specify 5 for the week, this changes the time on the last day of the month,

not the 5th week.

Example To configure EDT, enter the command:

Date-based To set summer-time for a single year, enter Global Configuration mode and enter the clock

summer-time date command:

clock summer-time <zone-name> date <start-day> <start-month>

<start-year> <start-time> <end-day> <end-month> <end-year>

<end-time> <1-180>

The <zone-name> can be any string up to 6 characters long.

The <start-time> and <end-time> are in the form hh:mm, in 24-hour time.

awplus(config)# no clock timezone

awplus(config)# clock timezone EST minus 5

awplus(config)# clock summer-time EDT recurring 2 Sun Mar

02:00 1 Sun Nov 02:00 60

Getting Started

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 1.27

Example For example, to configure EDT for 2008 enter the command:

How to Add and Remove Users

Adding users To add a new user with administrative rights, enter Global Configuration mode and enter

the command:

Both <name> and <password> can contain any printable character and are case sensitive.

When you add a user with administrative rights, <password> will have to conform to the

following rules:

■security-password minimum-categories command on page 5.20

■security-password minimum-length command on page 5.21

■security-password history command on page 5.17. If this command is enabled,

<password> is invalid if it matches a password retained in the password history.

The AlliedWare PlusTM OS gives you a choice of 1 or 15 for the privilege level. Level 1 users

are limited to User Exec mode so you need to set most users to level 15.

For example, to add user Bob with password 123$%^, enter the command:

Removing users To remove a user, enter Global Configuration mode and enter the command:

no username <name>

For example, to remove user Bob, enter the command:

Note that you can delete all users, including the user called “manager” and the user you

are logged in as. If all privilege 15 user accounts are deleted, a warning message is

generated:

If all privilege level 15 user accounts are deleted, and there are no other users configured

for the device, you may have to reboot with the default configuration file.

awplus(config)# clock summer-time EDT date 8 Mar 2008 02:00

2 Nov 2008 02:00 60

awplus(config)# username <name> privilege 15 password

awplus(config)# username Bob privilege 15 password 123$%^

awplus(config)# no username Bob

% Warning: No privileged users exist.

Getting Started

Software Reference for GS900MX/MPX Series Switches

1.28 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

If there is a user account on the device with a lower privilege level and a password has

already been set with the enable password command on page 5.4, you can login and still

enter privileged mode. When executing the enable command, enter the password

created with the enable password command. For example, if the password is

mypassword:

Displaying users To list the currently logged-in users, enter User Exec or Privileged Exec mode and enter the

command:

The output looks like this:

To list all configured users, enter User Exec or Privileged Exec mode and enter the

command:

The output looks like this:

Pre-Encrypted Passwords

The running-config output above includes the number 8 after the password parameter.

This indicates that the password is displayed in its encrypted form.

You can enter the number 8 and a pre-encrypted password on the command line. You

may want to pre-encrypt passwords if you need to load them onto switches via an

insecure method (such as HTTP, or by emailing them to remote users).

Testing this

feature

If you want to test the effect of this, create a new user for the test instead of using the

manager user. The test stops you from logging in as the test user, so you need to have the

manager user available to log in as.

awplus> enable mypassword

awplus#

awplus# show users

Line User Host(s) Idle Location Priv Idletime Timeout

con 0 manager idle 00:00:00 ttyS0 15 10 N/A

vty 0 bob idle 00:00:03 172.16.11.3 1 0 5

awplus# show running-config|include username

username manager privilege 15 password 8 $1$bJoVec4D$JwOJGPr7YqoExA0GVasdE0

username Bob privilege 15 password 8 $1$gXJLY8dw$iqkMXLgQxbzSOutNUa5E2.

Caution Only enter the number 8 if you are entering a pre-encrypted password—

otherwise, you will be unable to log in using the password and will be unable

to access the switch through that username. The next section describes why.

Getting Started

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 1.29

The following output shows how specifying the number 8 puts the password into the

running-config exactly as you typed it:

After entering the command above, logging in as “Bob” with a password of “friend” does

not work. This is because the switch takes the password you enter (“friend”), hashes it, and

compares the hash with the string in the running-config (“friend”). The hashed value and

“friend” are not the same, so the switch rejects the login.

awplus(config)#username Bob privilege 15 password 8 friend

awplus(config)#show running-config |include username Bob

username Bob privilege 15 password 8 friend

Getting Started

Software Reference for GS900MX/MPX Series Switches

1.30 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

How to Undo Settings

There are two possibilities for undoing settings: the no parameter and the default

parameter.

How to Use the no Parameter

To undo most settings, simply re-enter the first parameters of the configuration command

with the parameter no before them.

Example You can set the timezone to Eastern Standard Time by entering the command:

To remove the timezone setting, enter the command:

How to Use the default Parameter

Some commands have a default parameter that returns the feature to its default setting.

Example You can change the login banner to “this is a new banner” by entering the command:

To return to the default banner, enter the command:

Note that this command also has a no parameter that lets you remove the banner

altogether.

awplus(config)# clock timezone EST minus 5

awplus(config)# no clock timezone

awplus(config)# banner motd this is a new banner

awplus(config)# banner motd default

Getting Started

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 1.31

How to Upgrade the Firmware

New releases of the AlliedWare PlusTM OS become available regularly. Contact your

customer support representative for more information.

Step 1: Put the new release onto your TFTP server or your USB drive

Step 2: If necessary, create space in the switch’s Flash memory for the

new release

Note that you cannot delete the current release file.

To see how much space is free, use the command:

Step 3: Copy the new release from your TFTP server or your USB drive

onto the switch

Follow the relevant instructions in “Copying with Trivial File Transfer Protocol (TFTP)”

on page 6.16, or “Copying to and from NVS or a USB storage device” on page 6.15.

Step 4: Set the switch to boot from the new release

Enter Global Configuration mode and enter the command:

You can set a backup release file to load if the main release file cannot be loaded. Enter the

command:

Step 5: Check the boot settings

Enter Privileged Exec mode and enter the command:

Step 6: Reboot

Enter Privileged Exec mode and enter the command:

awplus# show file systems

awplus(config)# boot system <filepath-filename>

awplus(config)# boot system backup <filepath-filename>

awplus# show boot

awplus# reboot

Getting Started

Software Reference for GS900MX/MPX Series Switches

1.32 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Save Power with the Eco-Friendly Feature

The Eco-Friendly LED Feature

You can conserve power by enabling the eco-friendly LED (Light Emitting Diode) feature

either by entering the ecofriendly led command on page 8.12 or by pressing the

eco-friendly button on the front panel. This feature disables power to the port LEDs, but

not the power indicator LED. In the eco-friendly mode, one of the horizontal segments of

the seven segment display will glow permanently. If the device is a stack master, the upper

segment will glow; if the device is a stack member or a stand alone unit, the center

segment will glow.

When the eco-friendly LED feature is enabled, a port’s LED will not change if the port’s

status changes. When the eco-friendly feature is disabled and power is returned to port

LEDs, the LEDs will correctly show the current state of the ports.

In a stack environment, enabling the eco-friendly LED feature on the stack master will

apply the feature to every member of the stack.

The eco-friendly LED feature is disabled by default. To globally enable the feature for all

LED ports on the switch, either push the eco-switch button or enter the commands:

For an example of how to configure a trigger to enable the eco-friendly LED feature, see

“Turn Off Power to Port LEDs” on page 75.7.

The Eco-Friendly LPI Feature

You can also conserve power by enabling the eco-friendly LPI (Low Power Idle) feature

with the ecofriendly lpi command on page 8.13. This feature reduces the power supplied

to the ports by the switch whenever the ports are idle and are connected to IEEE 802.3az

Energy Efficient Ethernet compliant host devices. All ports configured for LPI must support

LPI in hardware and must be configured to autonegotiate by default or by using the

speed and duplex commands as needed.

LPI is a feature of the IEEE 802.3az Energy Efficient Ethernet (EEE) standard. LPI lowers

power consumption of switch ports during periods of low link utilization when connected

to IEEE 802.3az compliant host devices. If no data is sent then the switch port can enter a

sleep state, called Low Power Idle (LPI), to conserve power used by the switch.

The eco-friendly LPI (Low Power Idle) feature is disabled by default. To enable the feature

for a switch port, or for a range of switch ports in the example below, enter the commands:

For an example of how to configure a trigger to enable the eco-friendly LPI feature, see

“Reduce Power Supplied to Ports” on page 75.9.

awplus# configure terminal

awplus(config)# ecofriendly led

awplus# configure terminal

awplus(config)# interface port1.0.2-port1.0.6

awplus(config-if)# ecofriendly lpi

Getting Started

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 1.33

Trouble-shoot Fiber and Pluggable Issues

Digital Diagnostics Monitoring (DDM) for SFP (1 Gigabit Small Form-factor Pluggable) and

SFP+ (10 Gigabit Small Form-factor Pluggable) transceivers allows you to measure optical

parameters for pluggables installed in a switch and trouble shoot fiber issues.

Fiber cable can be vulnerable to damage. Patch panels and patch cables can be connected

with the wrong type of fiber, fiber splices can become faulty and fiber cables can be cut

accidentally. Trouble shooting fiber issues has required special equipment and expertise

to find the source of a problem causing signal attenuation. Digital monitoring features

help find fiber issues.

Different types of transceivers are supported in different models of switch. See your Allied

Telesis dealer for more information about the particular models of pluggables that your

switch supports, and if these transceivers also support digital monitoring.

To display information about transceivers installed on your switch, enter the following

command:

The following parameters are measured and are displayed in show system pluggable

diagnostics command output:

■Temperature (Centigrade) inside the transceiver

■Vcc (Volts) voltage supplied to the transceiver

■Tx Bias (mA) current to the Laser Diode in the transceiver

■Tx Power (mW) the amount of light transmitted from the transceiver

■Rx Power (mW) the amount of light received in the transceiver

You can track Tx Bias to find out how the Laser Diode in the transceiver is aging by

comparing the Tx Bias for one transceiver against Tx Bias for others. You can use this

information to see if any transceivers may need replacement.

You can trouble shoot fiber connectivity issues by checking the Tx Power at one end of the

fiber link against the Rx Power at the other end of the fiber link to measure the

attenuation. Knowing the attenuation enables you to determine if there are anomalies in

the fiber cable.

Note that Tx Power differences between the same type of transceivers installed on a

switch may indicate that a transceiver is not seated or locked. Ensuring transceivers are

seated and locked in place with the retaining clip will keep the fiber link up if there is any

vibration or movement that can dislodge a fiber cable. Rx Power differences may indicate

poor fiber patch cables, poor connectors or poor splices. Tracking Tx Bias for installed

transceivers and measuring attenuation for fiber links allows you to perform periodic

preventative maintenance, instead of reacting to a failure. Tracking Tx Power differences

can be used as an indicator of failure in an which may need replacing.

awplus# show system pluggable diagnostics

Getting Started

Software Reference for GS900MX/MPX Series Switches

1.34 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Using the Find Me feature

The Find Me feature enables you to physically locate a specific device from a group of

similar devices.

Running the findme command on page 8.15 causes the device’s LEDs to alternately flash

green and amber at a rate of 1 Hz. If the switch has no amber LED, then the green LED will

flash on/off at a rate of 1 Hz.

An optional interface parameter specifies one or more interfaces to flash, while an

optional member parameter specifies a particular stack member. Both these parameters

are mutually exclusive. If no interface or member parameter is specified, then all ports on

the device or stack are flashed.

An optional timeout parameter specifies the flash behavior duration. The default time is

one minute (60 seconds). Normal LED behavior is restored automatically after either the

default time, or a specified time, has elapsed or a no findme command is used.

Getting Started

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 1.35

Controlling “show” Command Output

You can control the output of show commands by using the | and > or >> tokens in the

following ways:

■To display only part of the output, follow the command with | and then other

keywords (see Output modifiers below)

■To save the output to a file, follow the command with > filename

■To append the output to an existing file, follow the command with >> filename

Using the ? after typing the show command displays the following information about

these tokens:

Output modifiers Type the | (vertical bar) to use output modifiers.

Begin The begin parameter causes the display to begin at the first line that contains the input

string.

awplus# show users

| Output modifiers

> Output redirection

>> Output redirection (append)

append Append output

begin Begin with the first line that contains

matching output

exclude Exclude lines that contain matching output

include Include lines that contain matching output

redirect Redirect output

awplus# show run | begin vlan1

...skipping

interface vlan1

ip address 192.168.14.1

line con 0

line vty 0 4

end

Getting Started

Software Reference for GS900MX/MPX Series Switches

1.36 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Exclude The exclude parameter excludes all lines of output that contain the input string. In the

following output all lines containing the word “input” are excluded:

Include The include parameter includes only those lines of output that contain the input string. In

the output below, all lines containing the word “input” are included:

Redirect The redirect parameter puts the lines of output into the specified file. If the file already

exists, the new output overwrites the file’s contents; the new output is not appended to

the existing file contents.

| redirect and > are synonyms.

Output redirection The output redirection token > puts the lines of output into the specified file. If the file

already exists, the new output overwrites the file’s contents; the new output is not

appended to the existing file contents.

| redirect and > are synonyms.

Append output The append output token >> adds the lines of output into the specified file. The file must

already exist, for the new output to be added to the end of the file’s contents; the new

output is appended to the existing file contents.

| append and >> are synonyms.

awplus# show interface vlan1 | exclude input

Interface vlan1

Scope: both

Hardware is Ethernet, address is 192.168.14.1

index 3 metric 1 mtu 1500 <UP,BROADCAST,RUNNING,MULTICAST>

Label switching is disabled

No Virtual Circuit configured

Administrative Group(s): None

DSTE Bandwidth Constraint Mode is MAM

output packets 4438, bytes 394940, dropped 0

output errors 0, aborted 0, carrier 0, fifo 0, heartbeat 0,

window 0

collisions 0

awplus# show interface vlan1 | include input

input packets 80434552, bytes 2147483647, dropped 0, multicast packets 0

input errors 0, length 0, overrun 0, CRC 0, frame 0, fifo 1, missed 0

awplus# show history | redirect history.txt

awplus# show history > history.txt

awplus# show history >> history.txt

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 2.1

Chapter 2: Command Syntax Conventions in

this Software Reference

The following table describes how command line interface syntax is shown in this Software Reference.

Syntax element Example What to enter in the command line

Keywords are shown in

lowercase fixed-width font or

bold variable-width font.

show spanning-tree mst

show ip route

Some keywords are required, and

others are optional parameters.

Type keywords exactly as they

appear in the command syntax.

Number ranges are enclosed in

angle-brackets < > and

separated by a hyphen.

<0-255> Enter a number from the range. Do

not enter the angle brackets.

Placeholders are shown in

lowercase italics within angle-

brackets < >, or in uppercase

italics.

<port-list>

ip dhcp pool NAME

Replace the placeholder with the

value you require. The placeholder

may be an IP address, a text string,

or some other value. See the

parameter table for the command

for information about the type of

value to enter. Do not enter the

angle-brackets.

Repeats are shown with ellipsis. param1... Enter the parameter one or more

times.

Optional elements are shown in

brackets: [ ] vlan <vid> [name <vlan-

name>]

If you need the optional parameter,

enter it. Do not enter the brackets.

Required choices are enclosed

in braces and separated by a

vertical bar (pipe) : {|}

spanning-tree {mstp|rstp|

stp} enable

Enter one only of the options. Do

not enter the braces or vertical bar.

Optional choices are enclosed in

or brackets and separated by a

vertical bar (pipe): [|]

[param1|param2] If needed, enter one only of the

options. Do not enter the brackets

or vertical bar.

Inclusive options are enclosed

in braces, and separated by

brackets: {[ ] [ ]}

{[param1] [param2]

[param3]}

Enter one or more of the options

and separate them with a space. Do

not enter the braces or brackets.

Command Syntax Conventions in this Software Reference

Software Reference for GS900MX/MPX Series Switches

2.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Start-Up Sequence

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 3.1

Chapter 3: Start-Up Sequence

AlliedWare Plus Start-Up ...................................................................................................................3.2

Diagnostic Menu ..................................................................................................................................3.3

Bootloader Menu .................................................................................................................................3.4

Start-Up Sequence............................................................................................................................ 3.10

Start-Up Sequence

Software Reference for GS900MX/MPX Series Switches

3.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

AlliedWare Plus Start-Up

Every switch has a start-up process. A specified version of product software must be

loaded and executed. The bootloader is the executable code responsible for setting up

the system and loading the release software.

The bootloader is the software that runs the unit when it first powers up, performing basic

initialization and executing the product software release. As part of the start-up process of

the switch, the bootloader allows you various options before running the product release

software.

Previous versions of AlliedWare provide the option to boot to EPROM if a software release

cannot be loaded or if selected by the user. The EPROM provides enough basic

functionality to get a working software release loaded and operational on the switch. In

AlliedWare Plus™ this task is handled by the bootloader.

As AlliedWare Plus™ begins its start-up process; there are two options that allow you to

access either the diagnostic menu, or the bootloader menu. The following prompt is

displayed when these options are temporarily available:

You can now enter one of the following two options to determine how the start-up

process proceeds:

■Enter Ctrl+D to display the diagnostic menu.

■Enter Ctrl+B to display the bootloader menu.

Bootloader 3.0.0-devel loaded

Press <Ctrl+B> for the Boot Menu

Start-Up Sequence

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 3.3

Diagnostic Menu

Enter Ctrl+D during start-up to access the bootloader diagnostic menu, and provide

options for performing various hardware tests. This can be useful as a tool for confirming a

suspected hardware problem at the direction of network engineering personnel. When

you enter Ctrl+D, the stage 1 diagnostics menu is displayed:

The options in the stage 1 diagnostics menu allow you to initiate the following tests:

■RAM: The Bootloader fully tests any/all SDRAM installed in the system.

■NVS: The Bootloader fully tests any/all non-volatile (battery backed) SRAM installed in

the system.

■checksum: The Bootloader checksum ROM memory for error detection.

For example, enter “2” to select a Quick RAM test:

Enter “7” to display the stage 2 diagnostics menu:

The options in the stage 2 diagnostics menu allow you to initiate the following tests:

■Flash: The Bootloader tests the user file system area of Flash. The bootloader is stored

in a protected area of Flash that is not accessed by the user file system.

■Flash Erase: The Bootloader erases the user file system area of Flash only.

Once any required tests are completed from the diagnostics menu, enter “9” to quit the

diagnostic menu and continue the switch boot-up process.

Bootup Stage 1 Diagnostics Menu:

0. Restart

1. Full RAM test

2. Quick RAM test

3. Battery backed RAM (NVS) test

4. Bootloader ROM checksum test

----------------------------------

7. Bootup stage 2 diagnostics menu

----------------------------------

8. Quit to U-Boot shell

9. Quit and continue booting

Enter selection ==>

Quick RAM test - press Q to quit, S to skip when failing

Writing pattern ................................

Checking pattern ................................

Writing complemented pattern ....................

Checking complemented pattern ...................

Pass 1 total errors 0

Entering stage 2...

Bootup Stage 2 Diagnostics Menu:

0. Restart

2. Test FLASH (Filesystem only)

4. Erase FLASH (Filesystem only)

5. Card slot test

----------------------------------

8. Quit to U-Boot shell

9. Quit and continue booting

Start-Up Sequence

Software Reference for GS900MX/MPX Series Switches

3.4 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Bootloader Menu

Enter Ctrl+B during start-up to access the bootloader menu where boot options can be

set. The boot options shown are explained in detail under this example.

Boot options A powerful feature of AlliedWare Plus™ is the ability to boot from a variety of sources.

Previously the switch was constrained to just booting off the release loaded into Flash

memory. The only software release upgrade path being to load a new release into Flash

memory and then set this release to be loaded at the next restart.

With AlliedWare Plus™ the switch can boot from other sources, such as a USB stick or

network server. This provides a very flexible system, with multiple options to upgrade

software releases and for system recovery.

Details of the bootloader menu options are as follows:

1. Perform one-off boot from alternate source

Enter “1” in the top-level menu to provide the following one-off boot options:

Boot Menu:

WARNING: The bootloader is not currently password protected.

------------------------------------------------------

B. Boot backup software

------------------------------------------------------

S. Security Level

------------------------------------------------------

0. Restart

1. Perform one-off boot from alternate source

2. Change the default boot source (for advanced users)

3. Update Bootloader

4. Adjust the console baud rate

5. Special boot options

6. System information

7. Restore Bootloader factory settings

------------------------------------------------------

9. Quit and continue booting

Enter selection ==>

Enter selection ==> 1

Select device:

0. Return to previous menu

------------------------------------------------------

1. Flash (flash:)

2. TFTP (tftp://)

3. YMODEM (ymodem:)

4. USB (usb:)

Enter selection ==>

Start-Up Sequence

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 3.5

You can select a one-off boot from Flash, USB storage device, network server (TFTP), or

ymodem. The selected option will be used for the next restart (only) of the switch. If you

select to boot from the network, the bootloader prompts the user for the required

network address details.

When the switch is booted up using the ‘one-off’ selected source for the software release,

it provides the option to copy the release just used to Flash for further/permanent use:

Note These settings are specific to the Bootloader. They are not related in any way to

what may be configured by the main software release.

Enter IP version [4|6]......... [4]:

Enter IP address for eth0 ..... [0.0.0.0]: 172.28.8.210

Enter subnet mask ............. [0.0.0.0]: 255.255.0.0

Enter gateway IP .............. [0.0.0.0]: 172.28.0.1

Enter TFTP server IP .......... [0.0.0.0]: 172.30.1.242

Enter filename ................ []: GS900-5.4.4E-1.1.rel

Loading tftp://172.30.1.242/GS900-5.4.4E-1.1.rel...

Password: ******

The system has been booted using the one off boot/recovery

mechanism.

Bootup has successfully completed.

Write this release to flash? (y/n):

Start-Up Sequence

Software Reference for GS900MX/MPX Series Switches

3.6 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

2. Change the default boot source (for advanced users)

Entering “2” in the top-level menu provides the option to set the boot source

permanently.

The same boot source options are provided as with the one-off selection, but this time

every restart of the switch will result in the unit booting from the selected source.

3. Update Bootloader

This option allows for the bootloader code to be updated. It is not detailed here, as it is

envisioned that this would rarely need to be done, and only at the request of (and with

support from) Allied Telesis engineering.

Boot Menu:

WARNING: The bootloader is not currently password protected.

------------------------------------------------------

B. Boot backup software

------------------------------------------------------

S. Security Level

------------------------------------------------------

0. Restart

1. Perform one-off boot from alternate source

2. Change the default boot source (for advanced users)

3. Update Bootloader

4. Adjust the console baud rate

5. Special boot options

6. System information

7. Restore Bootloader factory settings

------------------------------------------------------

9. Quit and continue booting

Enter selection ==>

Enter selection ==> 2

NOTE: These settings are specific to the Bootloader.

They are not related in any way to what may be configured

by the 'boot system' command in the main software release.

Select device:

0. Return to previous menu

------------------------------------------------------

1. Flash (flash:)

3. TFTP (tftp://)

4. YMODEM (ymodem:)

6. USB (usb:)

------------------------------------------------------

9. Boot from default (determined by main CLI)

Enter selection ==> 1

Start-Up Sequence

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 3.7

4. Adjust the console baud rate

The baud rate of the console session is set here to match the terminal program being used

for management of the switch when connected directly to the asynchronous port. The

switch’s default value is 9600. The baud rate selected can be set as the ‘new’ default for

future use if preferred.

Boot Menu:

WARNING: The bootloader is not currently password protected.

------------------------------------------------------

B. Boot backup software

------------------------------------------------------

S. Security Level

------------------------------------------------------

0. Restart

1. Perform one-off boot from alternate source

2. Change the default boot source (for advanced users)

3. Update Bootloader

4. Adjust the console baud rate

5. Special boot options

6. System information

7. Restore Bootloader factory settings

------------------------------------------------------

9. Quit and continue booting

Enter selection ==>

Select baud rate:

0. Return to previous menu

------------------------------------------------------

1. 9600

2. 19200

3. 38400

4. 57600

5. 115200

6. 230400 (Setting can't be made permanent)

7. 460800 (Setting can't be made permanent)

Enter selection ==> 1

Change your terminal program baud rate to 9600 and press

enter... if for some reason you are unable to do this,

power cycle the device and the existing baud rate will be

restored.

Use this baud rate by default? (Y/N) ==> n

Start-Up Sequence

Software Reference for GS900MX/MPX Series Switches

3.8 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

5. Special boot options

The special boot options allow for system recovery in the event of a forgotten password or

to the default configuration.

6. System information

The system information option provides some details on the hardware platform in use,

such as CPU, memory, hardware (MAC) address and so on.

Boot Menu:

WARNING: The bootloader is not currently password protected.

------------------------------------------------------

B. Boot backup software

------------------------------------------------------

S. Security Level

------------------------------------------------------

0. Restart

1. Perform one-off boot from alternate source

2. Change the default boot source (for advanced users)

3. Update Bootloader

4. Adjust the console baud rate

5. Special boot options

6. System information

7. Restore Bootloader factory settings

------------------------------------------------------

9. Quit and continue booting

Enter selection ==>

Special boot options menu:

0. Return to previous menu

------------------------------------------------------

1. Skip startup script (Use system defaults)

Enter selection ==>

Boot Menu:

WARNING: The bootloader is not currently password protected.

------------------------------------------------------

B. Boot backup software

------------------------------------------------------

S. Security Level

------------------------------------------------------

0. Restart

1. Perform one-off boot from alternate source

2. Change the default boot source (for advanced users)

3. Update Bootloader

4. Adjust the console baud rate

5. Special boot options

6. System information

7. Restore Bootloader factory settings

------------------------------------------------------

9. Quit and continue booting

Enter selection ==>

Start-Up Sequence

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 3.9

7. Restore Bootloader factory settings

This option allows the bootloader to be set back to factory defaults.

The bootloader menu provides a powerful set of options for flexibility in the way software

releases are upgraded on the switch, and system recovery is performed.

Caution This option erases any settings that may have been configured by this

Are you sure? (Y/N) ==>

Start-Up Sequence

Software Reference for GS900MX/MPX Series Switches

3.10 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Start-Up Sequence

The start-up sequence for a device running AlliedWare Plus™ under normal circumstances

will be as seen in the following pages. This sequence will be seen when everything loads

and runs as expected.

Note To enter the bootloader or diagnostic menus discussed previously, Ctrl+B or

Ctrl+D must be entered when prompted before the software modules start

Start-Up Sequence

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 3.11

Reading flash:GS900-5.4.4E-1.1.rel...

Verifying release... OK

Booting...

Starting base/first... [ OK ]

Mounting virtual filesystems... [ OK ]

______________ ____

/\ \ / /______\

/ \ \_ __/ /| ______ |

/ \ | | / | ______ |

/ \ \ / / \ ____ /

/______/\____\ \/ /____________/

Allied Telesis Inc.

AlliedWare Plus (TM) vVersion 5.4.4E-1

Current release filename: GS900-5.4.4E-1.1.rel

Original release filename: GS900-5.4.4E-1.1.rel

Built: Fri Feb 28 10:34:21 NZDT 2015

Mounting static filesystems... [ OK ]

Checking flash filesystem... [ OK ]

Mounting flash filesystem... [ OK ]

Checking NVS filesystem... [ OK ]

Mounting NVS filesystem... [ OK ]

Starting base/dbus... [ OK ]

Starting base/syslog... [ OK ]

Starting base/loopback... [ OK ]

Starting base/poe_done... [ OK ]

Starting base/sysctl... [ OK ]

Starting base/portmapper... [ OK ]

Received event syslog.done

Starting base/reboot-stability... [ OK ]

Checking system reboot stability... [ OK ]

Starting base/cron... [ OK ]

Starting base/appmond... [ OK ]

Starting hardware/openhpi... [ OK ]

Starting hardware/timeout... [ OK ]

Starting base/inet... [ OK ]

Starting base/modules... [ OK ]

Received event modules.done

Received event board.inserted

Starting network/poefw... [ OK ]

Received event poefw.done

Received event hardware.done

Starting network/startup... [ OK ]

Starting base/external-media... [ OK ]

Starting network/stackd... [ OK ]

Starting network/election.timeout... [ OK ]

Received event network.enabled

Initializing HA processes:

hostd, cntrd, nsm, ripngd, sflowd, auth, epsr

hsl, imiproxyd, irdpd, lldpd, loopprot, mstp, ospf6d

pdmd, pim6d, ripd, rmon, vrrpd, atmfd, bgpd

lacp, ospfd, pimd, udldd, imi

Received event network.initialized

21:14:13 awplus-1 VCS[951]: No neighboring members found, unit may be in a stand

alone configuration

Received event vcs.elected-master

21:14:13 awplus-1 VCS[951]: Startup speed can be improved by adding 'no stack 1

enable' to configuration

21:14:13 awplus-1 VCS[951]: Member 1 (eccd.6d9d.4eed) has become the Active Mast

Assigning Active Workload to HA processes:

21:14:13 awplus VCS[951]: Stack Virtual MAC is 0000.cd37.0065

21:14:22 awplus ATMF[896]: host_eccd_6d9d_4eed has joined. 1 member in total.

authd, epsrd, hsl, irdpd, lacpd, lldpd, loopprotd

mstpd, nsm, rmond, sflowd, vrrpd, imi, imiproxyd

Received event network.activated

Loading configuration file flash:/default.cfg, please wait.

...

done!

Received event network.configured

awplus login: manager

Password:

Start-Up Sequence

Software Reference for GS900MX/MPX Series Switches

3.12 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Verifying release... OK

Booting...

Starting base/first... [ OK ]

Mounting virtual filesystems... [ OK ]

______________ ____

/\ \ / /______\

/ \ \_ __/ /| ______ |

/ \ | | / | ______ |

/ \ \ / / \ ____ /

/______/\____\ \/ /____________/

Allied Telesis Inc.

AlliedWare Plus (TM) v0.0.0

Current release filename:Version 5.4.4E-1-0.1.rel

Original release filename: Version 5.4.4E-1-0.1.rel

Built: Thu May 29 01:32:38 NZST 2015

hwclock: settimeofday: Invalid argument

Mounting static filesystems... [ OK ]

Checking flash filesystem... [ OK ]

Mounting flash filesystem... [ OK ]

Checking for last gasp debug output... [ OK ]

Checking NVS filesystem... [ OK ]

Mounting NVS filesystem... [ OK ]

Starting base/dbus... [ OK ]

Starting base/syslog... [ OK ]

Starting base/loopback... [ OK ]

Starting base/poe_done... [ OK ]

Starting base/sysctl... [ OK ]

Starting base/portmapper... [ OK ]

Received event syslog.done

Starting base/reboot-stability... [ OK ]

Checking system reboot stability... [ OK ]

Starting base/cron... [ OK ]

Starting base/appmond... [ OK ]

Starting hardware/openhpi... [ OK ]

Starting hardware/timeout... [ OK ]

Starting base/inet... [ OK ]

Starting base/modules... [ OK ]

Received event modules.done

Received event board.inserted

Received event hardware.done

Starting network/startup... [ OK ]

Starting base/external-media... [ OK ]

Starting network/stackd... [ OK ]

Starting network/election.timeout... [ OK ]

Received event network.enabled

Initializing HA processes:

hostd, auth, cntrd, epsr, hsl, imiproxyd, mstp

nsm, rmon, sflowd, atmfd, imi, irdpd, lacp

lldpd, loopprot, udldd

Received event network.initialized

Assigning Active Workload to HA processes:

00:01:26 awplus VCS[996]: Stack Virtual MAC is 0000.cd37.02ea

hsl, nsm, lacpd, loopprotd, mstpd, rmond, sflowd

authd, epsrd, irdpd, lldpd, imi, imiproxyd

Received event network.activated

Loading default configuration

.......

done!

Received event network.configured

GS900 login:

Start-Up Sequence

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 3.13

There are three possible status results displayed for each module loaded - OK, INFO,

ERROR:

■OK means that the module has loaded correctly.

■INFO means that an error occurred, but the device is usable.

■ERROR means that an error occurred and device operation may be affected.

Additional specific information accompanies an INFO or ERROR status result. For example,

if a corrupt release file was set as the startup release, the following error message would

be seen:

Whether an error message results in a case of the device being unusable will depend on

the specific error and message, so will need to be dealt with on a case by case basis. If a

software release has been corrupted, as shown on start-up, a new release may need to be

loaded.

Bootloader 3.0.0-devel loaded

Press <Ctrl+B> for the Boot Menu

Reading filesystem...

Error: Release filename is invalid (should be GS900-5.4.4E-1.1.rel)

Error: There is no backup release file set

Error: Boot failed. Please recover the system using the Boot Menu

Restarting...Bootloader 3.0.0-devel loaded

Press <Ctrl+B> for the Boot Menu

Start-Up Sequence

Software Reference for GS900MX/MPX Series Switches

3.14 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 4.1

Chapter 4: CLI Navigation Commands

Command List .......................................................................................................................................4.2

configure terminal ...............................................................................................................................4.2

disable (Privileged Exec mode) .......................................................................................................4.2

do ...............................................................................................................................................................4.3

enable (Privileged Exec mode)........................................................................................................4.4

end.............................................................................................................................................................4.6

exit .............................................................................................................................................................4.6

help ...........................................................................................................................................................4.7

logout .......................................................................................................................................................4.7

show history...........................................................................................................................................4.8

CLI Navigation Commands

Software Reference for GS900MX/MPX Series Switches

4.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Command List

This chapter provides an alphabetical reference for the commands used to navigate

between different modes. This chapter also provides a reference for the help and show

commands used to help navigate within the CLI.

configure terminal

This command enters the Global Configuration command mode.

Syntax configure terminal

Mode Privileged Exec

Example To enter the Global Configuration command mode (note the change in the command

prompt), enter the command:

disable (Privileged Exec mode)

This command exits the Privileged Exec mode, returning the prompt to the User Exec

mode. To end a session, use the exit command.

Syntax disable

Mode Privileged Exec

Example To exit the Privileged Exec mode, enter the command:

Related Commands enable (Privileged Exec mode)

end

exit

awplus# configure terminal

awplus(config)#

awplus# disable

awplus>

CLI Navigation Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 4.3

This command lets you to run User Exec and Privileged Exec mode commands when you

are in any configuration mode.

Syntax do <command>

Mode Any configuration mode

Example

Parameter Description

<command> Specify the command and its parameters.

awplus# configure terminal

awplus(config)# do ping 192.0.2.23

CLI Navigation Commands

Software Reference for GS900MX/MPX Series Switches

4.4 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

enable (Privileged Exec mode)

This command enters the Privileged Exec mode and optionally changes the privilege level

for a session. If a privilege level is not specified then the maximum privilege level (15) is

applied to the session. If the optional privilege level is omitted then only users with the

maximum privilege level can access Privileged Exec mode without providing the

password as specified by the enable password or enable secret commands. If no

password is specified then only users with the maximum privilege level set with the

username command can assess Privileged Exec mode.

Syntax enable [<privilege-level>]

Mode User Exec

Usage Many commands are available from the Privileged Exec mode that configure operating

parameters for the switch, so you should apply password protection to the Privileged Exec

mode to prevent unauthorized use. Passwords can be encrypted but then cannot be

recovered. Note that non-encrypted passwords are shown in plain text in configurations.

The username command sets the privilege level for the user. After login, users are given

access to privilege level 1. Users access higher privilege levels with the enable (Privileged

Exec mode) command. If the privilege level specified is higher than the users configured

privilege level specified by the username command, then the user is prompted for the

password for that level.

Note that a separate password can be configured for each privilege level using the enable

password and the enable secret commands from the Global Configuration mode. The

service password-encryption command encrypts passwords configured by the enable

password and the enable secret commands, so passwords are not shown in plain text in

configurations.

Example The following example shows the use of the enable command to enter the Privileged Exec

mode (note the change in the command prompt).

Parameter Description

<privilege-

level>

Specify the privilege level for a CLI session in the range <1-15>, where

15 is the maximum privilege level, 7 is the intermediate privilege level

and 1 is the minimum privilege level. The privilege level for a user must

match or exceed the privilege level set for the CLI session for the user

to access Privileged Exec mode. Privilege level for a user is configured

by username.

awplus> enable

awplus#

CLI Navigation Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 4.5

The following example shows the enable command enabling access the Privileged Exec

mode for users with a privilege level of 7 or greater. Users with a privilege level of 7 or

greater do not need to enter a password to access Privileged Exec mode. Users with a

privilege level 6 or less need to enter a password to access Privilege Exec mode. Use the

enable password command or the enable secret commands to set the password to

enable access to Privileged Exec mode.

Related Commands disable (Privileged Exec mode)

enable password

enable secret

exit

service password-encryption

username

awplus> enable 7

awplus#

CLI Navigation Commands

Software Reference for GS900MX/MPX Series Switches

4.6 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

end

This command returns the prompt to the Privileged Exec command mode from any other

advanced command mode.

Syntax end

Mode All advanced command modes, including Global Configuration and Interface

Configuration modes.

Example The following example shows the use of the end command to return to the Privileged

Exec mode directly from Interface mode.

Related Commands disable (Privileged Exec mode)

enable (Privileged Exec mode)

exit

This command exits the current mode, and returns the prompt to the mode at the

previous level. When used in User Exec mode, the exit command terminates the session.

Syntax exit

Mode All command modes, including Global Configuration and Interface Configuration modes.

Example The following example shows the use of exit command to exit Interface mode, and

return to Configure mode.

Related Commands disable (Privileged Exec mode)

enable (Privileged Exec mode)

end

awplus# configure terminal

awplus(config)# interface vlan2

awplus(config-if)# end

awplus#

awplus# configure terminal

awplus(config)# interface vlan2

awplus(config-if)# exit

awplus(config)#

CLI Navigation Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 4.7

help

This command displays a description of the AlliedWare PlusTM OS help system.

Syntax help

Mode All command modes

Example To display a description on how to use the system help, use the command:

Output Figure 4-1: Example output from the help command

logout

This command exits the User Exec or Privileged Exec modes and ends the session.

Syntax logout

Mode User Exec and Privileged Exec

Example To exit the User Exec mode, use the command:

awplus# help

When you need help at the command line, press '?'.

If nothing matches, the help list will be empty. Delete

characters until entering a '?' shows the available options.

Enter '?' after a complete parameter to show remaining valid

command parameters (e.g. 'show ?').

Enter '?' after part of a parameter to show parameters that

complete the typed letters (e.g. 'show ip?').

awplus# logout

CLI Navigation Commands

Software Reference for GS900MX/MPX Series Switches

4.8 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show history

This command lists the commands entered in the current session. The history buffer is

cleared automatically upon reboot.

The output lists all command line entries, including commands that returned an error.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show history

Mode User Exec and Privileged Exec

Example To display the commands entered during the current session, use the command:

Output Figure 4-2: Example output from the show history command

awplus# show history

1 en

2 show ru

3 con t

4 route-map er deny 3

5 exit

6 ex

7 di

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 5.1

Chapter 5: User Access Commands

Introduction ...........................................................................................................................................5.2

Command List .......................................................................................................................................5.2

clear line console..................................................................................................................................5.2

clear line vty ...........................................................................................................................................5.3

enable password ..................................................................................................................................5.4

Using plain passwords ................................................................................................................5.5

Using encrypted passwords......................................................................................................5.5

Using hidden passwords............................................................................................................5.6

enable secret..........................................................................................................................................5.7

Using plain passwords ................................................................................................................5.8

Using encrypted passwords......................................................................................................5.8

Using hidden passwords............................................................................................................5.9

exec-timeout....................................................................................................................................... 5.10

flowcontrol hardware (asyn/console)........................................................................................ 5.11

length (asyn) ....................................................................................................................................... 5.13

line .......................................................................................................................................................... 5.14

privilege level ..................................................................................................................................... 5.16

security-password history.............................................................................................................. 5.17

security-password forced-change .............................................................................................. 5.18

security-password lifetime............................................................................................................. 5.19

security-password minimum-categories.................................................................................. 5.20

security-password minimum-length ......................................................................................... 5.21

security-password reject-expired-pwd ..................................................................................... 5.22

security-password warning ........................................................................................................... 5.23

service advanced-vty ....................................................................................................................... 5.24

service http.......................................................................................................................................... 5.25

service password-encryption........................................................................................................ 5.26

service telnet....................................................................................................................................... 5.27

show privilege.................................................................................................................................... 5.28

show security-password configuration..................................................................................... 5.29

show security-password user ....................................................................................................... 5.30

show telnet.......................................................................................................................................... 5.31

show users ........................................................................................................................................... 5.32

telnet...................................................................................................................................................... 5.33

telnet server ........................................................................................................................................ 5.34

terminal length .................................................................................................................................. 5.35

terminal resize.................................................................................................................................... 5.36

username ............................................................................................................................................. 5.37

User Access Commands

Software Reference for GS900MX/MPX Series Switches

5.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Introduction

This chapter provides an alphabetical reference of commands used to configure user

access.

Command List

clear line console

This command resets a console line. If a terminal session exists on the line then the

terminal session is terminated. If console line settings have changed then the new settings

are applied.

Syntax clear line console 0

Mode Privileged Exec

Example To reset the console line (asyn), use the command:

Related Commands clear line vty

flowcontrol hardware (asyn/console)

line

show users

awplus# clear line console 0

% The new settings for console line 0 have been

applied

User Access Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 5.3

clear line vty

This command resets a VTY line. If a session exists on the line then it is closed.

Syntax clear line vty <0-32>

Mode Privileged Exec

Example To reset the first vty line, use the command:

Related Commands privilege level

line

show telnet

show users

Parameter Description

<0-32>Line number

awplus# clear line vty 1

User Access Commands

Software Reference for GS900MX/MPX Series Switches

5.4 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

enable password

To set a local password to control access to various privilege levels, use the enable

password Global Configuration command. Use the enable password command to

modify or create a password to be used, and use the no enable password command to

remove the password.

Note that the enable secret command is an alias for the enable password command, and

the no enable secret command is an alias for the no enable password command. Issuing

a no enable password command removes a password configured with the enable secret

command. The enable password command is shown in the running and startup

configurations. Note that if the enable secret command is entered then enable

password is shown in the configuration.

Syntax enable password [<plain>|8 <hidden>|level <1-15> 8 <hidden>]

no enable password [level <1-15>]

Default The privilege level for enable password is level 15 by default. Previously the default was

level 1.

Mode Global Configuration

Usage This command enables the Network Administrator to set a password for entering the

Privileged Exec mode when using the enable (Privileged Exec mode) command. There

are three methods to enable a password. In the examples below, for each method, note

that the configuration is different and the configuration file output is different, but the

password string to be used to enter the Privileged Exec mode with the enable command

is the same (mypasswd).

A user can now have an intermediate CLI security level set with this command for privilege

level 7 to access all the show commands in Privileged Exec mode and all the commands in

User Exec mode, but not any configuration commands in Privileged Exec mode.

Note that the enable password command is an alias for the enable secret command and

one password per privilege level is allowed using these commands. Do not assign one

password to a privilege level with enable password and another password to a privilege

level with enable secret. Use enable password or enable secret commands. Do not use

both on the same level.

Parameter Description

<plain>Specifies the unencrypted password.

8Specifies a hidden password will follow.

<hidden>Specifies the hidden encrypted password. Use an encrypted

password for better security where a password crosses the network

or is stored on a TFTP server.

level Privilege level <1-15>. Level for which the password applies. You can

specify up to 16 privilege levels, using numbers 1 through 15. Level 1

is normal EXEC-mode user privileges for User Exec mode. If this

argument is not specified in the command or the no variant of the

command, the privilege level defaults to 15 (enable mode privileges)

for Privileged Exec mode. A privilege level of 7 can be set for

intermediate CLI security.

User Access Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 5.5

Using plain passwords

The plain password is a clear text string that appears in the configuration file as

configured.

This results in the following show output:

Using encrypted passwords

Configure an encrypted password using the service password-encryption command.

First, use the enable password command to specify the string that you want to use as a

password (mypasswd). Then, use the service password-encryption command to encrypt

the specified string (mypasswd). The advantage of using an encrypted password is that

the configuration file does not show mypasswd, it will only show the encrypted string

fU7zHzuutY2SA.

This results in the following show output:

awplus# configure terminal

awplus(config)# enable password mypasswd

awplus(config)# end

awplus#show run

Current configuration:

hostname awplus

enable password mypasswd

interface lo

awplus# configure terminal

awplus(config)# enable password mypasswd

awplus(config)# service password-encryption

awplus(config)# end

awplus#show run

Current configuration:

hostname awplus

enable password 8 fU7zHzuutY2SA

service password-encryption

interface lo

User Access Commands

Software Reference for GS900MX/MPX Series Switches

5.6 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Using hidden passwords

Configure an encrypted password using the HIDDEN parameter (8) with the enable

password command. Use this method if you already know the encrypted string

corresponding to the plain text string that you want to use as a password. It is not required

to use the service password-encryption command for this method. The output in the

configuration file will show only the encrypted string, and not the text string.

This results in the following show output:

Related Commands enable (Privileged Exec mode)

enable secret

service password-encryption

privilege level

show privilege

username

show running-config

awplus# configure terminal

awplus(config)# enable password 8 fU7zHzuutY2SA

awplus(config)# end

awplus#show run

Current configuration:

hostname awplus

enable password 8 fU7zHzuutY2SA

interface lo

User Access Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 5.7

enable secret

To set a local password to control access to various privilege levels, use the enable secret

Global Configuration command. Use the enable secret command to modify or create a

password to be used, and use the no enable secret command to remove the password.

Note that the enable secret command is an alias for the enable password command, and

the no enable secret command is an alias for the no enable password command. Issuing

a no enable password command removes a password configured with the enable secret

command. The enable password command is shown in the running and startup

configurations. Note that if the enable secret command is entered then enable

password is shown in the configuration

Syntax enable secret [<plain>|8 <hidden>|level <0-15> 8 <hidden>]

no enable secret [level <1-15>]

Default The privilege level for enable secret is level 15 by default.

Mode Global Configuration

Usage This command enables the Network Administrator to set a password for entering the

Privileged Exec mode when using the enable (Privileged Exec mode) command. There

are three methods to enable a password. In the examples below, for each method, note

that the configuration is different and the configuration file output is different, but the

password string to be used to enter the Privileged Exec mode with the enable command

is the same (mypasswd).

A user can have an intermediate CLI security level set with this command for privilege

level 7 to access all the show commands in Privileged Exec mode and all the commands in

User Exec mode, but not any configuration commands in Privileged Exec mode.

Note that the enable secret command is an alias for the enable password command and

one password per privilege level is allowed using these commands. Do not assign one

password to a privilege level with enable password and another password to a privilege

level with enable secret. Use enable password or enable secret commands. Do not use

both on the same level.

Parameter Description

<plain>Specifies the unencrypted password.

8Specifies a hidden password will follow.

<hidden>Specifies the hidden encrypted password. Use an encrypted

password for better security where a password crosses the network

or is stored on a TFTP server.

level Privilege level <1-15>. Level for which the password applies. You can

specify up to 16 privilege levels, using numbers 1 through 15. Level 1

is normal EXEC-mode user privileges for User Exec mode. If this

argument is not specified in the command or the no variant of the

command, the privilege level defaults to 15 (enable mode privileges)

for Privileged Exec mode. A privilege level of 7 can be set for

intermediate CLI security.

User Access Commands

Software Reference for GS900MX/MPX Series Switches

5.8 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Using plain passwords

The plain password is a clear text string that appears in the configuration file as

configured.

This results in the following show output:

Using encrypted passwords

Configure an encrypted password using the service password-encryption command.

First, use the enable password command to specify the string that you want to use as a

password (mypasswd). Then, use the service password-encryption command to encrypt

the specified string (mypasswd). The advantage of using an encrypted password is that

the configuration file does not show mypasswd, it will only show the encrypted string

fU7zHzuutY2SA.

This results in the following show output:

awplus# configure terminal

awplus(config)# enable secret mypasswd

awplus(config)# end

awplus#show run

Current configuration:

hostname awplus

enable password mypasswd

interface lo

awplus# configure terminal

awplus(config)# enable secret mypasswd

awplus(config)# service password-encryption

awplus(config)# end

awplus#show run

Current configuration:

hostname awplus

enable password 8 fU7zHzuutY2SA

service password-encryption

interface lo

User Access Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 5.9

Using hidden passwords

Configure an encrypted password using the HIDDEN parameter (8) with the enable

password command. Use this method if you already know the encrypted string

corresponding to the plain text string that you want to use as a password. It is not required

to use the service password-encryption command for this method. The output in the

configuration file will show only the encrypted string, and not the text string:

This results in the following show output:

Related Commands enable (Privileged Exec mode)

enable secret

service password-encryption

privilege level

show privilege

username

show running-config

awplus# configure terminal

awplus(config)# enable secret 8 fU7zHzuutY2SA

awplus(config)# end

awplus#show run

Current configuration:

hostname awplus

enable password 8 fU7zHzuutY2SA

interface lo

User Access Commands

Software Reference for GS900MX/MPX Series Switches

5.10 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

exec-timeout

This command sets the interval your device waits for user input from either a console or

VTY connection. Once the timeout interval is reached, the connection is dropped. This

command sets the time limit when the console or VTY connection automatically logs off

after no activity.

The no variant of this command removes a specified timeout and resets to the default

timeout (10 minutes).

Syntax exec-timeout {<minutes>} [<seconds>]

no exec-timeout

Default The default for the exec-timeout command is 10 minutes and 0 seconds (exec-timeout 10

0).

Mode Line Configuration

Usage This command is used set the time the telnet session waits for an idle VTY session, before

it times out. An exec-timeout 0 0 setting will cause the telnet session to wait indefinitely.

The command exec-timeout 0 0 is useful while configuring a device, but reduces device

security.

If no input is detected during the interval then the current connection resumes. If no

connections exist then the terminal returns to an idle state and disconnects incoming

sessions.

Examples To set VTY connections to timeout after 2 minutes, 30 seconds if there is no response from

the user, use the following commands:

To reset the console connection to the default timeout of 10 minutes 0 seconds if there is

no response from the user, use the following commands:

Validation

Commands

show running-config

Related Commands line

service telnet

Parameter Description

<minutes> <0-35791> Required integer timeout value in minutes

<seconds> <0-2147483> Optional integer timeout value in seconds

awplus# configure terminal

awplus(config)# line vty 0 32

awplus(config-line)# exec-timeout 2 30

awplus# configure terminal

awplus(config)# line console 0

awplus(config-line)# no exec-timeout

User Access Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 5.11

flowcontrol hardware (asyn/console)

Use this command to enable RTS/CTS (Ready To Send/Clear To Send) hardware flow

control on a terminal console line (asyn port) between the DTE (Data Terminal Equipment)

and the DCE (Data Communications Equipment).

Syntax flowcontrol hardware

no flowcontrol hardware

Mode Line Configuration

Default Hardware flow control is disabled by default.

Usage Hardware flow control makes use of the RTS and CTS control signals between the DTE and

DCE where the rate of transmitted data is faster than the rate of received data. Flow

control is a technique for ensuring that a transmitting entity does not overwhelm a

receiving entity with data. When the buffers on the receiving device are full, a message is

sent to the sending device to suspend the transmission until the data in the buffers has

been processed.

Hardware flow control can be configured on terminal console lines (e.g. asyn0). For

Reverse Telnet connections, hardware flow control must be configured to match on both

the Access Server and the Remote Device. For terminal console sessions, hardware flow

control must be configured to match on both the DTE and the DCE. Settings are saved in

the running configuration. Changes are applied after reboot, clear line console, or after

closing the session.

Use show running-config and show startup-config commands to view hardware flow

control settings that take effect after reboot for a terminal console line. See the show

running-config command output:

Note that line configuration commands do not take effect immediately. Line configuration

commands take effect after one of the following commands or events:

■issuing a clear line console command

■issuing a reboot command

■logging out of the current session

Examples To enable hardware flow control on terminal console line asyn0, use the commands:

awplus#show running-config

line con 1

speed 9600

mode out 2001

flowcontrol hardware

awplus# configure terminal

awplus(config)# line console 0

awplus(config-line)# flowcontrol hardware

User Access Commands

Software Reference for GS900MX/MPX Series Switches

5.12 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

To disable hardware flow control on terminal console line asyn0, use the commands:

Related Commands clear line console

show running-config

speed (asyn)

awplus# configure terminal

awplus(config)# line console 0

awplus(config-line)# no flowcontrol hardware

User Access Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 5.13

length (asyn)

Use this command to specify the number of rows of output that the device will display

before pausing, for the console or VTY line that you are configuring.

The no variant of this command restores the length of a line (terminal session) attached to

a console port or to a VTY to its default length of 22 rows.

Syntax length <0-512>

no length

Mode Line Configuration

Default The length of a terminal session is 22 rows. The no length command restores the default.

Usage If the output from a command is longer than the length of the line the output will be

paused and the ‘–More–’ prompt allows you to move to the next screen full of data.

A length of 0 will turn off pausing and data will be displayed to the console as long as

there is data to display.

Examples To set the terminal session length on the console to 10 rows, use the command:

To reset the terminal session length on the console to the default (22 rows), use the

command:

To display output to the console continuously, use the command:

Related Commands terminal length

terminal resize

Parameter Description

<0-512> Number of lines on screen. Specify 0 for no pausing.

awplus# configure terminal

awplus(config)# line console 0

awplus(config-line)# length 10

awplus# configure terminal

awplus(config)# line console 0

awplus(config-line)# no length

awplus# configure terminal

awplus(config)# line console 0

awplus(config-line)# length 0

User Access Commands

Software Reference for GS900MX/MPX Series Switches

5.14 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

line

Use this command to enter line configuration mode for the specified VTYs or the console.

The command prompt changes to show that the switch is in Line Configuration mode.

Syntax line vty <first-line> [<last-line>]

line console 0

Mode Global Configuration

Usage In Line Configuration mode, you can configure console and virtual terminal settings,

including setting speed (asyn), length (asyn), privilege level, and authentication (login

authentication) or accounting (accounting login) method lists.

To change the console (asyn) port speed, use this line command to enter Line

Configuration mode before using the speed (asyn) command on page 8.66. Set the

console speed (Baud rate) to match the transmission rate of the device connected to the

console (asyn) port on your switch.

Note that line configuration commands do not take effect immediately. Line configuration

commands take effect after one of the following commands or events:

■issuing a clear line console command

■issuing a reboot command

■logging out of the current session

Examples To enter Line Configuration mode in order to configure all VTYs, use the commands:

To enter Line Configuration mode to configure the console (asyn 0) port terminal line, use

the commands:

Parameter Description

<first-line> <0-32> Specify the first line number.

<last-line> <0-32> Specify the last line number.

console The console terminal line(s) for local access.

vty Virtual terminal for remote console access.

awplus# configure terminal

awplus(config)# line vty 0 32

awplus(config-line)#

awplus# configure terminal

awplus(config)# line console 0

awplus(config-line)#

User Access Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 5.15

Related Commands accounting login

clear line console

clear line vty

flowcontrol hardware (asyn/console)

length (asyn)

privilege level

speed (asyn)

User Access Commands

Software Reference for GS900MX/MPX Series Switches

5.16 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

privilege level

This command sets a privilege level for VTY or console connections. The configured

privilege level from this command overrides a specific user’s initial privilege level at the

console login.

Syntax privilege level <1-15>

Mode Line Configuration

Usage You can set an intermediate CLI security level for a console user with this command by

applying privilege level 7 to access all show commands in Privileged Exec and all User Exec

commands. However, intermediate CLI security will not show configuration commands in

Privileged Exec.

Examples To set the console connection to have the maximum privilege level, use the following

commands:

To set all vty connections to have the minimum privilege level, use the following

commands:

To set all vty connections to have an intermediate CLI security level, to access all show

commands, use the following commands:

Related Commands enable password

line

show privilege

username

awplus# configure terminal

awplus(config)# line console 0

awplus(config-line)# privilege level 15

awplus# configure terminal

awplus(config)# line vty 0 5

awplus(config-line)# privilege level 1

awplus# configure terminal

awplus(config)# line vty 0 5

awplus(config-line)# privilege level 7

User Access Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 5.17

security-password history

This command specifies the number of previous passwords that are unable to be reused. A

new password is invalid if it matches a password retained in the password history.

The no security-password history command disables the security password history

functionality.

Syntax security-password history <0-15>

no security-password history

Default The default history value is 0, which will disable the history functionality.

Mode Global Configuration

Examples To restrict reuse of the three most recent passwords, use the command:

To allow the reuse of recent passwords, use the command:

Validation

Commands

show running-config security-password

show security-password configuration

Related Commands security-password forced-change

security-password lifetime

security-password minimum-categories

security-password minimum-length

security-password reject-expired-pwd

security-password warning

Parameter Description

<0-15> The allowable range of previous passwords to match against. A

value of 0 will disable the history functionality and is equivalent to

the no security-password history command. If the history

functionality is disabled, all users’ password history is reset and all

password history is lost.

awplus# configure terminal

awplus(config)# security-password history 3

awplus# configure terminal

awplus(config)# no security-password history

User Access Commands

Software Reference for GS900MX/MPX Series Switches

5.18 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

security-password forced-change

This command specifies whether or not a user is forced to change an expired password at

the next login. If this feature is enabled, users whose passwords have expired are forced to

change to a password that must comply with the current password security rules at the

next login.

Note that to use this command, the lifetime feature must be enabled with the security-

password lifetime command and the reject-expired-pwd feature must be disabled with

the security-password reject-expired-pwd command.

The no security-password forced-change command disables the forced-change feature.

Syntax security-password forced-change

no security-password forced-change

Default The forced-change feature is disabled by default.

Mode Global Configuration

Example To force a user to change their expired password at the next login, use the command:

Validation

Commands

show running-config security-password

show security-password configuration

Related Commands security-password history

security-password lifetime

security-password minimum-categories

security-password minimum-length

security-password reject-expired-pwd

security-password warning

awplus# configure terminal

awplus(config)# security-password forced-change

User Access Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 5.19

security-password lifetime

This command enables password expiry by specifying a password lifetime in days.

Note that when the password lifetime feature is disabled, it also disables the security-

password forced-change command and the security-password warning command.

The no security-password lifetime command disables the password lifetime feature.

Syntax security-password lifetime <0-1000>

no security-password lifetime

Default The default password lifetime is 0, which will disable the lifetime functionality.

Mode Global Configuration

Example To configure the password lifetime to 10 days, use the command:

Validation

Commands

show running-config security-password

show security-password configuration

Related Commands security-password history

security-password forced-change

security-password minimum-categories

security-password minimum-length

security-password reject-expired-pwd

security-password warning

show security-password user

Parameter Description

<0-1000> Password lifetime specified in days. A value of 0 will disable lifetime

functionality and the password will never expire. This is equivalent

to the no security-password lifetime command.

awplus# configure terminal

awplus(config)# security-password lifetime 10

User Access Commands

Software Reference for GS900MX/MPX Series Switches

5.20 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

security-password minimum-categories

This command specifies the minimum number of categories that the password must

contain in order to be considered valid. The password categories are:

■uppercase letters: A to Z

■lowercase letters: a to z

■digits: 0 to 9

■special symbols: all printable ASCII characters not included in the previous three

categories. The question mark (?) cannot be used as it is reserved for help

functionality.

Note that to ensure password security, the minimum number of categories should align

with the lifetime selected, i.e. the fewer categories specified the shorter the lifetime

specified.

Syntax security-password minimum-categories <1-4>

Default The default number of categories that the password must satisfy is 1.

Mode Global Configuration

Example To configure the required minimum number of character categories to be 3, use the

command:

Validation

Commands

show running-config security-password

show security-password configuration

Related Commands security-password history

security-password forced-change

security-password lifetime

security-password minimum-length

security-password reject-expired-pwd

security-password warning

username

Parameter Description

<1-4> Number of categories the password must satisfy, in the range 1 to 4.

awplus# configure terminal

awplus(config)# security-password minimum-categories 3

User Access Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 5.21

security-password minimum-length

This command specifies the minimum allowable password length. This value is checked

against when there is a password change or a user account is created.

Syntax security-password minimum-length <1-23>

Default The default minimum password length is 1.

Mode Global Configuration

Example To configure the required minimum password length as 8, use the command:

Validation

Commands

show running-config security-password

show security-password configuration

Related Commands security-password history

security-password forced-change

security-password lifetime

security-password minimum-categories

security-password reject-expired-pwd

security-password warning

username

Parameter Description

<1-23> Minimum password length in the range from 1 to 23.

awplus# configure terminal

awplus(config)# security-password minimum-length 8

User Access Commands

Software Reference for GS900MX/MPX Series Switches

5.22 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

security-password reject-expired-pwd

This command specifies whether or not a user is allowed to login with an expired

password. Users with expired passwords are rejected at login if this functionality is

enabled. Users then have to contact the Network Administrator to change their password.

Note that when the reject-expired-pwd functionality is disabled and a user logs on with an

expired password, if the forced-change feature is enabled with security-password

forced-change command, a user may have to change the password during login

depending on the password lifetime specified by the security-password lifetime

command.

The no security-password reject-expired-pwd command disables the reject-expired-pwd

feature.

Syntax security-password reject-expired-pwd

no security-password reject-expired-pwd

Default The reject-expired-pwd feature is disabled by default.

Mode Global Configuration

Example To configure the system to reject users with an expired password, use the command:

Validation

Commands

show running-config security-password

show security-password configuration

Related Commands security-password history

security-password forced-change

security-password lifetime

security-password minimum-categories

security-password minimum-length

security-password warning

show security-password user

Caution Once all users’ passwords are expired you are unable to login to the device

again if the security-password reject-expired-pwd command has been

executed. You will have to reboot the device with a default configuration

file, or load an earlier software version that does not have the security

password feature.

We recommend you never have the command line “security-password

reject-expired-pwd” in a default config file.

awplus# configure terminal

awplus(config)# security-password reject-expired-pwd

User Access Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 5.23

security-password warning

This command specifies the number of days before the password expires that the user will

receive a warning message specifying the remaining lifetime of the password.

Note that the warning period cannot be set unless the lifetime feature is enabled with the

security-password lifetime command.

The no security-password warning command disables this feature.

Syntax security-password warning <0-1000>

no security-password warning

Default The default warning period is 0, which disables warning functionality.

Mode Global Configuration

Example To configure a warning period of three days, use the command:

Validation

Commands

show running-config security-password

show security-password configuration

Related Commands security-password history

security-password forced-change

security-password lifetime

security-password minimum-categories

security-password minimum-length

security-password reject-expired-pwd

Parameter Description

<0-1000> Warning period in the range from 0 to 1000 days. A value 0 disables

the warning functionality and no warning message is displayed for

expiring passwords. This is equivalent to the no security-password

warning command. The warning period must be less than, or equal

to, the password lifetime set with the security-password lifetime

command.

awplus# configure terminal

awplus(config)# security-password warning 3

User Access Commands

Software Reference for GS900MX/MPX Series Switches

5.24 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

service advanced-vty

This command enables the advanced-vty help feature. This allows you to use TAB

completion for commands. Where multiple options are possible, the help feature displays

the possible options.

The no service advanced-vty command disables the advanced-vty help feature.

Syntax service advanced-vty

no service advanced-vty

Default The advanced-vty help feature is enabled by default.

Mode Global Configuration

Examples To disable the advanced-vty help feature, use the command:

To re-enable the advanced-vty help feature after it has been disabled, use the following

commands:

awplus# configure terminal

awplus(config)# no service advanced-vty

awplus# configure terminal

awplus(config)# service advanced-vty

User Access Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 5.25

service http

This command enables the HTTP (Hypertext Transfer Protocol) service. The HTTP service is

enabled by default.

The no service http command disables the HTTP feature.

Syntax service http

no service http

Default The HTTP service is enabled by default.

Mode Global Configuration

Examples To disable the HTTP service, use the command:

To re-enable the HTTP service after it has been disabled, use the following commands:

awplus# configure terminal

awplus(config)# no service http

awplus# configure terminal

awplus(config)# service http

User Access Commands

Software Reference for GS900MX/MPX Series Switches

5.26 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

service password-encryption

Use this command to enable password encryption. This is enabled by default. When

password encryption is enabled, the device displays passwords in the running config in

encrypted form instead of in plain text.

Use the no service password-encryption command to stop the device from displaying

newly-entered passwords in encrypted form. This does not change the display of existing

passwords.

Syntax service password-encryption

no service password-encryption

Mode Global Configuration

Example

Validation

Commands

show running-config

Related Commands enable password

awplus# configure terminal

awplus(config)# service password-encryption

User Access Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 5.27

service telnet

Use this command to enable the telnet server. The server is enabled by default. Enabling

the telnet server starts the switch listening for incoming telnet sessions on the configured

port.

The server listens on port 23, unless you have changed the port by using the privilege

level command on page 5.16.

Use the no variant of this command to disable the telnet server. Disabling the telnet server

will stop the switch listening for new incoming telnet sessions. However, existing telnet

sessions will still be active.

Syntax service telnet [ip|ipv6]

no service telnet [ip|ipv6]

Default The IPv4 and IPv6 telnet servers are enabled by default.

The configured telnet port is TCP port 23 by default.

Mode Global Configuration

Examples To enable both the IPv4 and IPv6 telnet servers, use the following commands:

To enable the IPv6 telnet server only, use the following commands:

To disable both the IPv4 and IPv6 telnet servers, use the following commands:

To disable the IPv6 telnet server only, use the following commands:

Related Commands clear line vty

show telnet

telnet server

awplus# configure terminal

awplus(config)# service telnet

awplus# configure terminal

awplus(config)# service telnet ipv6

awplus# configure terminal

awplus(config)# no service telnet

awplus# configure terminal

awplus(config)# no service telnet ipv6

User Access Commands

Software Reference for GS900MX/MPX Series Switches

5.28 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show privilege

This command displays the current user privilege level, which can be any privilege level in

the range <1-15>. Privilege levels <1-6> allow limited user access (all User Exec

commands), privilege levels <7-14> allow restricted user access (all User Exec commands

plus Privileged Exec show commands). Privilege level 15 gives full user access to all

Privileged Exec commands.

Syntax show privilege

Mode User Exec and Privileged Exec

Usage A user can have an intermediate CLI security level set with this command for privilege

levels <7-14> to access all show commands in Privileged Exec mode and all commands in

User Exec mode, but no configuration commands in Privileged Exec mode.

Example To show the current privilege level of the user, use the command:

Output Figure 5-1: Example output from the show privilege command

Related Commands privilege level

awplus# show privilege

awplus#show privilege

Current privilege level is 15

awplus#disable

awplus>show privilege

Current privilege level is 1

User Access Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 5.29

show security-password configuration

This command displays the configuration settings for the various security password rules.

Syntax show security-password configuration

Mode Privileged Exec

Example To display the current security-password rule configuration settings, use the command:

Output Figure 5-2: Example output from the show security-password configuration

command

Related Commands show running-config security-password

show security-password user

awplus# show security-password configuration

Security Password Configuration

Minimum password length ............................ 8

Minimum password character categories to match ..... 3

Number of previously used passwords to restrict..... 4

Password lifetime .................................. 30 day(s)

Warning period before password expires ........... 3 day(s)

Reject expired password at login ................... Disabled

Force changing expired password at login ......... Enabled

User Access Commands

Software Reference for GS900MX/MPX Series Switches

5.30 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show security-password user

This command displays user account and password information for all users.

Syntax show security-password user

Mode Privileged Exec

Example To display the system users’ remaining lifetime or last password change, use the

command:

Output Figure 5-3: Example output from the show security-password user command

Related Commands show running-config security-password

show security-password configuration

awplus# show security-password user

User account and password information

UserName Privilege Last-PWD-Change Remaining-lifetime

----------------------------------------------------------------

manager 15 4625 day(s) ago No Expiry

bob15 15 0 day(s) ago 30 days

ted7 7 0 day(s) ago No Expiry

mike1 1 0 day(s) ago No Expiry

User Access Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 5.31

show telnet

This command shows the Telnet server settings.

Syntax show telnet

Mode User Exec and Privileged Exec

Example To show the Telnet server settings, use the command:

Output Figure 5-4: Example output from the show telnet command

Related Commands clear line vty

service telnet

show users

telnet server

awplus# show telnet

Telnet Server Configuration

------------------------------------------------------------

Telnet server : Enabled

Protocol : IPv4,IPv6

Port : 23

User Access Commands

Software Reference for GS900MX/MPX Series Switches

5.32 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show users

This command shows information about the users who are currently logged into the

device.

Syntax show users

Mode User Exec and Privileged Exec

Example To show the users currently connected to the device, use the command:

Output Figure 5-5: Example output from the show users command

Table 5-1: Parameters in the output of the show users command

awplus# show users

Line User Host(s) Idle Location Priv Idletime Timeout

con 0 manager idle 00:00:00 ttyS0 15 10 N/A

vty 0 bob idle 00:00:03 172.16.11.3 1 0 5

Parameter Description

Line Console port user is connected to.

User Login name of user.

Host(s) Status of the host the user is connected to.

Idle How long the host has been idle.

Location URL location of user.

Priv The privilege level in the range 1 to 15, with 15 being the highest.

Idletime The time interval the device waits for user input from either a

console or VTY connection.

Timeout The time interval before a server is considered unreachable.

User Access Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 5.33

telnet

Use this command to open a telnet session to a remote device.

Syntax telnet {<hostname>|[ip] <ipv4-addr>|[ipv6] <ipv6-addr>} [<port>]

Mode User Exec and Privileged Exec

Examples To connect to TCP port 2602 on the device at 10.2.2.2, use the command:

To connect to the telnet server host.example, use the command:

To connect to the telnet server host.example on TCP port 100, use the command:

Parameter Description

<hostname>The host name of the remote system.

ip Keyword used to specify the IPv4 address or host name of a remote

system.

<ipv4-addr> An IPv4 address of the remote system.

ipv6 Keyword used to specify the IPv6 address of a remote system

<ipv6-addr> Placeholder for an IPv6 address in the format x:x::x:x, for

example, 2001:db8::8a2e:7334

<port>Specify a TCP port number (well known ports are in the range 1-

1023, registered ports are 1024-49151, and private ports are 49152-

65535).

awplus# telnet 10.2.2.2 2602

awplus# telnet host.example

awplus# telnet host.example 100

User Access Commands

Software Reference for GS900MX/MPX Series Switches

5.34 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

telnet server

This command enables the telnet server on the specified TCP port. If the server is already

enabled then it will be restarted on the new port. Changing the port number does not

affect the port used by existing sessions.

Syntax telnet server {<1-65535>|default}

Mode Global Configuration

Example To enable the telnet server on TCP port 2323, use the following commands:

Related Commands show telnet

Parameter Description

<1-65535> The TCP port to listen on.

default Use the default TCP port number 23.

awplus# configure terminal

awplus(config)# telnet server 2323

User Access Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 5.35

terminal length

Use the terminal length command to specify the number of rows of output that the

device will display before pausing, for the currently-active terminal only.

Use the terminal no length command to remove the length specified by this command.

The default length will apply unless you have changed the length for some or all lines by

using the length (asyn) command on page 5.13.

Syntax terminal length <length>

terminal no length [<length>]

Mode User Exec and Privileged Exec

Examples The following example sets the number of lines to 15:

The following example removes terminal length set previously:

Related Commands length (asyn)

terminal resize

Parameter Description

<length><0-512> Number of rows that the device will display on the

currently-active terminal before pausing.

awplus# terminal length 15

awplus# terminal no length

User Access Commands

Software Reference for GS900MX/MPX Series Switches

5.36 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

terminal resize

Use this command to automatically adjust the number of rows of output on the console,

which the device will display before pausing, to the number of rows configured on the

user’s terminal.

Syntax terminal resize

Mode User Exec and Privileged Exec

Usage When the user’s terminal size is changed, then a remote session via SSH or TELNET adjusts

the terminal size automatically. However, this cannot normally be done automatically for a

serial or console port. This command automatically adjusts the terminal size for a serial or

console port.

Examples The following example automatically adjusts the number of rows shown on the console:

Related Commands length (asyn)

terminal length

awplus# terminal resize

User Access Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 5.37

username

This command creates or modifies a user to assign a privilege level and a password.

Syntax username <name> privilege <0-15> [password [8] <password>]

username <name> password [8] <password>

no username <name>

Note The default username privilege level of 1 is not shown in running-config

output. Any username privilege level that has been modified from the default is

shown.

Parameter Description

<name>The login name for the user. Do not use punctuation marks such as single quotes (‘ ‘),

double quotes (““), or colons ( : ) with the user login name.

privilege The user’s privilege level. Use the privilege levels to set the access rights for each user.

<0-15> A privilege level: either 0 (no access), 1-14 (limited access) or 15 (full

access). A user with privilege level 1-14 can only access higher

privilege levels if an enable password has been configured for the

level the user tries to access and the user enters that password.

A user at privilege level 1 can access the majority of show

commands. A user at privilege level 7 can access the majority of

show commands including platform show commands. Privilege

Level 15 (to access the Privileged Exec command mode) is required

to access configuration commands as well as show commands in

Privileged Exec.

password A password that the user must enter when logging in.

8Specifies that you are entering a password as a string that has

already been encrypted, instead of entering a plain-text password.

The running-config displays the new password as an encrypted

string even if password encryption is turned off.

Note that the user enters the plain-text version of the password

when logging in.

<password>The user’s password. The password can be up to 23 characters in

length and include characters from up to four categories. The

password categories are:

■uppercase letters: A to Z

■lowercase letters: a to z

■digits: 0 to 9

■special symbols: all printable ASCII characters not included in the

previous three categories. The question mark ? cannot be used

as it is reserved for help functionality.

User Access Commands

Software Reference for GS900MX/MPX Series Switches

5.38 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Mode Global Configuration

Default The privilege level is 1 by default. Note the default is not shown in running-config output.

Usage An intermediate CLI security level (privilege level 7 to privilege level 14) allows a CLI user

access to the majority of show commands, including the platform show commands that

are available at privilege level 1 to privilege level 6). Note that some show commands,

such as show running-configuration and show startup-configuration, are only available at

privilege level 15.

A privilege level of 0 can be set for port authentication purposes from a RADIUS server.

Examples To create the user bob with a privilege level of 15, for all show commands including show

running-configuration and show startup-configuration and to access configuration

commands in Privileged Exec command mode, and the password bobs_secret, use the

commands:

To create a user junior_admin with a privilege level of 7, for intermediate CLI security

level access for most show commands, and the password show_only, use the

commands:

Related Commands enable password

security-password minimum-categories

security-password minimum-length

awplus# configure terminal

awplus(config)# username bob privilege 15 password

bobs_secret

awplus# configure terminal

awplus(config)# username junior_admin privilege 7

password show_only

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 6.1

Chapter 6: Creating and Managing Files

Introduction ...........................................................................................................................................6.2

USB Support...........................................................................................................................................6.2

Working with Files ...............................................................................................................................6.2

Listing Files......................................................................................................................................6.3

Displaying the Contents of Configuration and Text Files ..............................................6.4

Navigating Through the File System .....................................................................................6.4

Using the Editor.............................................................................................................................6.6

Creating and Using Configuration Files.......................................................................................6.8

Creating a Configuration File....................................................................................................6.8

Specifying the Start-Up Configuration Script.....................................................................6.8

Working with Configuration Files ...........................................................................................6.9

The Configuration File Fallback Order ............................................................................... 6.10

Copying Files to and from Your Device..................................................................................... 6.12

URL Syntax.................................................................................................................................... 6.12

Copying Files ............................................................................................................................... 6.13

Copying from a Server to Running Configuration......................................................... 6.17

The Autoboot Feature ..................................................................................................................... 6.19

Restoring a Switch Using Autoboot from External Media .......................................... 6.20

Configure Autoboot.................................................................................................................. 6.22

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

6.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Introduction

This chapter provides information on:

■USB Support

■Working with Files

■Creating and Using Configuration Files

■Copying Files to and from Your Device

USB Support

Your switch supports both standard and secure USB storage devices.

USB storage devices used as backup memory can be easily pulled out of a switch. You can

use Secure USB storage devices to protect this data in the event that it is mislaid or in

unauthorized hands. Secure USB devices provide password (PIN)-protected encryption to

the data they store.

Note that if the switch reboots, the Secure USB key will be locked.

After a VCStack failover, when a stack member recovers, the Secure USB device cannot be

accessed until it is unlocked.

Working with Files

The AlliedWare PlusTM OS lets you create directory trees for file storage. This section

shows:

■“Listing Files” on page 6.3—listing files and seeing how much free space you have

■“Displaying the Contents of Configuration and Text Files” on page 6.4

■“Navigating Through the File System” on page 6.4—identifying the current

directory, changing directories, and creating and deleting directories

■“Using the Editor” on page 6.6

Flash compaction The Flash memory on the switch automatically compacts itself to recover space available

from deleted files. The switch only does this when necessary, and not every file deletion

causes Flash compaction. Flash compaction can occur after a file of any size is added to or

deleted from the switch.

Caution While Flash is compacting, the console is unresponsive. Do not restart the

switch, as interrupting Flash compaction can damage files.

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 6.3

Listing Files

To list files, enter Privileged Exec mode and enter the command:

The output lists files and directories in order of modification date, descending. It looks like

this:

Listing files including hidden system files

The dir command does not list all files—it hides system files and directories because users

generally do not need to create or edit them. To list all files including system files, enter

Privileged Exec mode and enter the command:

The output looks like this:

The hidden files and directories begin with a dot.

Seeing information about the filesystem

To display information about the different memory types on the switch, enter Privileged

Exec mode and enter the command:

The output includes the amount of free memory and the prefix you type to access that

memory type, and looks like this:

awplus# dir

-rw- 534 Jul 12 2014 17:52:50 stp.cfg

-rw- 534 Jul 12 2014 17:12:50 example.cfg

-rw- 12429011 Jul 12 2014 16:26:06 GS900-5.4.4E-1.1.rel

awplus# dir all

drwx 0 Jul 12 2011 17:16:32 ./

-rw- 401 Jul 12 2011 17:16:32 example.cfg

-rw- 534 Jul 12 2011 17:52:50 stp.cfg

-rw- 12429011 Jul 12 2011 16:26:06 GS900-5.4.4E-1.1.rel

drwx 216 Jul 9 2011 11:31:18 ../

drwx 0 Jun 13 2011 04:31:51 .configs/

-rw- 17 Jun 13 2011 04:27:27 .release

drwx 0 Jul 10 2011 23:40:00 .ssh/

awplus# show file systems

Size(b) Free(b) Type Flags Prefixes S/D/V Lcl/Ntwk Avail

----------------------------------------------------------------

126.0M 106.4M flash rw flash: static local Y

- - system rw system: virtual local -

10.0M 9.8M debug rw debug: static local Y

499.0K 404.0K nvs rw nvs: static local Y

- - usbstick rw usb: dynamic local N

- - tftp rw tftp: - network -

- - scp rw scp: - network -

- - sftp ro sftp: - network -

- - http ro http: - network -

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

6.4 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Listing files in a subdirectory

To list the contents of a directory, enter Privileged Exec mode and enter the command:

Tip You can specify the directory with or without a / after the directory name.

Example To display the contents of a directory called “example”, enter the command:

Listing files in NVS memory or on a USB storage device

To list the contents of a directory on a USB storage device, enter the command:

Example To display the contents of a directory in NVS called “example”, enter the command:

Displaying the Contents of Configuration and

Text Files

To display the contents of a file, enter Privileged Exec mode and enter the command:

Example To display the contents of the file called “example.cfg”, enter the command:

Navigating Through the File System

Showing the current directory

To see which directory you are currently in, enter Privileged Exec mode and enter the

command:

For the top-level directory, the output looks like this:

awplus# dir <directory-name>

awplus# dir example

awplus# dir usb:<directory-name>

awplus# dir nvs:example

awplus# show file <filename>

awplus# show file example.cfg

awplus# pwd

flash:/

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 6.5

Changing directories

To change to another directory, enter Privileged Exec mode and enter the command:

To go to a directory one level higher in the directory tree, enter the command:

Example To change to a directory called “example”, enter the command:

To go up one level, which returns you to the top level directory, enter the command:

Changing to a directory in NVS memory or on a USB storage

device

To change to the top-level directory in the NVS memory filesystem, enter Privileged Exec

mode and enter the command:

To change to the top-level directory on a USB storage device, enter the command:

Next, you can change to other directories by entering the command:

Alternatively, you can go straight from Flash to a subdirectory in the alternative filesystem,

by entering one of the commands:

To return to the Flash filesystem, enter the command:

Example To change to the directory within NVS called “example”, enter the command:

awplus# cd <directory-name>

awplus# cd ..

awplus# cd example

awplus# cd ..

awplus# cd nvs:

awplus# cd usb:/

awplus# cd <directory-name>

awplus# cd nvs:<directory-name>

awplus# cd usb:/<directory-name>

awplus# cd flash:/

awplus# cd nvs:example

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

6.6 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

To go up one level, which returns you to the top-level directory of NVS memory, enter the

command:

Creating new directories

To create a directory, enter Privileged Exec mode and enter the command:

Example To make a directory called “example” within the Flash filesystem, enter the command:

Deleting directories

To delete an empty directory, enter Privileged Exec mode and enter the command:

To delete a directory and all its contents, enter Privileged Exec mode and enter the

command:

The switch prompts you for confirmation.

Example To delete an empty directory called “example” from within the Flash filesystem, enter the

command:

Using the Editor

The inbuilt editor is JOE (Joe’s Own Editor).

To edit an existing file, enter Privileged Exec mode and enter the command:

To open the editor with an empty file, enter the command:

When you save the new file, you may need to specify the filesystem to store it on. For

Flash, use flash:/<filename>.

Using JOE To format and manipulate text in JOE, you use control-character sequences. The following

table summarizes a few useful sequences—for details, see:

awplus# cd ..

awplus# mkdir <directory-name>

awplus# mkdir example

awplus# rmdir <directory-name>

awplus# delete recursive <directory-name>

awplus# rmdir example

awplus# edit <filename>

awplus# edit

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 6.7

joe-editor.sourceforge.net/manpage.html.

Function Control-character sequence

Access the help Ctrl-K-H

Save the file without exiting (for new files, this

prompts for a filename)

Ctrl-K-D

Save the file and exit (this prompts for a

filename)

Ctrl-K-X

Exit without saving the file Ctrl-C

Go to the beginning of the file Ctrl-K-U

Go to the end of the file Ctrl-K-V

Go up one full screen of text in the file Ctrl-U

Go down one full screen of text in the file Ctrl-V

Select a block of text:

Mark the beginning of the block Ctrl-K-B

Mark the end of the block Ctrl-K-K

Copy and paste a selected block of text Place cursor at destination then enter

Ctrl-K-C

Move a selected block of text Place cursor at destination then enter

Ctrl-K-M

Delete a selected block of text Ctrl-K-Y

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

6.8 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Creating and Using Configuration Files

This section provides instructions on:

■Creating a Configuration File

■Specifying the Start-Up Configuration Script

■Working with Configuration Files

Creating a Configuration File

A configuration file is a text file that contains a sequence of standard commands for a

specific purpose. Configuration files have a .cfg extension.

You can create and edit configuration files on your device by:

■saving the dynamic configuration on the device, known as the running-config (see

“Working with Configuration Files”). Use the command:

where URL specifies a file in Flash. If you do not specify a file name, the switch names

the file default.cfg.

■using the device’s text editor. Use the command:

where source-URL is the name of the copied file in Flash memory.

■creating a file on a remote PC, then copying it to onto your device. See “Copying

Files” for more information about using the copy commands.

Once you have created a configuration file, you can use it as the startup-config file. See

“Specifying the Start-Up Configuration Script” for more information.

Specifying the Start-Up Configuration Script

When you restart your device, or when it automatically restarts, it executes the pre-

configured commands in a configuration script known as the boot config or

startup-config file.

When you first start your device, the script set as the startup-config file is default.cfg. If

desired, you can overwrite default.cfg with another configuration. Alternatively, you can

change the startup-config by specifying a new file as the startup-config. Use the

command:

where URL specifies the name and location of a configuration file. At the next restart, the

device executes the commands in the specified file.

You can specify that the configuration file is either in the Flash or USB storage device

filesystem. However, if you specify that the configuration file is on a USB storage device

then you must first create a backup configuration file stored in Flash.

awplus# copy running-config (destination-URL)

awplus# edit (source-URL)

awplus(config)# boot config-file backup URL

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 6.9

To specify a backup configuration file, use the command:

where URL specifies the name and location of a configuration file.

You can change the content of the file set as the startup-config file by:

■entering commands directly into the CLI, then saving this configuration using the

command:

This command saves the device’s dynamic configuration into the file that is currently

configured as the startup-config file.

■writing commands into a configuration file (see “Creating a Configuration File”

below), then using the command:

This command saves the script from the source file into the file that is currently

configured as the startup-config file.

To display the name of the configuration file that is set to execute when the device

restarts, enter the command:

To see the commands in the startup-config file, use the command:

To erase the file set as the startup-config file, use the command:

At the next restart that occurs after you’ve erased the file, the device loads the

configuration in the file default.cfg. This file is set on the system as a backup

configuration file that loads if no other file is set as the startup-config file.

Working with Configuration Files

When you use the CLI to configure your device, it stores this dynamic configuration as a

list of commands called the running-config. To view the device’s running-config, use the

command:

If you turn off the device or restart it, any unsaved changes to the running-config are lost.

To save the running-config as a configuration script, use the command:

awplus(config)# boot config-file backup backup URL

awplus# copy running-config startup-config

awplus# copy SOURCE-URL startup-config

awplus# show boot

awplus# show startup-config

awplus# erase startup-config

awplus# show running-config

awplus# copy running-config destination-url

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

6.10 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

You may have many configuration files. Storing them on a device allows you to keep a

backup device with configuration scripts for every device in the network to speed up

network recovery time. Multiple scripts also let you test new configuration scripts before

setting them as the startup-config. For example, to test a new script named test.cfg, enter

the command:

This allows you to run a configuration file any time without restarting the device, by

replacing the system’s current dynamic configuration with the script in the configuration

file. However, note that some commands require you to restart the device before they can

take effect, such as the platform commands.

You can also set a trigger to automatically execute a configuration script when a

predetermined event occurs. For information about creating triggers, see Chapter 74,

Triggers Introduction.

The Configuration File Fallback Order

The configuration fallback order is: configuration file, backup configuration file, default

configuration file and then the factory default configuration. It is important to note the

there is a distinction in system behavior between when writing to the startup-config file

and when the system boots up.

When you copy a configuration script from a source file into the startup-config file the

system will write to the first file that is configured. Potentially, this means that if a

configuration file and a backup configuration file are not set you will write to the

default.cfg.

At system startup the device goes through the fallback sequence until it finds a file that

exists. For example, if the configuration file is not found then the backup configuration file

becomes the current boot configuration, or startup-config, and so on. In the output

displayed by the show boot command, the Current boot config parameter shows the

startup-config file that the switch will load during the next boot cycle. The fallback

sequence when configuration files are deleted is shown below in output from the show

boot command.

In the example output below, the current boot configuration file, my.cfg, is set on the USB

storage device. This is the startup-config file that the device loads at the next boot cycle.

awplus# copy flash:/test.cfg running-config

awplus#show boot

Boot configuration

----------------------------------------------------------------

Current software : GS900-5.4.4E-1.1.rel

Current boot image : usb:/GS900-5.4.4E-1.1.rel

Backup boot image : flash:/GS900-5.4.4E-1.1.rel

Default boot config: flash:/default.cfg

Current boot config: usb:/my.cfg (file exists)

Backup boot config: flash:/backup.cfg (file exists)

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 6.11

In the example output below, the no boot-config command has been used to delete the

configuration file my.cfg on the USB storage device. The backup configuration file

backup.cfg in Flash then becomes the current boot config.

In the example output below, the no boot-config backup command has been used to

delete the backup configuration file backup.cfg. The default configuration file default.cfg

then becomes the current boot config.

If the current boot configuration file is set on a USB storage device and this device has

been removed from the switch, the Current boot config parameter field indicates that this

file cannot be found, as shown in the following example output.

At system startup the switch will load the backup configuration file as the startup-config.

awplus#show boot

Boot configuration

----------------------------------------------------------------

Current software : GS900-5.4.4E-1.1.rel

Current boot image : usb:/GS900-5.4.4E-1.1.rel

Backup boot image : flash:/GS900-5.4.4E-1.1.rel

Default boot config: flash:/default.cfg

Current boot config: flash:/backup.cfg (file exists)

Backup boot config: flash:/backup.cfg (file exists)

awplus#show boot

Boot configuration

----------------------------------------------------------------

Current software : GS900-5.4.4E-1.1.rell

Current boot image : usb:/GS900-5.4.4E-1.1.rel

Backup boot image : flash:/GS900-5.4.4E-1.1.rel

Default boot config: flash:/default.cfg

Current boot config: flash:/default.cfg (file exists)

Backup boot config: Not set

awplus#show boot

Boot configuration

----------------------------------------------------------------

Current software : GS900-5.4.4E-1.1.rel

Current boot image : usb:/GS900-5.4.4E-1.1.rel

Backup boot image : flash:/GS900-5.4.4E-1.1.rel

Default boot config: flash:/default.cfg

Current boot config: usb:/my.cfg (file not found)

Backup boot config: flash:/backup.cfg (file exists)

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

6.12 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Copying Files to and from Your Device

This section provides instructions on:

■URL Syntax

■Copying Files

URL Syntax

Many of the file management commands use the placeholder “URL” to represent the

name and location of the file that you want to act on. The following table explains the

syntax of this URL for each different type of file location.

When you copy a

file... Use this syntax: Example:

Copying in local

Flash memory

flash:[/][<directory>/]<filename>To specify a file in the configs directory in

Flash:

flash:configs/example.cfg

Copying to or from

a USB storage

device

usb:[/][<directory>/]<filename>To specify a file in the top-level directory of

the USB stick:

usb:example.cfg

Copying with

Hypertext Trans-

fer Protocol

(HTTP)

http://

[[<username>:<password>]@] {<host

name>|<host-ip>}[/<filepath>]/

To specify a file in the configs directory on

the server:

http://www.company.com/configs/

example.cfg

Copying with

Trivial File Trans-

fer Protocol

(TFTP)

tftp://[[<location>]/

To specify a file in the top-level directory of

the server:

tftp://172.1.1.1/example.cfg

Copying with

Secure Copy

(SCP)

scp://<username>@<location>[/

<directory>][/<filename>]

To specify a file in the configs directory on

the server, logging on as user “bob”:

e.g. scp://bob@10.10.0.12/

configs/example.cfg

Copying with SSH

File Transfer Pro-

tocol (SFTP)

sftp://[[<location>]/

To specify a file in the top-level directory of

the server:

sftp://10.0.0.5/example.cfg

Copying to or from

stack member

Flash

<hostname>-<stack_ID>/flash:[/

][<directory>/]

<stack_member_filename>

To specify a file in the configs directory on

member 2 of a stack named vcstack:

vcstack-2/flash:/configs/

example.cfg

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 6.13

The URL can include characters from up to four categories. The URL categories are:

1. uppercase letters: A to Z

2. lowercase letters: a to z

3. digits: 0 to 9

4. special symbols: all printable ASCII characters not included in the previous three

categories. Including the following characters:

« -

« /

« .

« _

« @

« "

« '

« *

« :

« ~

« ?

Do not use spaces or parentheses within filenames. Use hyphens or underlines instead.

Copying Files

To copy files, use the copy commands. These commands allow you to copy files:

■between different memory types attached to your device. Use the command:

See “Copying within a filesystem” and “” for further details.

■across a serial connection using ZMODEM. Use the command:

See “Copying with ZMODEM” for further details.

awplus# copy <local-source> <local-destination> <filename>

awplus# copy zmodem

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

6.14 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

■from your device onto a remote device, or to your device from a remote device. To

copy a file across an interface with IP configured, use the command:

To copy files across these interfaces you can use the following protocols:

« “Copying with Hypertext Transfer Protocol (HTTP)”

« “Copying with Trivial File Transfer Protocol (TFTP)”

« “Copying with Secure Copy (SCP)”

« “Copying with SSH File Transfer Protocol (SFTP)”

Copying within a filesystem

Within a directory To copy a file within the same directory, enter Privileged Exec mode and enter the

command:

If the file already exists, the switch asks whether to overwrite it, with a message like this:

To overwrite, press the “y” key then the Enter key.

Between

directories

To copy a file to another directory within the same filesystem, enter the command:

The / after the directory name is required. Otherwise the switch displays an error

(“37: Destination file is a directory”).

The switch then prompts you for the destination filename. To give the copy a new name,

type the name at the prompt. You can include directory names in the path.

To use the same filename as the original, press the Enter key (do not press the “y” key—

that names the copy “y”).

Example To put a copy of example.cfg into the example directory, enter the command:

The prompt and messages look like this:

awplus# copy SOURCE-URL DESTINATION-URL

awplus# copy <source-filename> <destination-filename>

Overwrite flash:/example.cfg? (y/n)[n]:

awplus# copy <source-filename> <directory-name>

awplus# copy example.cfg example/

Enter destination file name [example.cfg]:

Copying from source file, please wait...

Copying to destination file, please wait...

0: Successful operation

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 6.15

Copying to and from NVS or a USB storage device

In a stacked environment you can only access flash and nvs using the stack member

file path. To access a USB storage device on a backup stack member, use the remote-login

command on page 82.5.

To copy between filesystems, you need to specify the filesystem prefix (nvs: or usb:).

For example, to copy from Flash to NVS when your current directory is the top-level Flash

directory, enter Privileged Exec mode and enter the command:

For example, to copy from Flash to the USB storage device when your current directory is

the top-level Flash directory, enter Privileged Exec mode and enter the command:

The switch prompts you for the filename, as described in the previous section.

To copy from NVS to Flash when your current directory is the top-level Flash directory,

enter the command:

Example To copy the file “example.txt” from the directory called “example” in NVS, to the top level

of Flash, enter the command:

awplus# copy <source-filename> nvs:sd:

awplus# copy <source-filename> usb:

awplus# copy nvs:<source-filename> <destination-filename>

awplus# copy nvs:example/example.txt example.txt

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

6.16 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Copying with ZMODEM

ZMODEM allows you to copy files from a network host over an asynchronous port. Use the

command:

to open Minicom and transfer a file. Alternatively you can specify the file name within the

command:

For example, to copy the file “july.cfg” from Flash memory using ZMODEM, use the

command:

Copying with Hypertext Transfer Protocol (HTTP)

You device has a built-in HTTP client. The HTTP client enables the device to act as a

browser by sending HTTP “get” or “post” requests to an HTTP server. The client is enabled

by default.

For example, to load the file “bob.key” onto Flash from the security directory on the web

server at www.company.com, use the command:

Copying with Trivial File Transfer Protocol (TFTP)

TFTP runs over User Datagram Protocol (UDP). It is simpler and faster than FTP but has

minimal capability, such as no provisions for user authentication.

To copy a file from a TFTP server to Flash memory, enter Privileged Exec mode and enter

the command:

The switch prompts you for the:

■TFTP server hostname (you can enter its IP address instead)

■source filename on the TFTP server

■destination filename in Flash on the switch

To copy a file from Flash to a TFTP server, enter the command:

Follow the prompts for source filename, server, and destination filename.

awplus# copy zmodem

awplus# copy SOURCE-URL zmodem

awplus# copy flash:/july.cfg zmodem

awplus# copy http://www.company.com/security/bob.key

flash:/bob.key

awplus# copy tftp flash

Note You can specify the server and filename in the command instead of waiting for

prompts. Use a format like the following:

copy tftp://172.1.1.1/example.cfg flash

awplus# copy flash tftp

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 6.17

If the file is not in the top level of the TFTP server, include the path as part of the filename.

Example To copy example.cfg to the TFTP server at

72.

, enter the command:

The prompts, responses, and messages look like this:

To load the file “bob.key” from a TFTP server, where the file is in the folder “security”, use

the command:

Copying with Secure Copy (SCP)

Secure Copy (SCP) provides a secure way to copy files to and from a remote device using

SSH. The AlliedWare PlusTM OS includes both a SSH server and a SSH client. You must

enable the SSH server before your device accepts connections from SCP clients. See the

Chapter 52, Secure Shell (SSH) Introduction for more information.

For example, to load the file “beth.key” onto Flash from the key directory on a remote SSH

server at 10.10.0.12, using the username “bob”, use the command:

Copying with SSH File Transfer Protocol (SFTP)

SSH File Transfer Protocol (SFTP) provides a secure way to copy files onto your device from

a remote device. The AlliedWare PlusTM OS includes both a SSH server and a SSH client.

SFTP provides additional features from SCP, such as allowing you to manipulate the

remote files, and halt or resume file transfers without closing the session.

For example, to load the file “rei.cfg” onto Flash memory from the remote server at

10.0.0.5, use the command:

Copying from a Server to Running Configuration

Use the copy tftp variant of the copy running-config command on page 7.14 to load a

configuration file from a server to the running configuration of the switch.

The configuration will be added to the running configuration as if the commands were

typed in the command line interface.

awplus# copy flash tftp

Enter source file name []:example.cfg

Enter destination host name []:172.1.1.1

Enter destination file name [example.cfg]:

Copying from source file, please wait...

Copying to destination file, please wait...

0: Successful operation

awplus# copy tftp://security/bob.key flash:/bob.key

awplus# copy scp://bob@10.10.0.12/key/beth.key

flash:/beth.key

awplus# copy sftp://10.0.0.5/rei.cfg flash:/rei.cfg

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

6.18 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

The resulting configuration file will be a combination of the previous running

configuration and the loaded configuration file. The loaded configuration file has

precedence.

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 6.19

The Autoboot Feature

The Autoboot feature enables your switch to automatically load a specific release file and/

or configuration file from external media, such as USB storage device, into Flash memory,

providing there is enough free space available.

If there is not enough free space, the Autoboot feature will exit and booting will revert to

what was previously set by the CLI. This feature is enabled only the first time the device is

powered up in the field. Subsequently, the Autoboot feature is disabled by default.

The Autoboot feature minimizes network downtime by avoiding the need for manual

configuration of a replacement device.

If you use prepared external media for the first time boot, the Autoboot feature gives you

the ability to easily ensure the device boots with your desired release and configuration

files. You must prepare the external media for this purpose using an initiation file,

autoboot.txt, and accompanying release and configuration files.

Use the create autoboot command to create an autoboot.txt file on external media.

This command will automatically ensure that the keys and values that are expected in this

file are correct. After the file is created the command will copy the current release and

configuration files across to the external media. The autoboot.txt file is read/writable

by any desktop operating system currently supported by the AlliedWare Plus™ Operating

System. Note that the external media file system is not case sensitive.

When the Autoboot feature is enabled, the device on boot-up:

■checks for a special file called autoboot.txt on external media, and if this file

exists,

■checks in the file for the “key=value” pair

“Copy_from_external_media_enabled=yes”, and if this enable flag is set,

■loads the release file and/or configuration file from external media.

An example of a valid autoboot.txt file is shown in Figure 6-1 below.

Figure 6-1: Example autoboot.txt file

We recommend that no directories are present on external media used to hold the

autoboot.txt file. In addition, large numbers of files on external media may slow the

booting process.

; J Smith, GS948MX, 14 May 2015

[AlliedWare Plus]

Copy_from_external_media_enabled=yes

Boot_Release=GS900-5.4.4E-1.1.rel

Boot_Config=network1.cfg

Note The Autoboot feature is not supported in a stacked configuration.

Do not remove external media part way through the copy process as this may

leave the device in an unstable state.

Configuration files placed on external media reduce security. Therefore, ensure

adequate security precautions are taken with external media holding

configuration files.

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

6.20 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Restoring a Switch Using Autoboot from External

Media

The example below describes the sequence of events when a switch in the field fails and is

restored using this feature:

1. Using the create autoboot command, a network engineer has previously manually

created a restore external media device, such as a USB storage device. The external

media device contains the following components:

« An autoboot.txt file with required contents

« An appropriate release file

« A configuration file

2. A switch fails in the field.

3. A replacement switch of same model is installed.

4. The previously created external media device is placed into the replacement switch.

5. The switch powers up using its pre-installed release if present. It automatically checks

the external media device for the autoboot.txt file.

6. The switch finds a valid autoboot.txt file on the external media device, with the

value “Copy_from_external_media_enabled” set. The release file and configuration

file both exist on the external media device.

7. The MD5sum of pre-installed Flash release file is compared to the MD5sum of the

release file stored in the external media device. If they do not match, because the

release file in the replacement switch is either missing or different, then the release is

restored from the external media device. If the release files already match, then the

release file is not copied from the external media device.

8. The MD5sum of the Flash configuration file default.cfg (if pre-installed in the

replacement switch) is compared to the MD5sum of the configuration file stored in

the external media device. If they do not match, because the configuration file in the

replacement switch is either missing or different, then the configuration file is

restored from the external media device. If the configuration files already match, then

the configuration file is not copied from the external media device.

9. The memory space available in the switch Flash is checked to ensure the release and

configuration files stored in the external media device will fit. If there is not enough

space the Autoboot feature will exit.

10. The release file and configuration files are automatically copied from the external

media device to switch Flash memory. The switch release and configuration files are

updated to contain the appropriate names.

11. The switch is automatically rebooted.

12. The replacement switch is now running the restored release and configuration files.

Subsequent reboots are based on the restored release and configuration files stored

in the switch Flash memory.

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 6.21

13. If you want to Autoboot from external media on this specific switch in the future, you

must now manually enable the Autoboot feature in the configuration menu via the

autoboot enable command. This command resets the enable flag stored internally in

the switch NVS memory.

Creating and Managing Files

Software Reference for GS900MX/MPX Series Switches

6.22 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Configure Autoboot

This section describes the commands used to configure the Autoboot feature.

Table 6-1: Configuration procedures for the Autoboot feature

Create an Autoboot file (autoboot.txt)

awplus#

create autoboot [usb] Create an autoboot.txt file on external media.

Enable the Autoboot feature

awplus#

configure terminal Enter Global Configuration mode.

awplus(config)#

autoboot enable The Autoboot feature is enabled by default the first time

the device is powered up in the field. Use this command to

enable the feature subsequently.

Disable the Autoboot feature

awplus(config)#

no autoboot enable Use this command to disable the Autoboot feature.

Display Autoboot configuration and status

awplus#

show autoboot Display detailed information about the current Autoboot

configuration and status.

awplus#

show boot Display the status of the Autoboot feature; either enabled

or disabled.

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.1

Chapter 7: File Management Commands

Introduction ...........................................................................................................................................7.3

URL Syntax and Keyword Usage..............................................................................................7.3

Command List .......................................................................................................................................7.5

autoboot enable...................................................................................................................................7.5

boot config-file .....................................................................................................................................7.6

boot config-file backup......................................................................................................................7.8

boot system............................................................................................................................................7.9

boot system backup......................................................................................................................... 7.11

cd............................................................................................................................................................. 7.12

copy current-software..................................................................................................................... 7.12

copy debug ......................................................................................................................................... 7.13

copy running-config ........................................................................................................................ 7.14

copy startup-config.......................................................................................................................... 7.15

copy (URL)............................................................................................................................................ 7.16

copy zmodem..................................................................................................................................... 7.18

create autoboot................................................................................................................................. 7.19

delete..................................................................................................................................................... 7.20

delete debug ...................................................................................................................................... 7.21

dir............................................................................................................................................................ 7.22

edit.......................................................................................................................................................... 7.24

edit (URL).............................................................................................................................................. 7.25

erase startup-config ......................................................................................................................... 7.26

mkdir...................................................................................................................................................... 7.27

move ...................................................................................................................................................... 7.28

move debug........................................................................................................................................ 7.29

pwd ........................................................................................................................................................ 7.30

rmdir ...................................................................................................................................................... 7.31

show autoboot................................................................................................................................... 7.32

show boot............................................................................................................................................ 7.33

show file................................................................................................................................................ 7.35

show file systems .............................................................................................................................. 7.36

show running-config ....................................................................................................................... 7.38

show running-config access-list .................................................................................................. 7.40

show running-config as-path access-list.................................................................................. 7.41

show running-config dhcp............................................................................................................ 7.42

show running-config full................................................................................................................ 7.43

show running-config interface..................................................................................................... 7.44

show running-config ip route ...................................................................................................... 7.46

show running-config ipv6 access-list ........................................................................................ 7.47

show running-config ipv6 route..................................................................................................7.48

show running-config key chain ...................................................................................................7.49

show running-config lldp............................................................................................................... 7.50

show running-config power-inline............................................................................................. 7.51

show running-config route-map................................................................................................. 7.52

show running-config router.......................................................................................................... 7.53

show running-config router-id .................................................................................................... 7.54

show running-config security-password.................................................................................. 7.55

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show startup-config......................................................................................................................... 7.56

show version....................................................................................................................................... 7.57

write file................................................................................................................................................ 7.58

write memory..................................................................................................................................... 7.58

write terminal ..................................................................................................................................... 7.58

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.3

Introduction

This chapter provides an alphabetical reference of AlliedWare PlusTM OS file management

commands.

URL Syntax and Keyword Usage

Many of the commands in this chapter use the placeholder “URL” to represent the name

and location of the file that you want to act on. The following table explains the syntax of

this URL for each different type of file location.

Valid characters

The URL can include characters from up to four categories. The URL categories are:

1. uppercase letters: A to Z

2. lowercase letters: a to z

3. digits: 0 to 9

When you copy a

file... Use this syntax: Example:

Copying in local

Flash memory

flash:[/][<directory>/]<filename>To specify a file in the configs directory in

Flash:

flash:configs/example.cfg

Copying to or from

a USB storage

device

usb:[/][<directory>/]<filename>To specify a file in the top-level directory of

the USB stick:

usb:example.cfg

Copying with

Hypertext Trans-

fer Protocol

(HTTP)

http://

[[<username>:<password>]@] {<host

name>|<host-ip>}[/<filepath>]/

To specify a file in the configs directory on

the server:

http://www.company.com/configs/

example.cfg

Copying with

Trivial File Trans-

fer Protocol

(TFTP)

tftp://[[<location>]/

To specify a file in the top-level directory of

the server:

tftp://172.1.1.1/example.cfg

Copying with

Secure Copy

(SCP)

scp://<username>@<location>[/

<directory>][/<filename>]

To specify a file in the configs directory on

the server, logging on as user “bob”:

e.g. scp://bob@10.10.0.12/

configs/example.cfg

Copying with SSH

File Transfer Pro-

tocol (SFTP)

sftp://[[<location>]/

To specify a file in the top-level directory of

the server:

sftp://10.0.0.5/example.cfg

Copying to or from

stack member

Flash

<hostname>-<stack_ID>/flash:[/

][<directory>/]

<stack_member_filename>

To specify a file in the configs directory on

member 2 of a stack named vcstack:

vcstack-2/flash:/configs/

example.cfg

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.4 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

4. special symbols: all printable ASCII characters not included in the previous three

categories. Including the following characters:

« -

« /

« .

« _

« @

« "

« '

« *

« :

« ~

« ?

Do not use spaces or parentheses within filenames. Use hyphens or underscores instead.

Syntax for directory listings

A leading slash (/) indicates the root of the current filesystem location.

In commands where you need to specify the local filesystem’s Flash base directory, you

may use flash or flash: or flash:/. For example, these commands are all the same:

■dir flash

■dir flash:

■dir flash:/

Similarly, you can specify the USB storage device base directory with usb or usb: or usb:/

You cannot name a directory or subdirectory flash, nvs, usb, card, tftp, scp, sftp or http.

These keywords are reserved for tab completion when using various file commands.

In a stacked environment you can only access flash and nvs using the stack member

filepath (e.g. dir awplus-2/flash:/). To access a USB storage device on a backup

stack member, use the remote-login command on page 82.5.

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.5

Command List

autoboot enable

This command enables the device to restore a release file and/or a configuration file from

external media, such as a USB storage device.

When the Autoboot feature is enabled, the device looks for a special file called

autoboot.txt on the external media. If this file exists, the device will check the key and

values in the file and recover the device with a new release file and/or configuration file

from the external media. An example of a valid autoboot.txt file is shown in

Figure 7-1 below.

Figure 7-1: Example autoboot.txt file

Use the no variant of this command to disable the Autoboot feature.

Syntax autoboot enable

no autoboot enable

Default The Autoboot feature operates the first time the device is powered up in the field, after

which the feature is disabled by default.

Mode Global Configuration

Example To enable the Autoboot feature, use the command:

To disable the Autoboot feature, use the command:

Related Commands create autoboot

show autoboot

show boot

[AlliedWare Plus]

Copy_from_external_media_enabled=yes

Boot_Release=GS900-5.4.4E-1.1.rel

Boot_Config=network1.cfg

Note This command is not supported in a stacked configuration.

awplus# configure terminal

awplus(config)# autoboot enable

awplus# configure terminal

awplus(config)# no autoboot enable

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.6 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

boot config-file

Use this command to set the configuration file to use during the next boot cycle.

Use the no variant of this command to remove the configuration file.

Syntax boot config-file <filepath-filename>

no boot config-file

Mode Global Configuration

Usage You can only specify that the configuration file is on a USB storage device if there is a

backup configuration file already specified in Flash. If you attempt to set the configuration

file on a USB storage device and a backup configuration file is not specified in Flash, the

following error message is displayed:

For an explanation of the configuration fallback order, see “The Configuration File

Fallback Order” on page 6.10.

Examples To run the configuration file branch.cfg stored on the switch’s Flash filesystem the next

time the device boots up, use the commands:

To remove the configuration file branch.cfg stored on the switch’s Flash filesystem the

next time the device boots up, use the commands:

To run the configuration file branch.cfg stored on the switch’s USB storage device

filesystem the next time the device boots up, use the commands:

Parameter Description

<filepath-filename> Filepath and name of a configuration file.

The specified configuration file must exist in the specified

filesystem.

Valid configuration files must have a .cfg extension.

% Backup configuration files must be stored in the flash

filesystem

awplus# configure terminal

awplus(config)# boot config-file flash:/branch.cfg

awplus# configure terminal

awplus(config)# no boot config-file flash:/branch.cfg

awplus# configure terminal

awplus(config)# boot config-file usb:/branch.cfg

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.7

To remove the configuration file branch.cfg stored on the switch’s USB storage device

filesystem the next time the device boots up, use the commands:

Related Commands boot config-file backup

boot system

boot system backup

show boot

awplus# configure terminal

awplus(config)# no boot config-file usb:/branch.cfg

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.8 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

boot config-file backup

Use this command to set a backup configuration file to use if the main configuration file

cannot be accessed.

Use the no variant of this command to remove the backup configuration file.

Syntax boot config-file backup <filepath-filename>

no boot config-file backup

Mode Global Configuration

Usage For an explanation of the configuration fallback order, see “The Configuration File

Fallback Order” on page 6.10.

Examples To set the configuration file backup.cfg as the backup to the main configuration file,

use the commands:

To remove the configuration file backup.cfg as the backup to the main configuration

file, use the commands:

Related Commands boot config-file

boot system

boot system backup

show boot

Parameter Description

<filepath-filename> Filepath and name of a backup configuration file.

Backup configuration files must be in the Flash filesystem.

Valid backup configuration files must have a .cfg

extension.

backup The specified file is a backup configuration file.

awplus# configure terminal

awplus(config)# boot config-file backup flash:/backup.cfg

awplus# configure terminal

awplus(config)# no boot config-file backup flash:/backup.cfg

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.9

boot system

Use this command to set the release file to load during the next boot cycle.

Use the no variant of this command to remove the release file as the boot file.

Syntax boot system <filepath-filename>

no boot system

Mode Global Configuration

Usage You can only specify that the release file is on a USB storage device if there is a backup

release file already specified in Flash. If you attempt to set the release file on a USB storage

device and a backup release file is not specified in Flash, the following error message is

displayed:

In a VCStack configuration, a release file on a USB storage device is accepted only if a card

is inserted in all stack members and all stack members have a bootloader version that

supports booting from card. If a stack member has a card removed an error message is

displayed. For example, if stack member 2 does not have a card inserted the following

message is displayed:

Examples To run the release file GS900-5.4.4E-1.1.rel stored on the switch’s Flash filesystem the

next time the device boots up, use the commands:

To remove the release file GS900-5.4.4E-1.1.rel stored on the switch’s Flash

filesystem the next time the device boots up, use the commands:

To run the release file GS900-5.4.4E-1.1.rel stored on the switch’s USB storage device

Parameter Description

<filepath-filename> Filepath and name of a release file.

The specified release file must exist and must be stored

in the root directory of the specified filesystem.

Valid release files must have a .rel extension.

% A backup boot image must be set before setting a current boot

image on USB storage device

% Stack member 2 has no card inserted

awplus# configure terminal

awplus(config)# boot system flash:/GS900-5.4.4E-1.1.rel

awplus# configure terminal

awplus(config)# no boot system flash:/GS900-5.4.4E-1.1.rel

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.10 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

filesystem the next time the device boots up, use the commands:

To remove the release file GS900-5.4.4E-1.1.rel stored on the switch’s USB storage

device filesystem the next time the device boots up, use the commands:

In a VCStack configuration, if there is not enough space to synchronize the new release

across the stack, the boot system command has an interactive mode that prompts you to

delete old releases.

Related Commands boot config-file

boot config-file backup

boot system backup

show boot

awplus# configure terminal

awplus(config)# boot system usb:/GS900-5.4.4E-1.1.rel

awplus# configure terminal

awplus(config)# boot system usb:/GS900-5.4.4E-1.1.rel

awplus# configure terminal

awplus(config)# boot system GS900-5.4.4E-1.1.rel

Insufficient flash available on stack member-2 (11370496)

to synchronize file GS900-5.4.4E-1.1.rel (14821895).

List of release files on stack member-2

GS900-5.4.4E-1.1.rel (14822400)

Select files to free up space,

Delete awplus-2/flash:/GS900-5.4.4E-1.1.rel? (y/n)[n]:y

awplus(config)# y

Deleting selected files, please

wait....................................

Successful operation

VCS synchronizing file across the stack, please

wait........................................

File synchronization with stack member-2 successfully completed

[DONE]

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.11

boot system backup

Use this command to set a backup release file to load if the main release file cannot be

loaded.

Use the no variant of this command to remove the backup release file as the backup boot

file.

Syntax boot system backup <filepath-filename>

no boot system backup

Mode Global Configuration

Examples To specify the file GS900-5.4.4E-1.1.rel as the backup to the main release file, use the

commands:

To remove the file GS900-5.4.4E-1.1.rel as the backup to the main release file, use the

commands:

Related Commands boot config-file

boot config-file backup

boot system

show boot

Parameter Description

<filepath-filename> Filepath and name of a backup release file.

Backup release files must be in the Flash filesystem.

Valid release files must have a .rel extension.

backup The specified file is a backup release file.

awplus# configure terminal

awplus(config)# boot system backup flash:/GS900-5.4.4E-1.1.rel

awplus# configure terminal

awplus(config)# no boot system backup flash:/GS900-5.4.4E-

1.1.rel

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.12 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

This command changes the current working directory.

Syntax cd <directory-url>

Mode Privileged Exec

Example To change to the directory called images, use the command:

Related Commands dir

pwd

show file systems

copy current-software

This command copies the AlliedWare PlusTM OS software that the device has booted from,

to a destination file. Specify whether the destination is Flash or USB when saving the

software to the local filesystem.

Syntax copy current-software <destination-url>

Mode Privileged Exec

Example To copy the current software as installed in the working directory with the file name

my-release.rel, use the command:

Related Commands boot system backup

show boot

Parameter Description

<directory-url> URL of the directory.

awplus# cd images

Parameter Description

<destination-url> The URL where you would like the current running-release

saved. This command creates a file if no file exists with the

specified filename. If a file already exists, then the CLI

prompts you before overwriting the file. See “URL Syntax

and Keyword Usage” on page 7.3 for valid URL syntax.

awplus# copy current-software my-release.rel

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.13

copy debug

This command copies a specified debug file to a destination file. Specify whether the

destination is Flash or USB when saving the software to the local filesystem.

Syntax copy debug {<destination-url>|debug|flash|nvs|scp|tftp|usb} {<source-

url>|debug|flash|nvs|scp|tftp|usb}

Mode Privileged Exec

Example To copy debug output to a USB storage device with a filename my-debug, use the

following command:

Output Figure 7-2: CLI prompt after entering the copy debug command

Related Commands delete debug

move debug

Parameter Description

<destination-url> The URL where you would like the debug output saved. See

“URL Syntax and Keyword Usage” on page 7.3 for valid

URL syntax.

<source-url> The URL where the debug output originates. See “URL

Syntax and Keyword Usage” on page 7.3 for valid URL

syntax.

awplus# copy debug usb:mydebug

Enter source file name []:

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.14 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

copy running-config

This command copies the running-config to a destination file, or copies a source file into

the running-config. Commands entered in the running-config do not survive a device

reboot unless they are saved in a configuration file.

Syntax copy <source-url> running-config

copy running-config [<destination-url>]

copy running-config startup-config

Mode Privileged Exec

Examples To copy the running-config into the startup-config, use the command:

To copy the file layer3.cfg into the running-config, use the command:

To use SCP to copy the running-config as current.cfg to the remote server listening

on TCP port 2000, use the command:

Related Commands copy startup-config

write file

write memory

Parameter Description

<source-url>The URL of a configuration file. This must be a valid

configuration file with a .cfg filename extension. Specify

this when you want the script in the file to become the new

running-config. The URL can contain the following

protocols or location words. See “URL Syntax and

Keyword Usage” on page 7.3 for valid URL syntax.

<destination-url>The URL where you would like the current running-config

saved. This command creates a file if no file exists with the

specified filename. If a file already exists, then the CLI

prompts you before overwriting the file. See “URL Syntax

and Keyword Usage” on page 7.3 for valid URL syntax. If

you do not specify a file name, the switch saves the

running-config to a file called default.cfg.

startup-config Copies the running-config into the file set as the current

startup-config file.

awplus# copy running-config startup-config

awplus# copy layer3.cfg running-config

awplus# copy running-config scp://user@server:2000/

config_files/current.cfg

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.15

copy startup-config

This command copies the startup-config script into a destination file, or alternatively

copies a configuration script from a source file into the startup-config file. Specify whether

the destination is Flash or USB when loading from the local filesystem.

Syntax copy <source-url> startup-config

copy startup-config <destination-url>

Mode Privileged Exec

Examples To copy the file Layer3.cfg to the startup-config, use the command:

To copy the startup-config as the file oldconfig.cfg in the current directory, use

the command:

Related Commands copy running-config

Parameter Description

<source-url> The URL of a configuration file. This must be a valid

configuration file with a .cfg filename extension. Specify this

to copy the script in the file into the startup-config file. Note

that this does not make the copied file the new startup file,

so any further changes made in the configuration file are not

added to the startup-config file unless you reuse this

command. See “URL Syntax and Keyword Usage” on

page 7.3 for valid URL syntax.

<destination-url> The destination and filename that you are saving the startup-

config as. This command creates a file if no file exists with the

specified filename. If a file already exists, then the CLI

prompts you before overwriting the file. See “URL Syntax

and Keyword Usage” on page 7.3 for valid URL syntax.

awplus# copy Layer3.cfg startup-config

awplus# copy startup-config oldconfig.cfg

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.16 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

copy (URL)

This command copies a file. This allows you to:

■copy files from your device to a remote device

■copy files from a remote device to your device

■copy files stored on Flash memory to or from a different memory type, such as a USB

storage device

■create two copies of the same file on your device

Syntax copy <source-url> <destination-url>

Mode Privileged Exec

Usage The URL can include characters from up to four categories. The URL categories are:

1. uppercase letters: A to Z

2. lowercase letters: a to z

3. digits: 0 to 9

4. special symbols: all printable ASCII characters not included in the previous three

categories. Including the following characters:

« -

« /

« .

« _

« @

« "

« '

« *

« :

« ~

« ?

Do not use spaces or parentheses within filenames. Use hyphens or underlines instead.

Parameter Description

<source-url> The URL of the source file. See “URL Syntax and Keyword

Usage” on page 7.3 for valid URL syntax.

<destination-url> The URL for the destination file. See “URL Syntax and

Keyword Usage” on page 7.3 for valid URL syntax.

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.17

Examples To use TFTP to copy the file bob.key into the current directory from the remote server at

10.0.0.1, use the command:

To use SFTP to copy the file new.cfg into the current directory from a remote server at

10.0.1.2, use the command:

To use SCP with the username beth to copy the file old.cfg into the directory

config_files on a remote server that is listening on TCP port 2000, use the command:

To copy the file newconfig.cfg onto your device’s Flash from a USB storage device, use

the command:

To copy the file newconfig.cfg to a USB storage device from your device’s Flash, use

the command:

To copy the file config.cfg into the current directory from a USB storage device, and

rename it to configtest.cfg, use the command:

To copy the file config.cfg into the current directory from a remote file server, and

rename it to configtest.cfg, use the command:

To copy the file test.txt from the top level of Flash on stack member 2 to the current

directory in the stack master, use the command:

Note that you must specify either the NVS or Flash filesystem on the (backup) stack

member (flash: in this example).

Related Commands copy zmodem

edit (URL)

show file systems

awplus# copy tftp://10.0.0.1/bob.key bob.key

awplus# copy sftp://10.0.1.2/new.cfg bob.key

awplus# copy scp://beth@serv:2000/config_files/old.cfg old.cfg

awplus# copy usb:/newconfig.cfg flash:/newconfig.cfg

awplus# copy flash:/newconfig.cfg usb:/newconfig.cfg

awplus# copy usb:/config.cfg configtest.cfg

awplus# copy fserver:/config.cfg configtest.cfg

awplus# copy awplus-2/flash:/test.txt test.txt

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.18 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

copy zmodem

This command allows you to copy files using ZMODEM using Minicom. ZMODEM works

over a serial connection and does not need any interfaces configured to do a file transfer.

Syntax copy <source-url> zmodem

copy zmodem

Mode Privileged Exec

Example To copy the local file asuka.key using ZMODEM, use the command:

Related Commands copy (URL)

show file systems

Parameter Description

<source-url> The URL of the source file. See “URL Syntax and Keyword

Usage” on page 7.3 for valid URL syntax.

awplus# copy asuka.key zmodem

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.19

create autoboot

Use this command to create an autoboot.txt file on external media. This command

will automatically ensure that the keys and values that are expected in this file are correct.

After the file is created the create autoboot command will copy the current release and

configuration files across to the external media. The external media is then available to

restore a release file and/or a configuration file to the device.

Syntax create autoboot [usb]

Mode Privileged Exec

Example To create an autoboot.txt file on external media, use the command:

Related Commands autoboot enable

show autoboot

show boot

awplus# create autoboot usb

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.20 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

delete

This command deletes files or directories.

Syntax delete [force] [recursive] <url>

Mode Privileged Exec

Examples To delete the file temp.cfg from the current directory, use the command:

To delete the read-only file one.cfg from the current directory, use the command:

To delete the directory old_configs, which is not empty, use the command:

To delete the directory new_configs, which is not empty, without prompting if any

read-only files are being deleted, use the command:

Related Commands erase startup-config

rmdir

Parameter Description

force Ignore nonexistent filenames and never prompt before deletion.

recursive Remove the contents of directories recursively.

<url>URL of the file to delete. See “URL Syntax and Keyword Usage” on

page 7.3 for valid URL syntax.

awplus# delete temp.cfg

awplus# delete force one.cfg

awplus# delete recursive old_configs

awplus# delete force recursive new_configs

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.21

delete debug

Use this command to delete a specified debug output file.

Syntax delete debug <source-url>

Mode Privileged Exec

Example To delete debug output, use the following command:

Output Figure 7-3: CLI prompt after entering the delete debug command

Related Commands copy debug

move debug

Parameter Description

<source-url> The URL where the debug output originates. See “URL Syntax

and Keyword Usage” on page 7.3 for valid URL syntax.

awplus# delete debug

Enter source file name []:

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.22 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

dir

This command lists the files on a filesystem. If no directory or file is specified then this

command lists the files in the current working directory.

Syntax dir [all] [recursive] [sort [reverse] [name|size|time]] [<url>|debug|

flash|nvs|usb]

Mode Privileged Exec

Usage In a stacked environment you can use the CLI on a stack master to access filesystems that

are located on another stack member. Refer to the URL Syntax and Keyword Usage.

Examples To list the files in the current working directory, use the command:

To list the non-hidden files in the root of the Flash filesystem, use the command:

To list all the files in the root of the Flash filesystem, use the command:

To list recursively the files in the Flash filesystem, use the command:

Parameter Description

all List all files.

recursive List the contents of directories recursively.

sort Sort directory listing.

reverse Sort using reverse order.

name Sort by name.

size Sort by size.

time Sort by modification time (default).

<url>URL of the directory or file. If no directory or file is specified,

then this command lists the files in the current working

directory.

debug Debug root directory

flash Flash memory root directory

nvs NVS memory root directory

usb USB storage device root directory

awplus# dir

awplus# dir flash

awplus# dir all flash:

awplus# dir recursive flash:

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.23

To list the files in alphabetical order, use the command:

To list the files by size, smallest to largest, use the command:

To sort the files by modification time, oldest to newest, use the command:

To list the files within the Flash filesystem for stack member 2, use the command:

Note that you must specify the filesystem on the stack member (flash in this example).

Related Commands cd

pwd

awplus# dir sort name

awplus# dir sort reverse size

awplus# dir sort reverse time

awplus# dir awplus-2/flash:/

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.24 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

edit

This command opens a text file in the AlliedWare PlusTM text editor. Once opened you can

use the editor to alter to the file.

If a filename is specified and it already exists, then the editor opens it in the text editor.

If no filename is specified, the editor prompts you for one when you exit it.

Before starting the editor make sure your terminal, terminal emulation program, or Telnet

client is 100% compatible with a VT100 terminal. The editor uses VT100 control sequences

to display text on the terminal.

For more information about using the editor, including control sequences, see “Using the

Editor” on page 6.6.

Syntax edit [<filename>]

Mode Privileged Exec

Examples To create and edit a new text file, use the command:

To edit the existing configuration file myconfig.cfg stored on your device’s Flash

memory, use the command:

Related Commands edit (URL)

show file

Parameter Description

<filename> Name of a file in the local Flash filesystem.

awplus# edit

awplus# edit myconfig.cfg

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.25

edit (URL)

This command opens a remote text file as read-only in the AlliedWare PlusTM text editor.

Before starting the editor make sure your terminal, terminal emulation program, or Telnet

client is 100% compatible with a VT100 terminal. The editor uses VT100 control sequences

to display text on the terminal.

Syntax edit <url>

Mode Privileged Exec

Usage The URL can include characters from up to four categories. The URL categories are:

1. uppercase letters: A to Z

2. lowercase letters: a to z

3. digits: 0 to 9

4. special symbols: all printable ASCII characters not included in the previous three

categories. Including the following characters:

« -

« /

« .

« _

« @

« "

« '

« *

« :

« ~

« ?

Do not use spaces or parentheses within filenames. Use hyphens or underlines instead.

Example To view the file bob.key stored in the security directory of a TFTP server, use the

command:

Related Commands copy (URL)

edit

show file

Parameter Description

<url> The URL of the remote file. See “URL Syntax and Keyword

Usage” on page 7.3 for valid URL syntax.

awplus# edit tftp://security/bob.key

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.26 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

erase startup-config

This command deletes the file that is set as the startup-config file, which is the

configuration file that the system runs when it boots up.

At the next restart, the device loads the default configuration file, default.cfg. If default.cfg

no longer exists, then the device loads with the factory default configuration. This

provides a mechanism for you to return the device to the factory default settings.

Syntax erase startup-config

Mode Privileged Exec

Example To delete the file currently set as the startup-config, use the command:

Related Commands boot config-file backup

copy running-config

copy startup-config

show boot

awplus# erase startup-config

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.27

mkdir

This command makes a new directory.

Syntax mkdir <url>

Mode Privileged Exec

Usage You cannot name a directory or subdirectory flash, nvs, usb, card, tftp, scp, sftp or http.

These keywords are reserved for tab completion when using various file commands.

Example To make a new directory called images in the current directory, use the command:

Related Commands cd

dir

pwd

Parameter Description

<url> URL of the directory that you are creating.

awplus# mkdir images

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.28 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

move

This command renames or moves a file.

Syntax move <source-url> <destination-url>

Mode Privileged Exec

Examples To rename the file temp.cfg to startup.cfg, use the command:

To move the file temp.cfg from the root of the Flash filesystem to the directory

myconfigs, use the command:

Related Commands delete

edit

show file

show file systems

Parameter Description

<source-url> The URL of the source file. See “URL Syntax and Keyword

Usage” on page 7.3 for valid URL syntax.

<destination-url> The URL of the destination file. See “URL Syntax and

Keyword Usage” on page 7.3 for valid URL syntax.

awplus# move temp.cfg startup.cfg

awplus# move temp.cfg myconfigs/temp.cfg

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.29

move debug

This command moves a specified debug file to a destination debug file.

Specify whether the destination is Flash or USB when saving the software to the local

filesystem.

Syntax move debug {<destination-url>|debug|flash|nvs|usb} {<source-url>|

debug|flash|nvs|usb}

Mode Privileged Exec

Example To move debug output onto a USB storage device with a filename my-debug, use the

following command:

Output Figure 7-4: CLI prompt after entering the move debug command

Related Commands copy debug

delete debug

Parameter Description

<destination-url> The URL where you would like the debug output moved to.

See “URL Syntax and Keyword Usage” on page 7.3 for

valid URL syntax.

<source-url> The URL where the debug output originates. See “URL

Syntax and Keyword Usage” on page 7.3 for valid URL

syntax.

awplus# move debug usb:my-debug

Enter source file name []:

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.30 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

pwd

This command prints the current working directory.

Syntax pwd

Mode Privileged Exec

Example To print the current working directory, use the command:

Related Commands cd

awplus# pwd

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.31

rmdir

This command removes a directory. The directory must be empty for the command to

work unless the optional force keyword is used to remove all subdirectories or files in a

directory.

Syntax rmdir [force] <url>

Mode Privileged Exec

Usage In a stacked environment you can use the CLI on a stack master to access filesystems that

are located on another stack member. Refer to the URL Syntax and Keyword Usage.

Examples To remove the directory images from the top level of the Flash filesystem, use the

command:

To force the removal of directory level1 containing subdirectory level2, use the

command:

To remove a directory called test from the top level of the Flash filesystem, in stack

member 3, use the command:

Note that you must specify the filesystem, (“flash:” in this example).

Related Commands cd

dir

mkdir

pwd

Parameter Description

force Optional keyword that allows you to delete any directories

that are not empty and may contain files or subdirectories.

<url>The URL of the directory.

awplus# rmdir flash:/images

awplus# mkdir level1

awplus# mkdir level1/level2

awplus# rmdir force level1

awplus# rmdir awplus-3/flash:/test

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.32 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show autoboot

This command displays the Autoboot configuration and status.

Syntax show autoboot

Mode Privileged Exec

Example To show the Autoboot configuration and status, use the command:

Output Figure 7-5: Example output from the show autoboot command

Figure 7-6: Example output from the show autoboot command when an external

media source is not present

Related Commands autoboot enable

create autoboot

show boot

awplus# show autoboot

awplus#show autoboot

Autoboot configuration

--------------------------------------------------------------------------------

Autoboot status : enabled

USB file autoboot.txt exists : yes

Restore information on USB

Autoboot enable in autoboot.txt : yes

Restore release file : GS900-5.4.4E-1.1.rel (file exists)

Restore configuration file : network_1.cfg (file exists)

awplus#show autoboot

Autoboot configuration

--------------------------------------------------------------------------------

Autoboot status : enabled

External media source : USB not found.

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.33

show boot

This command displays the current boot configuration.

Syntax show boot

Mode Privileged Exec

Example To show the current boot configuration, use the command:

Output Figure 7-7: Example output from the show boot command with the current boot

config set on a USB storage device

Figure 7-8: Example output from the show boot command

Table 7-1: Parameters in the output of the show boot command

awplus# show boot

awplus#show boot

Boot configuration

----------------------------------------------------------------

Current software : GS900-5.4.4E-1.1.rel

Current boot image : usb:/GS900-5.4.4E.rel

Backup boot image : flash:/GS900-5.4.4E.rel

Default boot config: flash:/default.cfg

Current boot config: usb:/my.cfg (file exists)

Backup boot config: flash:/backup.cfg (file not found)

Autoboot status : enabled

awplus#show boot

Boot configuration

----------------------------------------------------------------

Current software : GS900-5.4.4E-1.1.rel

Current boot image : flash:/GS900-5.4.4E.rel

Backup boot image : flash:/GS900-5.4.4E.rel

Default boot config: flash:/default.cfg

Current boot config: flash:/my.cfg (file exists)

Backup boot config: flash:/backup.cfg (file not found)

Autoboot status : enabled

Parameter Description

Current software The current software release that the device is using.

Current boot image The boot image currently configured for use during the

next boot cycle.

Backup boot image The boot image to use during the next boot cycle if the

device cannot load the main image.

Default boot config The default startup configuration file. The device loads

this configuration script if no file is set as the startup-

config file.

Current boot config The configuration file currently configured as the

startup-config file. The device loads this configuration file

during the next boot cycle if this file exists.

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.34 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Related Commands autoboot enable

boot config-file backup

boot system backup

show autoboot

Backup boot config The configuration file to use during the next boot cycle if

the main configuration file cannot be loaded.

Autoboot status The status of the Autoboot feature; either enabled or

disabled.

Parameter Description

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.35

show file

This command displays the contents of a specified file.

Syntax show file {<filename>|<url>}

Mode Privileged Exec

Example To display the contents of the file oldconfig.cfg, which is in the current directory, use

the command:

Related Commands edit

edit (URL)

show file systems

Parameter Description

<filename> Name of a file on the local Flash filesystem.

<url> URL of a file.

awplus# show file oldconfig.cfg

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.36 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show file systems

This command lists the filesystems and their utilization information where appropriate.

If this command is entered on the stack master, it will list the filesystems for all the stack

members. A stack member heading is displayed to distinguish the different lists shown for

each stack member.

Syntax show file systems

Mode Privileged Exec

Examples To display the filesystems for either a standalone device, or a complete stack, use the

command:

Output Figure 7-9: Example output from the show file systems command

awplus# show file systems

awplus#show file systems

Size(b) Free(b) Type Flags Prefixes S/D/V Lcl/Ntwk Avail

-------------------------------------------------------------------

63.0M 29.4M flash rw flash: static local Y

- - system rw system: virtual local -

10.0M 9.9M debug rw debug: static local Y

499.0K 404.0K nvs rw nvs: static local Y

- - usbstick rw usb: dynamic local N

- - tftp rw tftp: - network -

- - scp rw scp: - network -

- - sftp ro sftp: - network -

- - http ro http: - network -

- - rsync rw rsync: - network -

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.37

Related Commands edit

edit (URL)

show file

Table 7-2: Parameters in the output of the show file systems command

Parameter Description

Size (B)

Available

The total memory available to this filesystem. The units are given

after the value and are M for Megabytes or k for kilobytes.

Free (B) The total memory free within this filesystem. The units are given

after the value and are M for Megabytes or k for kilobytes.

Type The memory type used for this filesystem:

flash, system, nvs, usbstick, tftp, scp, sftp, or http.

Flags The file setting options: rw (read write), ro (read only).

Prefixes The prefixes used when entering commands to access the

filesystems:

flash, system, nvs, usb, tftp, scp, sftp, or http.

S/V/D The memory type: static, virtual, dynamic.

Lcl / Ntwk Whether the memory is located locally or via a network connection.

Avail Whether the memory is accessible: Y (yes), N (no), - (not

appropriate)

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.38 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show running-config

This command displays the current configuration of the device. The output includes all

non-default configuration; default settings are not displayed.

You can control the output in any one of the following ways:

■To display only lines that contain a particular word, enter | include word after the

command

■To start the display at the first line that contains a particular word, enter | begin word

after the command

■To save the output to a file, enter > filename after the command

For more information, see “Controlling “show” Command Output” on page 1.35.

Syntax show running-config

Mode Privileged Exec and Global Configuration

Example To display the current dynamic configuration of your device, use the command:

awplus# show running-config

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.39

Output Figure 7-10: Example output from the show running-config command

Related Commands copy running-config

show running-config access-list

GS900>ena

GS900#show running-config

service password-encryption

hostname GS900

no banner motd

username manager privilege 15 password 8 $1$bJoVec4D$JwOJGPr7YqoExA0GVasdE0

no service ssh

platform hwfilter-size ipv4-limited-ipv6

service telnet

service http

no clock timezone

snmp-server

snmp-server enable trap dhcpsnooping

aaa authentication enable default local

aaa authentication login default local

stack virtual-mac

stack virtual-chassis-id 746

ip domain-lookup

no service dhcp-server

spanning-tree mode rstp

auth-web-server gateway 192.168.1.1 vlan 1

latform l3-hashing-algorithm crc16l

mls qos enable

policy-map pmap1

class default

switch 1 provision GS948MX

interface port1.0.1-1.0.26

switchport

switchport mode access

interface vlan1

ip address 192.168.1.1/24

line con 0

line vty 0 4

end

GS900#

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.40 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show running-config access-list

Use this command to show the running system status and configuration details for access-

list.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show running-config access-list

Mode Privileged Exec and Global Configuration

Example To display the running system status and configuration details for access-list, use the

command:

Output Figure 7-11: Example output from the show running-config access-list command

Related Commands copy running-config

show running-config

awplus# show running-config access-list

access-list abc remark annai

access-list abc deny any

access-list abd deny any

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.41

show running-config as-path access-list

Use this command to show the running system status and configuration details for as-

path access-list.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show running-config as-path access-list

Mode Privileged Exec and Global Configuration

Example To display the running system status and configuration details for as-path access-list, use

the command:

Output Figure 7-12: Example output from the show running-config as-path access-list

command

Related Commands copy running-config

show running-config

awplus# show running-config as-path access-list

ip as-path access-list wer permit knsmk

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.42 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show running-config dhcp

Use this command to display the running configuration for DHCP server, DHCP snooping,

and DHCP relay.

Syntax show running-config dhcp

Mode Privileged Exec and Global Configuration

Example To display to display the running configuration for DHCP server, DHCP snooping, and

DHCP relay:

Output Figure 7-13: Example output from the show running-config dhcp command

Related Commands copy running-config

show running-config

awplus# show running-config dhcp

#show running-config dhcp

no service dhcp-server

service dhcp-snooping

interface port1.0.1

ip dhcp snooping trust

interface port1.0.3

ip dhcp snooping max-bindings 25

access-group dhcpsnooping

interface port1.0.4

ip dhcp snooping max-bindings 25

access-group dhcpsnooping

interface po1

ip dhcp snooping max-bindings 25

arp security violation log

interface sa1

ip dhcp snooping max-bindings 25

access-group dhcpsnooping

arp security violation log

interface vlan100

ip dhcp snooping

arp security

interface vlan200

ip dhcp snooping

arp security

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.43

show running-config full

Use this command to show the complete status and configuration of the running system.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show running-config full

Mode Privileged Exec and Global Configuration

Example To display the complete status and configuration of the running system, use the

command:

Related Commands copy running-config

show running-config

awplus# show running-config full

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.44 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show running-config interface

This command displays the current configuration of one or more interfaces on the switch.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show running-config interface [<interface-list>] [dot1x|ip igmp|lacp|

mstp|rip|rstp|stp]

Mode Privileged Exec and Global Configuration

Examples To display the current running configuration of your switch for ports 1 to 4, use the

command:

Parameter Description

<interface-list>The interfaces or ports to display information about. An

interface-list can be:

■a continuous range of interfaces, ports, static channel

groups or dynamic (LACP) channel groups separated by

a hyphen,

e.g. vlan2-8,orport1.0.1-1.0.4,orsa1-2, or

po1-2

■a comma-separated list of the above,

e.g. port1.0.1,port1.0.4-1.0.6. Do not mix

interface types in a list

The specified interfaces must exist.

dot1x Displays running configuration for 802.1X port

authentication for the specified interfaces.

lacp Displays running configuration for LACP (Link Aggregation

Control Protocol) for the specified interfaces.

ip igmp Displays running configuration for IGMP (Internet Group

Management Protocol) for the specified interfaces.

ip multicast Displays running configuration for general multicast

settings for the specified interfaces.

mstp Displays running configuration for MSTP (Multiple

Spanning Tree Protocol) for the specified interfaces.

rip Displays running configuration for RIP (Routing Information

Protocol) for the specified interfaces.

rstp Displays running configuration for RSTP (Rapid Spanning

Tree Protocol) for the specified interfaces.

stp Displays running configuration for STP (Spanning Tree

Protocol) for the specified interfaces.

awplus# show running-config interface port1.0.1-port1.0.4

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.45

To display the current running configuration of a switch for VLAN 1, use the command:

To display the current running configuration of a switch for VLANs 1 and 3-5, use the

command:

Output Figure 7-14: Example output from a show running-config interface port1.0.2

command

Figure 7-15: Example output from the show running-config interface command

Related Commands copy running-config

show running-config

awplus# show running-config interface vlan1

awplus# show running-config interface vlan1,vlan3-vlan5

awplus#sh running-config interface port1.0.2

interface port1.0.2

switchport

switchport mode access

awplus#show running-config interface

interface port1.0.1-1.0.6

switchport

switchport mode access

interface port1.0.25-1.0.26

switchport

switchport mode access

switchport access vlan 14

interface port1.0.27-1.0.28

switchport

switchport mode access

switchport access vlan 15

interface vlan1

ip address 192.168.1.1/24

ipv6 enable

ipv6 mld

interface vlan12

ip address 192.168.3.1/24

interface vlan13

ip address 192.168.2.1/24

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.46 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show running-config ip route

Use this command to show the running system static IPv4 route configuration.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show running-config ip route

Mode Privileged Exec and Global Configuration

Example To display the running system static IPv4 route configuration, use the command:

Output Figure 7-16: Example output from the show running-config ip route command

Related Commands copy running-config

show running-config

awplus# show running-config ip route

ip route 3.3.3.3/32 vlan3

ip route 3.3.3.3/32 vlan2

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.47

show running-config ipv6 access-list

Use this command to show the running system status and configuration for IPv6 ACLs.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show running-config ipv6 access-list

Mode Privileged Exec and Global Configuration

Example To display the running system status and configuration for IPv6 ACLs, use the command:

Output Figure 7-17: Example output from the show running-config ipv6 access-list

command

Related Commands copy running-config

show running-config

awplus# show running-config ipv6 access-list

ipv6 access-list abc permit any

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.48 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show running-config ipv6 route

Use this command to show the running system static IPv6 route configuration.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show running-config ipv6 route

Mode Privileged Exec and Global Configuration

Example To display the running system static IPv6 route configuration, use the command:

Output Figure 7-18: Example output from the show running-config ipv6 route command

Related Commands copy running-config

show running-config

awplus# show running-config ipv6 route

ipv6 route 3e11::/64 lo

ipv6 route 3e11::/64 vlan2

ipv6 route fe80::/64 vlan3

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.49

show running-config key chain

Use this command to show the running system key-chain related configuration.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show running-config key chain

Mode Privileged Exec and Global Configuration

Example To display the running system key-chain related configuration, use the command:

Output Figure 7-19: Example output from the show running-config key chain command

Related Commands copy running-config

show running-config

awplus# show running-config key chain

key chain 12

key 2

key-string 234

key chain 123

key 3

key-string 345

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.50 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show running-config lldp

This command shows the current running configuration of LLDP.

Syntax show running-config lldp

Mode Privileged Exec and Global Configuration

Example To display the current configuration of LLDP, use the command:

Output Figure 7-20: Example output from the show running-config lldp command

Related Commands show lldp

show lldp interface

awplus# show running-config lldp

awplus#show running-config lldp

lldp notification-interval 10

lldp timer 20

interface port1.0.1

lldp notifications

lldp tlv-select port-description

lldp tlv-select system-name

lldp tlv-select system-description

lldp tlv-select management-address

lldp transmit receive

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.51

show running-config power-inline

Use this command to show the Power over Ethernet (PoE) running system status and

configuration details. The PoE usage-threshold percentage as specified by the power-

inline usage-threshold command is displayed in the running-config using this

command.

See Chapter 22, Power over Ethernet Introduction and Chapter 23, Power over

Ethernet Commands for more information about PoE.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show running-config power-inline

Mode Privileged Exec and Global Configuration

Example To display the PoE running system status and configuration details, use the command:

Output Figure 7-21: Example output from the show running-config power-inline command

Related Commands power-inline usage-threshold

show power-inline

awplus# show running-config power-inline

power-inline usage-threshold 90

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.52 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show running-config route-map

Use this command to show the running system status and configuration details for route-

map.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show running-config route-map

Mode Privileged Exec and Global Configuration

Example To display the running system status and configuration details for route-map, use the

command:

Output Figure 7-22: Example output from the show running-config route-map command

Related Commands copy running-config

show running-config

awplus# show running-config route-map

route-map abc deny 2

match community 2

route-map abc permit 3

match route-type external type-2

set metric-type type-1

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.53

show running-config router

Use the show running-config router command to display the current running

configuration for a given router.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show running-config router <protocol>

Mode Privileged Exec and Global Configuration

Example To display the current running configuration for a given router, use the command:

Related Commands copy running-config

show running-config

Parameter Description

<protocol>rip or vrrp

rip Routing Information Protocol (RIP)

vrrp Virtual Redundancy Routing Protocol (VRRP)

awplus# show running-config router rip

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.54 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show running-config router-id

Use this command to show the running system global router ID configuration.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show running-config router-id

Mode Privileged Exec and Global Configuration

Example To display the running system global router ID configuration, use the command:

Output Figure 7-23: Example output from the show running-config router-id command

Related Commands copy running-config

show running-config

awplus# show running-config router-id

router-id 3.3.3.3

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.55

show running-config security-password

This command displays the configuration settings for the various security-password rules.

If a default parameter is used for a security-password rule, therefore disabling that rule, no

output is displayed for that feature.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show running-config security-password

Mode Privileged Exec and Global Configuration

Example To display the current security-password rule settings in the running-config, use the

command:

Output Figure 7-24: Example output from the show running-config security-password

command

Related Commands show security-password configuration

show security-password user

awplus# show running-config security-password

security-password minimum-length 8

security-password minimum-categories 3

security-password history 4

security-password lifetime 30

security-password warning 3

security-password forced-change

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.56 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show startup-config

This command displays the contents of the start-up configuration file, which is the file that

the device runs on start-up.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show startup-config

Mode Privileged Exec

Example To display the contents of the current start-up configuration file, use the command:

Output Figure 7-25: Example output from the show startup-config command

Related Commands boot config-file backup

copy running-config

copy startup-config

erase startup-config

show boot

awplus# show startup-config

awplus#show startup-config

service password-encryption

username manager privilege 15 password 8 $1$bJoVec4D$JwOJGPr7YqoExA0GVasdE0

no service ssh

service telnet

service http

no clock timezone

line con 0

line vty 0 4

end

File Management Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 7.57

show version

This command displays the version number and copyright details of the current

AlliedWare PlusTM OS your device is running.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show version

Mode User Exec and Privileged Exec

Example To display the version details of your currently installed software, use the command:

Output Figure 7-26: Example output from the show version command

Related Commands boot system backup

show boot

awplus# show version

awplus#show version

AlliedWare Plus (TM) 5.4.3 19/11/12 13:22:32

Build name : GS900-5.4.4E-1.1.rel

Build date : Fri Jun 6 13:22:32 NZST 2014

Build type : RELEASE

NET-SNMP SNMP agent software

Center of Beijing University of Posts and Telecommunications.

RSA Data Security, Inc. MD5 Message-Digest Algorithm

OpenSSL Library

Original SSLeay License

sFlow(R) Agent Software

DHCP Library

DHCP Bind

Application Interface Specification Framework

Hardware Platform Interface Library

Corosync Cluster Engine

Software written by Ian F. Darwin and others;

maintained 1994- Christos Zoulas.

ProL2TP

Portions of this product are covered by the GNU GPL, source code may be

downloaded from: http://www.alliedtelesis.co.nz/support/gpl/awp.html

File Management Commands

Software Reference for GS900MX/MPX Series Switches

7.58 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

write file

This command copies the running-config into the file that is set as the current startup-

config file. This command is a synonym of the write memory and copy running-config

startup-config commands.

Syntax write [file]

Mode Privileged Exec

Example To write configuration data to the start-up configuration file, use the command:

Related Commands copy running-config

write memory

show running-config

write memory

This command copies the running-config into the file that is set as the current startup-

config file. This command is a synonym of the write file and copy running-config

startup-config commands.

Syntax write [memory]

Mode Privileged Exec

Example To write configuration data to the start-up configuration file, use the command:

Related Commands copy running-config

write file

show running-config

write terminal

This command displays the current configuration of the device. This command is a

synonym of the show running-config command.

Syntax write terminal

Mode Privileged Exec

Example To display the current configuration of your device, use the command:

Related Commands show running-config

awplus# write file

awplus# write memory

awplus# write terminal

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.1

Chapter 8: System Configuration and

Monitoring Commands

Command List .......................................................................................................................................8.2

banner exec............................................................................................................................................8.2

banner login (system).........................................................................................................................8.4

banner motd..........................................................................................................................................8.5

clock set ...................................................................................................................................................8.6

clock summer-time date....................................................................................................................8.7

clock summer-time recurring ..........................................................................................................8.9

clock timezone................................................................................................................................... 8.11

ecofriendly led.................................................................................................................................... 8.12

ecofriendly lpi..................................................................................................................................... 8.13

findme ................................................................................................................................................... 8.15

hostname ............................................................................................................................................. 8.17

max-fib-routes.................................................................................................................................... 8.19

max-static-routes .............................................................................................................................. 8.20

no debug all ........................................................................................................................................ 8.21

reboot.................................................................................................................................................... 8.22

reload..................................................................................................................................................... 8.23

show clock ........................................................................................................................................... 8.24

show cpu .............................................................................................................................................. 8.25

show cpu history ............................................................................................................................... 8.28

show debugging ............................................................................................................................... 8.30

show ecofriendly............................................................................................................................... 8.31

show interface memory.................................................................................................................. 8.33

show memory..................................................................................................................................... 8.35

show memory allocations.............................................................................................................. 8.37

show memory history...................................................................................................................... 8.38

show memory pools......................................................................................................................... 8.40

show memory shared...................................................................................................................... 8.41

show process ...................................................................................................................................... 8.42

show reboot history ......................................................................................................................... 8.44

show router-id.................................................................................................................................... 8.45

show system ....................................................................................................................................... 8.46

show system environment ............................................................................................................ 8.47

show system interrupts................................................................................................................... 8.48

show system mac.............................................................................................................................. 8.49

show system pci device .................................................................................................................. 8.50

show system pci tree ....................................................................................................................... 8.51

show system pluggable.................................................................................................................. 8.52

show system pluggable detail ..................................................................................................... 8.55

show system pluggable diagnostics.......................................................................................... 8.59

show system serialnumber............................................................................................................ 8.62

show tech-support ........................................................................................................................... 8.63

speed (asyn) ........................................................................................................................................ 8.66

system territory (deprecated)....................................................................................................... 8.67

terminal monitor ............................................................................................................................... 8.68

undebug all ......................................................................................................................................... 8.69

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Command List

This chapter provides an alphabetical reference of commands for configuring and

monitoring the system.

banner exec

This command configures the User Exec mode banner that is displayed on the console

after you login. The banner exec default command restores the User Exec banner to the

default banner. Use the no banner exec command to disable the User Exec banner and

remove the default User Exec banner.

Syntax banner exec <banner-text>

banner exec default

no banner exec

Default By default, the AlliedWare PlusTM version and build date is displayed at console login, such

as:

Mode Global Configuration

Examples To configure a User Exec mode banner after login, enter the following commands:

To restore the default User Exec mode banner after login, enter the following commands:

AlliedWare Plus (TM) Version 5.4.4E-1 03/31/14 00:44:25

awplus#configure terminal

awplus(config)#banner exec enable to move to Priv Exec mode

awplus(config)#exit

awplus#exit

awplus login: manager

Password:

enable to move to Priv Exec mode

awplus>

awplus#configure terminal

awplus(config)#banner exec default

awplus(config)#exit

awplus#exit

awplus login: manager

Password:

AlliedWare Plus (TM) Version 5.4.4E-1 03/31/14 13:03:59

awplus>

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.3

To remove the User Exec mode banner after login, enter the following commands:

Related Commands banner login (system)

banner motd

awplus#configure terminal

awplus(config)#no banner exec

awplus(config)#exit

awplus#exit

awplus login: manager

Password:

awplus>

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.4 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

banner login (system)

This command configures the login banner that is displayed on the console when you

displayed after the MOTD (Message-of-the-Day) banner and before the login username

and password prompts.

Use the no banner login command to disable the login banner.

Syntax banner login

no banner login

Default By default, no login banner is displayed at console login.

Mode Global Configuration

Examples To configure a login banner to be displayed when you login, enter the following

commands:

To remove the login banner, enter the following commands:

Related Commands banner exec

banner motd

awplus#configure terminal

awplus(config)#banner login

Type CNTL/D to finish.

authorised users only

awplus(config)#exit

awplus#exit

authorised users only

awplus login: manager

Password:

AlliedWare Plus (TM) Version 5.4.4E-1 03/31/14 13:03:59

awplus>

awplus#configure terminal

awplus(config)#no banner login

awplus(config)#exit

awplus#exit

awplus login: manager

Password:

awplus>

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.5

banner motd

Use this command to change the text MOTD (Message-of-the-Day) banner displayed

before login. The MOTD banner is displayed on all connected terminals. The MOTD banner

is useful for sending messages that affect all network users, for example, any imminent

system shutdowns.

Use the no variant of this command to not display a text MOTD (Message-of-the-Day)

banner on login.

Syntax banner motd <motd-text>

no banner motd

Default By default, the switch displays the AlliedWare PlusTM OS version and build date before

Mode Global Configuration

Examples To configure a MOTD banner to be displayed when you login, enter the following

commands:

To remove the login banner, enter the following commands:

Related Commands banner exec

banner login (system)

awplus>enable

awplus#configure terminal

awplus(config)#banner motd system shutdown at 6pm

awplus(config)#exit

awplus#exit

system shutdown at 6pm

awplus login: manager

Password:

AlliedWare Plus (TM) Version 5.4.4E-1 03/31/14 13:03:59

awplus>enable

awplus#configure terminal

awplus(config)#no banner motd

awplus(config)#exit

awplus#exit

awplus login: manager

Password:

AlliedWare Plus (TM) Version 5.4.4E-1 03/31/14 13:03:59

awplus>

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.6 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

clock set

This command sets the time and date for the system clock.

Syntax clock set <hh:mm:ss> <day> <month> <year>

Mode Privileged Exec

Usage Configure the timezone before setting the local time. Otherwise, when you change the

timezone, the device applies the new offset to the local time.

Example To set the time and date on your system to 2pm on the 2nd of April 2007, use the

command:

Related Commands clock timezone

Parameter Description

<hh:mm:ss> Local time in 24-hour format

<day> Day of the current month <1-31>

<month> The first three letters of the current month.

<year> Current year <2000-2035>

Note If Network Time Protocol (NTP) is enabled, then you cannot change the time or

date using this command. NTP maintains the clock automatically using an

external time source. If you wish to manually alter the time or date, you must

first disable NTP.

awplus# clock set 14:00:00 2 apr 2007

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.7

clock summer-time date

This command defines the start and end of summertime for a specific year only, and

specifies summertime’s offset value to Standard Time for that year.

The no variant of this command removes the device’s summertime setting. This clears

both specific summertime dates and recurring dates (set with the clock summer-time

recurring command on page 8.9).

By default, the device has no summertime definitions set.

Syntax clock summer-time <timezone-name> date <start-day> <start-month>

<start-year> <start-time> <end-day> <end-month> <end-year>

<end-time> <1-180>

no clock summer-time

Mode Global Configuration

Examples To set a summertime definition for New Zealand using NZST (UTC+12:00) as the standard

time, and NZDT (UTC+13:00) as summertime, with the summertime set to begin on the 1st

October 2007 and end on the 18th of March 2008:

Parameter Description

<timezone-name> A description of the summertime zone, up to 6 characters long.

date Specifies that this is a date-based summertime setting for just

the specified year.

<start-day> Day that the summertime starts, in the range 1-31.

<start-month> First three letters of the name of the month that the

summertime starts.

<start-year> Year that summertime starts, in the range 2000-2035.

<start-time> Time of the day that summertime starts, in the 24-hour time

format HH:MM.

<end-day> Day that summertime ends, in the range 1-31.

<end-month> First three letters of the name of the month that the

summertime ends.

<end-year> Year that summertime ends, in the range 2000-2035.

<end-time> Time of the day that summertime ends, in the 24-hour time

format HH:MM.

<1-180> The offset in minutes.

awplus(config)# clock summer-time NZDT date 1 oct 2:00 2007 18

mar 2:00 2008 60

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.8 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

To remove any summertime settings on the system, use the command:

Related Commands clock summer-time recurring

clock timezone

awplus(config)# no clock summer-time

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.9

clock summer-time recurring

This command defines the start and end of summertime for every year, and specifies

summertime’s offset value to Standard Time.

The no variant of this command removes the device’s summertime setting. This clears

both specific summertime dates (set with the clock summer-time date command on

page 8.7) and recurring dates.

By default, the device has no summertime definitions set.

Syntax clock summer-time <timezone-name> recurring <start-week> <start-day>

<start-month> <start-time> <end-week> <end-day> <end-month>

<end-time> <1-180>

no clock summer-time

Mode Global Configuration

Parameter Description

<timezone-

name>

A description of the summertime zone, up to 6 characters long.

recurring Specifies that this summertime setting applies every year from

now on.

<start-week> Week of the month when summertime starts, in the range 1-5. The

value 5 indicates the last week that has the specified day in it for

the specified month. For example, to start summertime on the last

Sunday of the month, enter 5 for <start-week> and sun for

<start-day>.

<start-day> Day of the week when summertime starts. Valid values are mon,

tue, wed, thu, fri, sat or sun.

<start-month> First three letters of the name of the month that summertime

starts.

<start-time> Time of the day that summertime starts, in the 24-hour time

format HH:MM.

<end-week> Week of the month when summertime ends, in the range 1-5. The

value 5 indicates the last week that has the specified day in it for

the specified month. For example, to end summertime on the last

Sunday of the month, enter 5 for <end-week> and sun for <end-

day>.

<end-day> Day of the week when summertime ends. Valid values are mon,

tue, wed, thu, fri, sat or sun.

<end-month> First three letters of the name of the month that summertime ends.

<end-time> Time of the day that summertime ends, in the 24-hour time format

HH:MM.

<1-180> The offset in minutes.

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.10 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Examples To set a summertime definition for New Zealand using NZST (UTC+12:00) as the standard

time, and NZDT (UTC+13:00) as summertime, with summertime set to start on the 1st

Sunday in October, and end on the 3rd Sunday in March, use the command:

To remove any summertime settings on the system, use the command:

Related Commands clock summer-time date

clock timezone

awplus(config)# clock summer-time NZDT recurring 1 sun oct 2:00

3 sun mar 2:00 60

awplus(config)# no clock summer-time

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.11

clock timezone

This command defines the device’s clock timezone. The timezone is set as a offset to the

UTC.

The no variant of this command resets the system time to UTC.

By default, the system time is set to UTC.

Syntax clock timezone <timezone-name> {minus|plus} [<0-13>|<0-12>:<00-59>]

no clock timezone

Mode Global Configuration

Usage Configure the timezone before setting the local time. Otherwise, when you change the

timezone, the device applies the new offset to the local time.

Examples To set the timezone to New Zealand Standard Time with an offset from UTC of +12 hours,

use the command:

To set the timezone to Indian Standard Time with an offset from UTC of +5:30 hours, use

the command:

To set the timezone back to UTC with no offsets, use the command:

Related Commands clock set

clock summer-time date

clock summer-time recurring

Parameter Description

<timezone-name> A description of the timezone, up to 6 characters long.

minus or

plus

The direction of offset from UTC. The minus option

indicates that the timezone is behind UTC. The plus option

indicates that the timezone is ahead of UTC.

<0-13> The offset in hours or from UTC.

<0-12>:<00-59> The offset in hours or from UTC.

awplus(config)# clock timezone NZST plus 12

awplus(config)# clock timezone IST plus 5:30

awplus(config)# no clock timezone

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.12 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

ecofriendly led

Use this command to enable the eco-friendly LED (Light Emitting Diode) feature, which

turns off power to the port LEDs, including the stack port status LEDs. Power to the system

status, SD and stack management LEDs is not disabled.

Use the no variant of this command to disable the eco-friendly LED feature.

Syntax ecofriendly led

no ecofriendly led

Default The eco-friendly LED feature is disabled by default.

Mode Global Configuration

Usage When the eco-friendly LED feature is enabled, a change in port status will not affect the

display of the associated LED. When the eco-friendly LED feature is disabled and power is

returned to port LEDs, the LEDs will correctly show the current state of the ports.

In a stack environment, enabling the eco-friendly LED feature on the stack master will

apply the feature to every member of the stack.

For an example of how to configure a trigger to enable the eco-friendly LED feature, see

“Turn Off Power to Port LEDs” on page 75.7. See also the section “Save Power with the

Eco-Friendly Feature” on page 1.32.

Examples To enable the eco-friendly LED feature which turns off power to all port LEDs, use the

following commands:

To disable the eco-friendly LED feature, use the following command:

Related Commands ecofriendly lpi

show ecofriendly

awplus# configure terminal

awplus(config)# ecofriendly led

awplus# configure terminal

awplus(config)# no ecofriendly led

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.13

ecofriendly lpi

Use this command to conserve power by enabling the eco-friendly LPI (Low Power Idle)

feature. This feature reduces the power supplied to the ports by the switch whenever the

ports are idle and are connected to IEEE 802.3az Energy Efficient Ethernet compliant host

devices. See the section “Save Power with the Eco-Friendly Feature” on page 1.32.

LPI is a feature of the IEEE 802.3az Energy Efficient Ethernet (EEE) standard. LPI lowers

power consumption of switch ports during periods of low link utilization when connected

to IEEE 802.3az compliant host devices. If no data is sent then the switch port can enter a

sleep state, called Low Power Idle (LPI), to conserve power used by the switch.

Use the no variant of this command to disable the eco-friendly LPI feature.

Syntax ecofriendly lpi

no ecofriendly lpi

Default The eco-friendly LPI feature is disabled by default.

Mode Interface Configuration for a switch port, or Interface Configuration for a range of switch

ports.

Usage For an example of how to configure a trigger to enable the eco-friendly LPI feature, see

“Reduce Power Supplied to Ports” on page 75.9.

All ports configured for LPI must support LPI in hardware and must be configured to auto

negotiate by default or by using the speed and duplex commands as needed.

Examples To enable the eco-friendly LPI feature on a switch port, port1.0.2, use the following

commands:

To enable the eco-friendly LPI feature on a range of switch ports, port1.0.2-

port1.0.4, use the following commands:

To disable the eco-friendly feature on port1.0.2, use the following commands:

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# ecofriendly lpi

awplus# configure terminal

awplus(config)# interface port1.0.2-port1.0.4

awplus(config-if)# ecofriendly lpi

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# no ecofriendly lpi

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.14 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

To disable the eco-friendly feature on a range of switch ports, port1.0.2-port1.0.4,

use the following commands:

Related Commands duplex

ecofriendly led

show ecofriendly

show interface

speed

awplus# configure terminal

awplus(config)# interface port1.0.2-port1.0.4

awplus(config-if)# no ecofriendly lpi

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.15

findme

Use this command to physically locate a specific device from a group of similar devices.

Activating the command causes a selected number of port LEDs to alternately flash green

then amber (if that device has amber LEDs) at a rate of 1 Hz.

Use the no variant of this command to deactivate the Find Me feature prior to the timeout

expiring.

Syntax findme [interface <port-list>|member <stack-ID>] [timeout <duration>]

no findme

Default By default all port LEDs flash for 60 seconds.

Mode Privileged Exec

Usage Running the findme command causes the device’s port LEDs to flash. An optional timeout

parameter specifies the flash behavior duration. Normal LED behavior is restored

automatically after either the default time, or a specified time has elapsed, or a no findme

command is used. You can specify which interface or interfaces are flashed with the

optional interface parameter.

You can specify a particular stack member with the optional member parameter. All

available interfaces are flashed by default.

Example To activate the Find Me feature for the default duration (60 seconds) on all ports, use the

following command:

To activate the Find Me feature for 120 seconds on all ports, use the following command:

Parameter Description

<port-list> The ports to flash. The port list can be:

■a switch port, e.g. port1.0.4

■a continuous range of ports separated by a hyphen,

e.g. port1.0.1-1.0.4

■a comma-separated list of ports and port ranges,

e.g. port1.0.1,port1.0.5-1.0.6.

<stack-ID>Stack member number, from 1 to 4.

<duration>Specify the duration in seconds within the range of 5-3600 seconds.

Note The interface and member parameters are mutually exclusive.

awplus# findme

awplus# findme timeout 120

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.16 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

To activate the Find Me feature for the default duration (60 seconds) on switch port

interfaces port1.0.2 through port1.0.4, use the following command:

In the example above, ports 2 to 4 will flash 4 times and then all ports will flash twice. Each

alternate flash will be amber (if that device has amber LEDs). This pattern will repeat until

timeout (default or set) or no findme commands are used.

To deactivate the Find Me feature, use the following command:

To activate the Find Me feature for the default duration on stack member 2, use the

following command:

In the example above, all ports on member 2 will flash 4 times and then all ports in the

stack will flash twice. Each alternate flash will be amber (if that device has amber LEDs).

This pattern will repeat until the timeout (default or set) expires or the no findme

commands is used.

awplus# findme interface port1.0.2-1.0.4

awplus# no findme

awplus# findme member 2

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.17

hostname

This command sets the name applied to the device as shown at the prompt. The

hostname is:

■displayed in the output of the show system command

■displayed in the CLI prompt so you know which device you are configuring

■stored in the MIB object sysName

On a stack, after the stack master is elected, the master will have a host name: awplus by

default, and this also becomes the name of the stack. Individual stack members (excluding

the master) will have a host name that is the stack name hyphenated with a numeric suffix.

For example, awplus-1, awplus-2 and so on.

The hostname command can then be used to change the stack name and the stack

master's host name. For example, for the hostname Lab the stack master’s host name will

be Lab and the other stack members will have host names Lab-1, Lab-2 and so on.

In case of stack master fail-over, or stack split, the new stack will use the previous stack

name as its host name and the stack name, unless it is changed by executing the

hostname command on the new stack master.

Use the no variant of this command to revert the hostname setting to its default

(awplus).

Syntax hostname <hostname>

no hostname [<hostname>]

Default awplus

Mode Global Configuration

Usage The name must also follow the rules for ARPANET host names. The name must start with a

letter, end with a letter or digit, and use only letters, digits, and hyphens. Refer to RFC

1035.

Example To set the system name to HQ-Sales, use the command:

Parameter Description

<hostname> Specifies the name given to a specific switch. Also referred to as the

Node Name in AMF output screens.

Note Within an AMF network, any switch without a hostname applied will

automatically be assigned a name based on its MAC address.

To efficiently manage your network using AMF, we strongly advise that you

devise a naming convention for your network switches and accordingly apply

an appropriate hostname to each switch.

awplus# configure terminal

awplus(config)# hostname HQ-Sales

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.18 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

This changes the prompt to:

To revert to the default hostname awplus, use the command:

This changes the prompt to:

Related Commands show system

HQ-Sales(config)#

HQ-Sales(config)# no hostname

awplus(config)#

Note When AMF is configured, running the no hostname command will apply a

hostname that is based on the MAC address of the switch node, for example,

node_0016_76b1_7a5e.

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.19

max-fib-routes

This command enables you to control the maximum number of FIB routes configured. It

operates by providing parameters that enable you to configure preset maximums and

warning message thresholds. The operation of these parameters is explained in the

Parameter / Descriptions table shown below.

Use the no variant of this command to set the maximum number of fib routes to the

default of 4294967294 fib routes.

Syntax max-fib-routes <1-4294967294> [<1-100>|warning-only]

no max-fib-routes

Default The default number of fib routes is the maximum number of fib routes (4294967294).

Mode Global Configuration

Examples To set the maximum number of dynamic routes to 2000 and warning threshold of 75%,

use the following commands:

Note To set static routes, use the max-static-routes command on page 8.20.

Parameter Description

max-fib-routes This is a the maximum number of routes that can be stored in

the switch’s Forwarding Information dataBase. In practice, other

practical system limits would prevent this maximum being

reached.

<1-4294967294>The allowable configurable range for setting the maximum

number of FIB-routes.

<1-100>This parameter enables you to optionally apply a percentage

value. This percentage will be based on the maximum number

of FIB routes you have specified. This will cause a warning

message to appear when your routes reach your specified

percentage value. Routes can continue to be added until your

configured maximum value is reached.

warning-only This parameter enables you to optionally apply a warning

message. If you set this option a warning message will appear if

your maximum configured value is reached. Routes can

continue to be added until your switch reaches either the

maximum capacity value of 4294967294, or a practical system

limit.

awplus# config terminal

awplus(config)# max-fib-routes 2000 75

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.20 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

max-static-routes

Use this command to set the maximum number of static routes, excluding FIB (Forwarding

Information Base) routes. Note that FIB routes are set and reset using max-fib-routes.

Use the no variant of this command to set the maximum number of static routes to the

default of 1000 static routes.

Syntax max-static-routes <1-1000>

no max-static-routes

Default The default number of static routes is the maximum number of static routes (1000).

Mode Global Configuration

Example To reset the maximum number of static routes to the default maximum, use the

command:

Related Commands max-fib-routes

Note To set dynamic FIB routes, use the max-fib-routes command on page 8.19.

awplus# configure terminal

awplus(config)# no max-static-routes

Note Static routes are applied before adding routes to the RIB (Routing Information

Base). Therefore, rejected static routes will not appear in the running config.

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.21

no debug all

This command disables the debugging facility for all features on your device. This stops

the device from generating any diagnostic debugging messages.

The debugging facility is disabled by default.

Syntax no debug all [dot1x|ipv6|nsm]

Mode Global Configuration and Privileged Exec

Example To disable debugging for all features, use the command:

To disable all 802.1X debugging, use the command:

To disable all IPv6 debugging, use the command:

To disable all NSM debugging, use the command:

Related Commands undebug all

Parameter Description

dot1x Turns off all debugging for IEEE 802.1X port-based network access-

control.

ipv6 Turns off all debugging for IPv6 (Internet Protocol version 6).

nsm Turns off all debugging for the NSM (Network Services Module).

awplus# no debug all

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.22 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

reboot

This command halts the device and performs a cold restart (also known as reload). It

displays a confirmation request before restarting.

You can reboot a stand-alone device, a stack, or a specified stack member.

Syntax reboot <stack-ID>

reload <stack-ID>

reboot

reload

Mode Privileged Exec

Usage The reboot and reload commands perform the same action.

When restarting the whole stack, you can either use this reboot command to reboot all

stack members immediately, or to minimize downtime, reboot the stack members in a

rolling sequence by using the reboot rolling command on page 82.4.

Examples To restart the stand-alone device, use the command:

To restart all devices in the stack, use the command:

To restart stack member 2, use the command:

If the specified stack member ID does not exist in the current stack, the command is

rejected.

Related Commands reboot rolling

reload rolling

Parameter Description

<stack-ID>Stack member number, from 1 to 4.

awplus# reboot

reboot system? (y/n): y

awplus# reboot

Are you sure you want to reboot the whole stack? (y/n): y

awplus# reboot stack-member 2

reboot stack-member 2 system? (y/n): y

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.23

reload

This command performs the same function as the reboot command on page 8.22.

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.24 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show clock

This command displays the system’s current configured local time and date. It also

displays other clock related information such as timezone and summertime configuration.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show clock

Mode User Exec and Privileged Exec

Example To display the system’s current local time, use the command:

Output Figure 8-1: Example output from the show clock command for a switch using New

Zealand time

Related Commands clock set

clock summer-time date

clock summer-time recurring

clock timezone

awplus# show clock

Local Time: Mon, 6 Aug 2007 13:56:06 +1200

UTC Time: Mon, 6 Aug 2007 01:56:06 +0000

Timezone: NZST

Timezone Offset: +12:00

Summer time zone: NZDT

Summer time starts: Last Sunday in September at 02:00:00

Summer time ends: First Sunday in April at 02:00:00

Summer time offset: 60 mins

Summer time recurring: Yes

Table 8-1: Parameters in the output of the show clock command

Parameter Description

Local Time Current local time.

UTC Time Current UTC time.

Timezone The current configured timezone name.

Timezone Offset Number of hours offset to UTC.

Summer time zone The current configured summertime zone name.

Summer time starts Date and time set as the start of summer time.

Summer time ends Date and time set as the end of summer time.

Summer time offset Number of minutes that summer time is offset from the

system’s timezone.

Summer time

recurring

Whether the device will apply the summer time settings

every year or only once.

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.25

show cpu

This command displays a list of running processes with their CPU utilization.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show cpu [<stack-ID>] [sort {thrds|pri|sleep|runtime}]

Mode User Exec and Privileged Exec

Usage Entering this command on the stack master will display the information for all the stack

members. A stack member heading will distinguish the different information for every

stack member device.

Examples To show the CPU utilization of current processes, sorting them by the number of threads

the processes are using, use the command:

Note that in a stack environment, executing this command on the stack master will show

CPU utilization for all stack members.

To show CPU utilization for a specific stack member (in this case stack member 2), use the

following command:

Parameter Description

<stack-ID> Stack member number, from 1 to 4.

sort Changes the sorting order using the following fields. If you do not

specify a field, then the list is sorted by percentage CPU utilization.

thrds Sort by the number of threads.

pri Sort by the process priority.

sleep Sort by the average time sleeping.

runtime Sort by the runtime of the process.

awplus# show cpu sort thrds

awplus# show cpu 2

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.26 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Output Figure 8-2: Example output from the show cpu command

Stack member 2:

CPU averages:

1 second: 12%, 20 seconds: 2%, 60 seconds: 2%

System load averages:

1 minute: 0.03, 5 minutes: 0.02, 15 minutes: 0.00

Current CPU load:

userspace: 6%, kernel: 4%, interrupts: 1% iowaits: 0%

user processes

==============

pid name thrds cpu% pri state sleep% runtime

1544 hostd 1 2.8 20 run 0 120

1166 exfx 17 1.8 20 sleep 0 3846

1198 stackd 1 0.9 20 sleep 0 459

1284 aisexec 44 0.9 -2 sleep 0 2606

1 init 1 0.0 20 sleep 0 120

9772 sh 1 0.0 20 sleep 0 0

9773 corerotate 1 0.0 20 sleep 0 0

853 syslog-ng 1 0.0 20 sleep 0 356

859 klogd 1 0.0 20 sleep 0 1

910 inetd 1 0.0 20 sleep 0 3

920 portmap 1 0.0 20 sleep 0 0

931 crond 1 0.0 20 sleep 0 1

1090 openhpid 11 0.0 20 sleep 0 233

1111 hpilogd 1 0.0 20 sleep 0 0

1240 hsl 1 0.0 20 sleep 0 79

1453 authd 1 0.0 20 sleep 0 85

1497 cntrd 1 0.0 20 sleep 0 2

1520 epsrd 1 0.0 20 sleep 0 56

1571 imi 1 0.0 20 sleep 0 275

1594 irdpd 1 0.0 20 sleep 0 23

1617 lacpd 1 0.0 20 sleep 0 87

1638 mstpd 1 0.0 20 sleep 0 75

1662 nsm 1 0.0 20 sleep 0 163

1685 ospfd 1 0.0 20 sleep 0 35

1708 pdmd 1 0.0 20 sleep 0 23

1729 pimd 1 0.0 20 sleep 0 32

1751 ripd 1 0.0 20 sleep 0 33

1775 ripngd 1 0.0 20 sleep 0 25

1797 rmond 1 0.0 20 sleep 0 64

1963 ntpd 1 0.0 20 sleep 0 15

2102 atlgetty 1 0.0 20 sleep 0 0

2712 rpc.statd 1 0.0 20 sleep 0 0

2716 rpc.statd 1 0.0 20 sleep 0 0

2722 rpc.mountd 1 0.0 20 sleep 0 0

2821 automount 1 0.0 20 sleep 0 82

2892 ntpd 1 0.0 20 sleep 0 17

2912 sshd 1 0.0 20 sleep 0 0

9774 login 1 0.0 20 sleep 0 2

12689 more 1 0.0 20 sleep 0 0

Table 8-2: Parameters in the output of the show cpu command

Parameter Description

Stack member Stack member number.

CPU averages Average CPU utilization for the periods stated.

System load

averages The average number of processes waiting for CPU time for the

periods stated.

Current CPU load Current CPU utilization specified by load types.

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.27

Related Commands show memory

show memory allocations

show memory history

show memory pools

show process

pid Identifier number of the process.

name A shortened name for the process

thrds Number of threads in the process.

cpu% Percentage of CPU utilization that this process is consuming.

pri Process priority state.

state Process state; one of “run”, “sleep”, “zombie”, and “dead”.

sleep% Percentage of time that the process is in the sleep state.

runtime The time that the process has been running for, measured in

jiffies. A jiffy is the duration of one tick of the system timer

interrupt.

Table 8-2: Parameters in the output of the show cpu command (cont.)

Parameter Description

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.28 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show cpu history

This command prints a graph showing the historical CPU utilization.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show [<stack-ID>]cpu history

Mode User Exec and Privileged Exec

Usage This command’s output displays three graphs of the percentage CPU utilization:

■per second for the last minute, then

■per minute for the last hour, then

■per 30 minutes for the last 30 hours.

If this command is entered on the stack master, it will print graphs for all the stack

members. A stack member heading will be displayed to distinguish the different graphs

for every stack member.

Examples To display a graph showing the historical CPU utilization of the device, use the command:

To display the CPU utilization history graph for stack member 2, use the command:

where 2 is the node id of the stack member.

Parameter Description

<stack-ID>Stack member number, from 1 to 4.

awplus# show cpu history

awplus# show 2 cpu history

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.29

Output Figure 8-3: Example output from the show cpu history command

Related Commands show memory

show memory allocations

show memory pools

show process

Stack member 2:

Per second CPU load history

100

10 ************************************************************

|....|....|....|....|....|....|....|....|....|....|....|....

Oldest Newest

CPU load% per second (last 60 seconds)

* = average CPU load%

Per minute CPU load history

100 *+

90 +

20 + +

10 ****************************************************

|....|....|....|....|....|....|....|....|....|....|....|....

Oldest Newest

CPU load% per minute (last 60 minutes)

* = average CPU load%, + = maximum

Per (30) minute CPU load history

100 +

10 **

|....|....|....|....|....|....|....|....|....|....|....|....

Oldest Newest

CPU load% per 30 minutes (last 60 values / 30 hours)

* = average, - = minimum, + = maximum

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.30 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show debugging

This command displays information for all debugging options.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show debugging

Default This command runs all the show debugging commands in alphabetical order.

Mode User Exec and Privileged Exec

Usage This command displays all debugging information, similar to the way the show tech-

support command displays all show output for use by Allied Telesis authorized service

personnel only.

Example To display all debugging information, use the command:

Output Figure 8-4: Example output from the show debugging command

Related Commands show debugging aaa

show debugging dot1x

show debugging epsr

show debugging igmp

show debugging lacp

show debugging lldp

show debugging mstp

show debugging power-inline

show debugging radius

show debugging snmp

awplus# show debugging

awplus#show debugging

AAA debugging status:

Authentication debugging is off

Accounting debugging is off

% DHCP Snooping service is disabled

802.1X debugging status:

EPSR debugging status:

EPSR Info debugging is off

EPSR Message debugging is off

EPSR Packet debugging is off

EPSR State debugging is off

IGMP Debugging status:

IGMP Decoder debugging is off

IGMP Encoder debugging is off

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.31

show ecofriendly

This command displays the switch’s eco-friendly configuration status. The ecofriendly led

and ecofriendly lpi configuration status are shown in the show ecofriendly output.

Syntax show ecofriendly

Mode Privileged Exec and Global Configuration

Example To display the switch’s eco-friendly configuration status, use the following command:

Output Figure 8-5: Example output from the show ecofriendly command

awplus# show ecofriendly

awplus#show ecofriendly

Front panel port LEDs normal

Energy efficient ethernet

Port Name Configured Status

port1.0.1 Port 1 lpi lpi

port1.0.2 lpi lpi

port1.0.3 lpi lpi

port1.0.4 off off

port1.0.5 lpi off

port1.0.6 Port 6 off off

port1.0.7 off -

port1.0.8 off -

port1.0.9 off -

port1.0.10 off -

...

Table 8-3: Parameters in the output of the show ecofriendly command

Parameter Description

normal The eco-friendly LED feature is disabled and port LEDs

show the current state of the ports. This is the default

setting.

off The eco-friendly LED feature is enabled and power to

the port LEDs is disabled.

normal (configuration

overridden by eco

button)

The eco-friendly LED feature has been disabled with

the eco-switch button, overriding the configuration

set with the ecofriendly led command. The port LEDs

show the current state of the ports.

off (configuration

overridden by eco

button)

The eco-friendly LED feature has been enabled with

the eco-switch button, overriding the configuration

set with the ecofriendly led command. Power to the

port LEDs is disabled.

Port Displays the port number as assigned by the switch.

Name Displays the port name if a name is configured for a

port number.

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.32 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Related Commands ecofriendly led

ecofriendly lpi

Configured The eco-friendly LPI feature is configured on the port.

Either LPI or off is displayed.

Status The eco-friendly LPI feature is active on the port. Either

LPI or off is displayed. Ports that are not running show

a dash (-).

Table 8-3: Parameters in the output of the show ecofriendly command (cont.)

Parameter Description

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.33

show interface memory

This command displays the shared memory used by either all interfaces, or the specified

interface or interfaces. The output is useful for diagnostic purposes by Allied Telesis

authorized service personnel.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show interface memory

show interface <port-list> memory

Mode User Exec and Privileged Exec

Example To display the shared memory used by all interfaces, use the command:

To display the shared memory used by port1.0.1 and port1.0.5 to port1.0.6,

use the command:

Parameter Description

<port-list> The ports to display information about. The port list can be:

■a switch port (e.g. port1.0.4) a static channel group (e.g. sa2)

or a dynamic (LACP) channel group (e.g. po2)

■a continuous range of ports separated by a hyphen,

e.g. port1.0.1-1.0.4, or sa1-2, or po1-2

■a comma-separated list of ports and port ranges,

e.g. port1.0.1,port1.0.4-1.0.6. Do not mix switch ports,

static channel groups, and dynamic (LACP) channel groups in the

same list

awplus# show interface memory

awplus# show interface port1.0.1,port1.0.5-1.0.6 memory

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.34 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Output Figure 8-6: Example output from the show interface <port-list> memory command

Figure 8-7: Example output from the show interface memory command

Related Commands show interface brief

show interface status

awplus#show interface port1.0.1,port1.0.5-1.0.6 memory

Vlan blocking state shared memory usage

---------------------------------------------

Interface shmid Bytes Used nattch Status

port1.0.1 393228 512 1

port1.0.5 491535 512 1

port1.0.6 557073 512 1

awplus#show interface memory

Vlan blocking state shared memory usage

---------------------------------------------

Interface shmid Bytes Used nattch Status

port1.0.1 393228 512 1

port1.0.2 458766 512 1

port1.0.3 360459 512 1

port1.0.4 524304 512 1

port1.0.5 491535 512 1

port1.0.6 557073 512 1

port1.0.7 327690 512 1

port1.0.8 655380 512 1

port1.0.9 622611 512 1

port1.0.21 950301 512 1

port1.0.22 1048608 512 1

port1.0.23 1015839 512 1

port1.0.24 1081377 512 1

lo 425997 512 1

po1 1179684 512 1

po2 1212453 512 1

sa3 1245222 512 1

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.35

show memory

This command displays the memory used by each process that is currently running

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show memory [<stack-ID>] [sort {size|peak|stk}]

Mode User Exec and Privileged Exec

Usage If this command is entered on the stack master, it will display corresponding memory

utilization information for all the stack members. A stack member heading will display the

information for every stack member device.

Example To display the memory used by the current running processes, use the command:

Output Figure 8-8: Example output from the show memory command

Parameter Description

<stack-ID>Stack member number, from 1 to 4.

sort Changes the sorting order for the list of processes. If you do not

specify this, then the list is sorted by percentage memory

utilization.

size Sort by the amount of memory the process is

currently using.

peak Sort by the amount of memory the process is

currently using.

stk Sort by the stack size of the process.

awplus# show memory

awplus#show memory

Stack member 1:

RAM total: 514920 kB; free: 382716; buffers: 16368 kB

user processes

==============

pid name mem% size peak data stk

962 pss 6 33112 36260 27696 244

1 init 0 348 1092 288 84

797 syslog-ng 0 816 2152 752 84

803 klogd 0 184 1244 124 84

843 inetd 0 256 1256 136 84

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.36 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Related Commands show memory allocations

show memory history

show memory pools

show memory shared

Table 8-4: Parameters in the output of the show memory command

Parameter Description

Stack member Stack member number.

RAM total Total amount of RAM memory free.

free Available memory size.

buffers Memory allocated kernel buffers.

pid Identifier number for the process.

name Short name used to describe the process.

mem% Percentage of memory utilization the process is currently using.

size Amount of memory currently used by the process.

peak Greatest amount of memory ever used by the process.

data Amount of memory used for data.

stk The stack size.

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.37

show memory allocations

This command displays the memory allocations used by processes.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show memory allocations [<process>]

Mode User Exec and Privileged Exec

Example To display the memory allocations used by all processes on your device, use the

command:

Output Figure 8-9: Example output from the show memory allocations command

Related Commands show memory

show memory history

show memory pools

show memory shared

show tech-support

Parameter Description

<process> Displays the memory allocation used by the specified process.

awplus# show memory allocations

awplus#show memory allocations

Memory allocations for imi

-----------------------------

Current 15093760 (peak 15093760)

Statically allocated memory:

- binary/exe : 1675264

- libraries : 8916992

- bss/global data : 2985984

- stack : 139264

Dynamically allocated memory (heap):

- total allocated : 1351680

- in use : 1282440

- non-mmapped : 1351680

- maximum total allocated : 1351680

- total free space : 69240

- releasable : 68968

- space in freed fastbins : 16

Context

filename:line allocated freed

+ lib.c:749 484

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.38 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show memory history

This command prints a graph showing the historical memory usage.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show memory history <stack-ID>

Mode User Exec and Privileged Exec

Usage This command’s output displays three graphs of the percentage memory utilization:

■per second for the last minute, then

■per minute for the last hour, then

■per 30 minutes for the last 30 hours.

If entered on the stack master, this command will display corresponding memory

utilization information for all the stack members. A stack member heading will be

displayed to distinguish the different lists for every stack member.

Examples To show a graph displaying the historical memory usage for either a single unstacked

device, or a complete stack, use the command:

To show a graph displaying the historical memory usage for specific stack member (stack

member 2 in this example) within a stack, use the command:

Parameter Description

<stack-ID>Stack member number, from 1 to 4.

awplus# show memory history

awplus# show memory history 2

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.39

Output Figure 8-10: Example output from the show memory history command

Related Commands show memory allocations

show memory pools

show memory shared

show tech-support

STACK member 1:

Per minute memory utilization history

100

40*************************************************************

|....|....|....|....|....|....|....|....|....|....|....|....

Oldest Newest

Memory utilization% per minute (last 60 minutes)

* = average memory utilisation%.

----------------------------------------------------------------

STACK member 2:

Per minute memory utilization history

100

40*************************************************************

|....|....|....|....|....|....|....|....|....|....|....|....

Oldest Newest

Memory utilization% per minute (last 60 minutes)

* = average memory utilisation%.

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.40 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show memory pools

This command shows the memory pools used by processes.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show memory pools [<process>]

Mode User Exec and Privileged Exec

Example To shows the memory pools used by processes, use the command:

Output Figure 8-11: Example output from the show memory pools command

Related Commands show memory allocations

show memory history

show tech-support

Parameter Description

<process> Displays the memory pools used by the specified process.

awplus# show memory pools

awplus#show memory pools

Memory pools for imi

----------------------

Current 15290368 (peak 15290368)

Statically allocated memory:

- binary/exe : 1675264

- libraries : 8916992

- bss/global data : 2985984

- stack : 139264

Dynamically allocated memory (heap):

- total allocated : 1548288

- in use : 1479816

- non-mmapped : 1548288

- maximum total allocated : 1548288

- total free space : 68472

- releasable : 68200

- space in freed fastbins : 16

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.41

show memory shared

This command displays shared memory allocation information. The output is useful for

diagnostic purposes by Allied Telesis authorized service personnel.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show memory shared

Mode User Exec and Privileged Exec

Example To display information about the shared memory allocation used on the switch, use the

command:

Output Figure 8-12: Example output from the show memory shared command

Related Commands show memory allocations

show memory history

show memory sort

awplus# show memory shared

awplus#show memory shared

Shared Memory Status

--------------------------

Segment allocated = 39

Pages allocated = 39

Pages resident = 11

Shared Memory Limits

--------------------------

Maximum number of segments = 4096

Maximum segment size (kbytes) = 32768

Maximum total shared memory (pages) = 2097152

Minimum segment size (bytes) = 1

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.42 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show process

This command lists a summary of the current running processes.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show process [<stack-ID>] [sort {cpu|mem}]

Mode User Exec and Privileged Exec

Usage For a stacked configuration, if this command is entered on the stack master, it will display

the information for all the stack members. A stack member heading will be displayed to

distinguish the different information for every stack member.

Example To display a summary of the current running processes, use the command:

To display a summary of the current running processes on stack member 2, use the

command:

Output Figure 8-13: Example output from the show process command

Parameter Description

<stack-ID>Stack member number, from 1 to 4.

sort Changes the sorting order for the list of processes.

cpu Sorts the list by the percentage of CPU utilization.

mem Sorts the list by the percentage of memory

utilization.

awplus# show process

awplus# show process 2

Stack member 2:

CPU load for 1 minute: 0%; 5 minutes: 3%; 15 minutes: 0%

RAM total: 514920 kB; free: 382600 kB; buffers: 16368 kB

user processes

==============

pid name thrds cpu% mem% pri state sleep%

962 pss 12 0 6 25 sleep 5

1 init 1 0 0 25 sleep 0

797 syslog-ng 1 0 0 16 sleep 88

kernel threads

==============

pid name cpu% pri state sleep%

71 aio/0 0 20 sleep 0

3 events/0 0 10 sleep 98

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.43

Related Commands show cpu

show cpu history

Table 8-5: Parameters in the output from the show process command

Parameter Description

Stack member Stack member number.

CPU load Average CPU load for the given period.

RAM total Total memory size.

free Available memory.

buffers Memory allocated to kernel buffers.

pid Identifier for the process.

name Short name to describe the process.

thrds Number of threads in the process.

cpu% Percentage of CPU utilization that this process is consuming.

mem% Percentage of memory utilization that this process is consuming.

pri Process priority.

state Process state; one of “run”, “sleep”, “stop”, “zombie”, or “dead”.

sleep% Percentage of time the process is in the sleep state.

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.44 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show reboot history

Use this command to display the switch’s reboot history.

Syntax show reboot history [<stack-ID>]

Mode User Exec and Privileged Exec

Example To show the reboot history of stack member 2, use the command:

Output Figure 8-14: Example output from the show reboot history command

Related Commands show tech-support

Parameter Description

<stack-ID> Stack member number, from 1 to 4.

awplus# show reboot history 2

awplus#show reboot history 2

Stack member 2:

------------------------

2014-01-10 01:42:04 Expected User Request

2014-01-10 01:35:31 Expected User Request

2014-01-10 01:16:25 Unexpected Rebooting due to critical process (network/nsm)

failure!

2014-01-10 01:11:04 Unexpected Rebooting due to critical process (network/nsm)

failure!

2014-01-09 20:46:40 Unexpected Rebooting due to VCS duplicate member-ID

2014-01-09 19:56:16 Expected User Request

2014-01-09 19:51:20 Expected User Request

Table 8-6: Parameters in the output from the show reboot history command

Parameter Description

user request User initiated reboot via the CLI.

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.45

show router-id

Use this command to show the Router ID of the current system.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show router-id

Mode User Exec and Privileged Exec

Example To display the Router ID of the current system, use the command:

Output Figure 8-15: Example output from the show router-id command

awplus# show router-id

awplus>show router-id

Router ID: 10.55.0.2 (automatic)

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.46 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show system

This command displays general system information about the device, including the

hardware installed, memory, and software versions loaded. It also displays location and

contact details when these have been set.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show system

Mode User Exec and Privileged Exec

Example To display configuration information, use the command:

Usage For a stacked configuration, if this command is entered on the stack master, it will display

the information for all the stack members. A stack member heading will be displayed to

distinguish the different information for every stack member.

Output Figure 8-16: Example output from the show system command

Related Commands show system environment

awplus# show system

GS900#show system

Stack System Status Thu May 29 02:40:53 2014

Stack member 1

Board ID Bay Board Name Rev Serial number

--------------------------------------------------------------------------------

Base 392 GS948MX X1-0 A04939H131100021

--------------------------------------------------------------------------------

RAM: Total: 494848 kB Free: 396052 kB

Flash: 62.0MB Used: 45.4MB Available: 16.6MB

--------------------------------------------------------------------------------

Environment Status : Normal

Uptime : 0 days 00:40:53

Bootloader version : 3.0.3

Current software : GS900-5.4.4E-1.1.rel

Software version : 5.4.4E-0.1

Build date : Thu May 29 01:32:39 NZST 2015

Current boot config: flash:/default.cfg (file exists)

System Name

GS900

System Contact

System Location

GS900#

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.47

show system environment

This command displays the current environmental status of your device and any attached

PSU, XEM, or other expansion option. The environmental status covers information about

temperatures, fans, and voltage.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show system environment

Mode User Exec and Privileged Exec

Usage For a stacked configuration, if this command is entered on the stack master, it will display

the information for all the stack members. A stack member heading will be displayed to

distinguish the different information for every stack member.

Example To display the system’s environmental status, use the command:

Output Figure 8-17: Example output from the show system environment command

Related Commands show system

awplus# show system environment

Stack Environment Monitoring Status

Stack member 1:

Overall Status: Normal

Resource ID: 1 Name: GS948MX

ID Sensor (Units) Reading Low Limit High Limit Status

1 Fan: Fan 1 (Rpm) 4344 3000 - Ok

2 Voltage: 1.8V (Volts) 1.804 1.617 1.978 Ok

3 Voltage: 1.0V (Volts) 0.995 0.896 1.099 Ok

4 Voltage: 3.3V (Volts) 3.291 2.960 3.613 Ok

5 Voltage: 5.0V (Volts) 5.066 4.477 5.498 Ok

6 Voltage: 1.2V (Volts) 1.187 1.072 1.318 Ok

7 Temp: CPU (Degrees C) 50 -10 90 Ok

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.48 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show system interrupts

Use this command to display the number of interrupts for each IRQ (Interrupt Request)

used to interrupt input lines on a PIC (Programmable Interrupt Controller) on your switch.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show system interrupts

Mode User Exec and Privileged Exec

Example To display information about the number of interrupts for each IRQ in your device, use the

command:

Output Figure 8-18: Example output from the show system interrupts command

Related Commands show system environment

awplus# show system interrupts

awplus#show system interrupts

CPU0

5: 10428098 Enabled 0 MIPS linux-kernel-bde

6: 0 Enabled 0 MIPS bcma-usb-ohci:usb1, bcma-usb-ehci:

usb2

7: 300725368 Enabled 0 MIPS timer

18: 598364339 Enabled 0 MIPS-CC bcma_i2c

22: 4909 Enabled 0 MIPS-CC serial

31: 1 Enabled 0 MIPS-GPIO GPIO-Ethernet PHY

35: 2 Enabled 0 MIPS-GPIO GPIO-ECO Button

40: 4 Enabled 0 MIPS-GPIO PSU Interrupt

42: 0 Enabled 0 MIPS-GPIO PSU2 power good

43: 0 Enabled 0 MIPS-GPIO PSU1 power good

ERR: 0

awplus#

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.49

show system mac

This command displays the physical MAC address available on a standalone switch, or a

stack. This command also shows the virtual MAC address for a for a stack if the stack virtual

MAC address feature is enabled with the stack virtual-mac or the stack enable

command.

Syntax show system mac

Mode User Exec and Privileged Exec

Usage This command also displays the virtual MAC address, if the VCStack Plus virtual MAC

address feature is enabled with the stack virtual-mac command.

For information about this VCStack Plus feature, see the section Fixed or Virtual MAC

Addressing in the VCStack Introduction chapter.

Example To display the physical MAC address enter the following command:

Output Figure 8-19: Example output from the show system mac command

Output Figure 8-20: Example output showing how to use the stack virtual-mac command

and the show system mac command

Related Commands stack virtual-mac

awplus# show system mac

awplus#show system mac

eccd.6d9d.4eed

awplus#configure terminal

Enter configuration commands, one per line. End with CNTL/Z.

awplus(config)#stack virtual-mac

% Please check that the new MAC 0000.cd37.0065 is unique within

the network.

% Save the config and restart the system for this change to take

effect.

Member1#copy run start

Building configuration...

[OK]

Member1#reload

reboot system? (y/n): y

... Rebooting at user request ...

Loading default configuration

....

awplus login: manager

Password:

awplus>show system mac

eccd.6d9d.4eed

Virtual MAC Address 0000.cd37.0065

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.50 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show system pci device

Use this command to display the PCI devices on your switch.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show system pci device

Mode User Exec and Privileged Exec

Example To display information about the PCI devices on your switch, use the command:

Output Example output from the show system pci device command

Related Commands show system environment

show system pci tree

awplus# show system pci device

awplus#show system pci device

00:0c.0 Class 0200: 11ab:00d1 (rev 01)

Flags: bus master, 66Mhz, medium devsel, latency 128, IRQ 113

Memory at 5ffff000 (32-bit, non-prefetchable) [size=4K]

Memory at 58000000 (32-bit, non-prefetchable) [size=64M]

00:0d.0 Class 0200: 11ab:00d1 (rev 01)

Flags: bus master, 66Mhz, medium devsel, latency 128, IRQ 116

Memory at 57fff000 (32-bit, non-prefetchable) [size=4K]

Memory at 50000000 (32-bit, non-prefetchable) [size=64M]

Member1#show system pci device

00:00.0 Class 0600: 14e4:5300 (rev 01)

Subsystem: 14e4:5300

Flags: bus master, fast devsel, latency 0, IRQ 5

Memory at 18000000 (64-bit, non-prefetchable) [size=16K]

Memory at <unassigned> (64-bit, non-prefetchable) [size=128M]

Capabilities: [40] Power Management version 3

Capabilities: [58] #09 [0078]

Capabilities: [48] Message Signalled Interrupts: 64bit+ Queue=0/0 Enable

Capabilities: [d0] #10 [0041]

00:01.0 Class 0200: 14e4:b321 (rev 12)

Subsystem: 14e4:4d4c

Flags: bus master, fast devsel, latency 0, IRQ 5

Memory at 08000000 (64-bit, non-prefetchable) [size=256K]

Capabilities: [48] Power Management version 3

Capabilities: [50] Vital Product Data

Capabilities: [58] Message Signalled Interrupts: 64bit+ Queue=0/3 Enable

Capabilities: [a0] #11 [0000]

Capabilities: [ac] #10 [0002]

Member1#

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.51

show system pci tree

Use this command to display the PCI tree on your switch.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show system pci tree

Mode User Exec and Privileged Exec

Example To display information about the PCI tree on your switch, use the command:

Output Figure 8-21: Example output from the show system pci tree command

Related Commands show system environment

show system pci device

awplus# show system pci tree

awplus>show system pci tree

-[00]-+-0c.0 11ab:00d1

\-0d.0 11ab:00d1

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.52 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show system pluggable

This command displays brief pluggable transceiver information showing the pluggable

type, the pluggable serial number, and the pluggable port on the switch. Different types

of pluggable transceivers are supported in different models of switch. See your Allied

Telesis dealer for more information about the models of pluggables that your switch

supports.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show system pluggable [<port-list>]

Mode User Exec and Privileged Exec

Usage Entering this command will display the information for all pluggable transceivers in the

system. In a stack, a separate heading will be displayed to distinguish each stack member’s

information.

Example To display brief information about pluggable transceivers installed in port1.0.1

through port1.0.4, use the command:

Output Figure 8-22: Example output from the show system pluggable port1.0.1-1.0.4

command

Parameter Description

<port-list> The ports to display information about. The port list can be:

■a switch port (e.g. port1.0.12)

■a continuous range of ports separated by a hyphen,

e.g. port1.0.1-1.0.24

■a comma-separated list of ports and port ranges,

e.g. port1.0.1,port1.0.4-1.2.24.

awplus# show system pluggable port1.0.1-1.0.4

System Pluggable Information

Port Manufacturer Device Serial Number Datecode Type

--------------------------------------------------------------------------------

1.0.1 AGILENT HFBR-5710L 0401312315461272 040131 1000BASE-SX

1.0.2 AGILENT QBCU-5730R AK0614GKF7 060408 1000BASE-T

1.0.3 AGILENT HFBR-5710L 0305130112182696 030513 1000BASE-SX

1.0.4 AGILENT HBCU-5710R AK051300SM 050402 1000BASE-T

--------------------------------------------------------------------------------

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.53

Example To display information about the pluggable transceiver installed in port1.0.1, use the

command:

Output Figure 8-23: Example output from the show system pluggable port1.0.1 command

awplus# show system pluggable port1.0.1

System Pluggable Information

Port Manufacturer Device Serial Number Datecode Type

--------------------------------------------------------------------------------

1.0.1 AGILENT HFBR-5710L 0401312315461272 040131 1000BASE-SX

--------------------------------------------------------------------------------

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.54 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Table 8-7: Parameters in the output from the show system pluggables command

Related Commands show system environment

show system pluggable detail

show system pluggable diagnostics

Parameter Description

Stack member The stack member number.

Port Specifies the vendor’s name for the installed pluggable

transceiver.

Vendor Name Specifies the vendor’s name for the installed pluggable

transceiver.

Device Name Specifies the device name for the installed pluggable

transceiver.

Device Type Specifies the device type for the installed pluggable

transceiver.

Serial Number Specifies the serial number for the installed pluggable

transceiver.

Manufacturing

Datecode Specifies the manufacturing datecode for the installed

pluggable transceiver. Checking the manufacturing

datecode with the vendor may be useful when

determining Laser Diode aging issues. See the Trouble-

shoot Fiber and Pluggable Issues section in the System

Configuration and Monitoring Commands chapter.

SFP Laser

Wavelength

Specifies the laser wavelength of the installed pluggable

transceiver.

Datecode Specifies the manufacturing datecode for the installed

pluggable transceiver. Checking the manufacturing

datecode with the vendor may be useful when

determining Laser Diode aging issues. See the Trouble-

shoot Fiber and Pluggable Issues section in the System

Configuration and Monitoring Commands chapter.

Device Type Specifies the device type for the installed pluggable

transceiver

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.55

show system pluggable detail

This command displays detailed pluggable transceiver information showing the

pluggable type, the pluggable serial number, and the pluggable port on the switch.

Different types of pluggable transceivers are supported in different models of switch. See

your Allied Telesis dealer for more information about the models of pluggables that your

switch supports.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show system pluggable [<port-list>] detail

Mode User Exec and Privileged Exec

Usage For a stacked configuration, if this command is entered on the stack master, it will display

detailed information about the pluggable transceivers for all the stack members. A stack

member heading will be displayed to distinguish the different pluggable transceiver

information for every stack member.

In addition to the information about pluggable transceivers displayed using the show

system pluggable command (port, manufacturer, serial number, manufacturing

datecode, and type information), the show system pluggable detail command displays

the following information:

■SFP Laser Wavelength: Specifies the laser wavelength of the installed pluggable

transceiver

■Single mode Fiber: Specifies the link length supported by the pluggable transceiver

using single mode fiber

■OM1 (62.5μm) Fiber: Specifies the link length (in μm - micron) supported by the

pluggable transceiver using 62.5 micron multi-mode fiber.

■OM2 (50 μm) Fiber: Specifies the link length (in μm - micron) supported by the

pluggable transceiver using 50 micron multi-mode fiber.

■Diagnostic Calibration: Specifies whether the pluggable transceiver supports DDM

or DOM Internal or External Calibration.

« Internal is displayed if the pluggable transceiver supports DDM or DOM Internal

Calibration.

« External is displayed if the pluggable transceiver supports DDM or DOM External

Calibration.

« - is displayed if SFP or SFP+ DDM Internal Calibration or External Calibration is not

supported.

■Power Monitoring: Displays the received power measurement type, which can be

either OMA (Optical Module Amplitude) or Avg (Average Power) measured in μW.

Parameter Description

<port-list> The ports to display information about. The port list can be:

■a switch port (e.g. port1.0.12)

■a continuous range of ports separated by a hyphen,

e.g. port1.0.1-1.0.24

■a comma-separated list of ports and port ranges, e.g.

port1.0.1,port1.0.4-1.2.24.

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.56 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Example To display detailed information about the pluggable transceivers installed in a particular

port on the switch, use a command like:

To display detailed information about all the pluggable transceivers installed on the

switch, use the command:

Output Figure 8-24: Example output from the show system pluggable detail command on a

switch

Example To display detailed information about the pluggable transceivers installed on a stack, use

the command:

Note For parameters that are not supported or not specified, a hyphen is displayed

instead.

awplus# show system pluggable port1.0.24 detail

awplus# show system pluggable detail

awplus#show system pluggable port1.0.24 detail

System Pluggable Information Detail

Port1.0.24

==========

Vendor Name: AGILENT

Device Name: HFCT-5710L

Device Type: 1000BASE-LX

Serial Number: 0402142241184360

Manufacturing Datecode: 040214

SFP Laser Wavelength: -

Link Length Supported

Single Mode Fiber : 10Km

OM1 (62.5um) Fiber: 550m

OM2 (50um) Fiber : 550m

Diagnostic Calibration: Internal

Power Monitoring: Avg

FEC BER support: -

awplus# show system pluggable detail

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.57

Output Figure 8-25: Example output from the show system pluggable detail command on a

stack

Table 8-8: Parameters in the output from the show system pluggables detail

command:

awplus#show system pluggable detail

System Pluggable Information Detail

Stack member 1:

Port1.0.24

==========

Vendor Name: AGILENT

Device Name: HFCT-5710L

Device Type: 1000BASE-LX

Serial Number: 0402142241184360

Manufacturing Datecode: 040214

SFP Laser Wavelength: -

Link Length Supported

Single Mode Fiber : 10Km

OM1 (62.5um) Fiber: 550m

OM2 (50um) Fiber : 550m

Diagnostic Calibration: Internal

Power Monitoring: Avg

FEC BER support: -

Stack member 2:

Port2.0.24

==========

Vendor Name: FINISAR CORP.

Device Name: FTRJ-8519-7D-CSC

Device Type: 1000BASE-SX

Serial Number: P430KGY

Manufacturing Datecode: 030718

SFP Laser Wavelength: 850nm

Link Length Supported

Single Mode Fiber : -

OM1 (62.5um) Fiber: 300m

OM2 (50um) Fiber : 550m

Diagnostic Calibration: Internal

Power Monitoring: OMA

FEC BER support: Yes

Parameter Description

Stack member The stack member number..

Port Specifies the port the pluggable transceiver is installed in.

Vendor Name Specifies the vendor’s name for the installed pluggable

transceiver.

Device Name Specifies the device name for the installed pluggable

transceiver.

Device Type Specifies the device type for the installed pluggable

transceiver..

Serial Number Specifies the serial number for the installed pluggable

transceiver.

Manufacturing

Datecode

Specifies the manufacturing datecode for the installed

pluggable transceiver. Checking the manufacturing

datecode with the vendor may be useful when determining

Laser Diode aging issues. See the Trouble-shoot Fiber and

Pluggable Issues section in the System Configuration and

Monitoring Commands chapter.

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.58 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Related Commands show system environment

show system pluggable

show system pluggable diagnostics

SFP Laser

Wavelength Specifies the laser wavelength of the installed pluggable

transceiver.

Single Mode Fiber Specifies the link length supported by the pluggable

transceiver using single mode fiber.

OM1 (62.5um)

Fiber

Specifies the link length (in μm - micron) supported by the

pluggable transceiver using 62.5 micron multi-mode fiber.

OM2 (50um) Fiber Specifies the link length (in μm - micron) supported by the

pluggable transceiver using 50 micron multi-mode fiber.

Diagnostic

Calibration

Specifies whether the pluggable transceiver supports DDM

or DOM Internal or External Calibration:

Internal is displayed if the pluggable transceiver supports

DDM or DOM Internal Calibration.

External is displayed if the pluggable transceiver supports

DDM or DOM External Calibration.

- is displayed if SFP or SFP+ DDM Internal Calibration or

External Calibration is not supported.

Power Monitoring Displays the received power measurement type, which can

be either OMA (Optical Module Amplitude) or Avg (Average

Power) measured in μW.

Parameter Description

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.59

show system pluggable diagnostics

This command displays diagnostic information about SFP and SFP+ pluggable

transceivers, which support Digital Diagnostic Monitoring (DDM).

Different types of pluggable transceivers are supported in different models of switch. See

your switch’s Datasheet for more information about the models of pluggables that your

switch supports.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show system pluggable [<port-list>] diagnostics

Parameter Description

<port-list> The ports to display information about. The port list can be:

■a switch port (e.g. port1.0.12)

■a continuous range of ports separated by a hyphen, e.g. port1.0.1-1.0.24

■a comma-separated list of ports and port ranges, e.g. port1.0.1,port1.0.4-

1.2.24.

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.60 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Mode User Exec and Privileged Exec

Usage For a stacked configuration, if this command is entered on the stack master, it will display

information about the pluggable transceivers for all the stack members. A stack member

heading will be displayed to distinguish different pluggable transceiver information for

every stack member.

Modern optical SFP and SFP+ transceivers support Digital Diagnostics Monitoring (DDM)

functions.

Diagnostic monitoring features allow you to monitor real-time parameters of the

pluggable transceiver, such as optical output power, optical input power, temperature,

laser bias current, and transceiver supply voltage. Additionally, RX LOS (Loss of Signal) is

shown when the received optical level is below a preset threshold. Monitor these

parameters to check on the health of all transceivers, selected transceivers or a specific

transceiver installed in a switch.

Examples To display detailed information about all pluggable transceivers installed on a standalone

switch, use the command:

Output Figure 8-26: Example output from the show system pluggable diagnostics command

To display detailed information about the pluggable transceiver installed in port1.0.22

on a standalone switch, use the command:

Output Figure 8-27: Example output from the show system pluggable diagnostics

port1.0.22 command

awplus# show system pluggable diagnostics

awplus#show system pluggable diagnostics

System Pluggable Information Diagnostics

Port1.0.21 Status Alarms Warnings

Reading Alarm Max Min Warning Max Min

Temp: (Degrees C) 29.387 - 100.00 -40.00 - 85.000 -10.00

Vcc: (Volts) 3.339 - 3.465 3.135 - 3.400 3.200

Tx Bias: (mA) 10.192 - 37.020 3.260 - 34.520 5.760

Tx Power: (mW) 17.872 - 35.643 8.953 - 28.313 11.271

Rx Power: (mW) 0.006 Low 15.849 0.025 Low 12.589 0.040

Rx LOS: Rx Down

Port1.0.22 Status Alarms Warnings

Reading Alarm Max Min Warning Max Min

Temp: (Degrees C) 29.387 - 100.00 -40.00 - 85.000 -10.00

Vcc: (Volts) 3.378 - 3.630 2.970 - 3.465 3.135

Tx Bias: (mA) 2.802 - 6.000 1.000 - 5.000 1.000

Tx Power: (mW) 2.900 - 11.000 0.600 - 10.000 0.850

Rx Power: (mW) 1.739 - 18.000 0.000 - 10.000 0.200

Rx LOS: Rx Up

awplus# show system pluggable diagnostics port1.0.22

awplus#show system pluggable port1.0.22 diagnostics

System Pluggable Information Diagnostics

Port1.0.22 Status Alarms Warnings

Reading Alarm Max Min Warning Max Min

Temp: (Degrees C) 29.387 - 100.00 -40.00 - 85.000 -10.00

Vcc: (Volts) 3.378 - 3.630 2.970 - 3.465 3.135

Tx Bias: (mA) 2.802 - 6.000 1.000 - 5.000 1.000

Tx Power: (mW) 2.900 - 11.000 0.600 - 10.000 0.850

Rx Power: (mW) 1.739 - 18.000 0.000 - 10.000 0.200

Rx LOS: Rx Up

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.61

Table 8-9: Parameters in the output from the show system pluggables diagnostics

command

Related Commands show system environment

show system pluggable

show system pluggable detail

Parameter Description

Temp

(Degrees C)

Shows the temperature inside the transceiver.

Vcc (Volts) Shows voltage supplied to the transceiver.

Tx Bias (mA) Shows current to the Laser Diode in the transceiver.

Tx Power

(mW)

Shows the amount of light transmitted from the transceiver.

Rx Power

(mW) Shows the amount of light received in the transceiver.

Rx LOS Shows when the received optical level falls below a preset

threshold.

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.62 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show system serialnumber

This command shows the serial number information for the switch.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show system serialnumber

Mode User Exec and Privileged Exec

Example To display the serial number information for the switch, use the command:

Output Figure 8-28: Example output from the show system serialnumber command

awplus# show system serialnumber

awplus#show system serialnumber

45AX5300X

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.63

show tech-support

This command generates system and debugging information for the switch and saves it to

a file. You can optionally limit the command output to display only information for a given

protocol or feature.

The command generates a large amount of output, which is saved to a file in compressed

format. The output file name can be specified by outfile option. If the output file already

exists, a new file name is generated with the current time stamp. If the output filename

does not end with “.gz”, then “.gz” is appended to the filename. Since output files may be

too large for Flash on the switch we recommend saving files to either an SD card, USB

storage device, or TFTP server whenever possible to avoid switch lockup. This method is

not likely to be appropriate when running the working set option of ATMF across a range

of physically separated switches.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

The output of this command may include the result of the following commands:

Syntax show tech-support {all|[atmf|dhcpsn|epsr|igmp|ip|ipv6|mld|pim|rip|

stack|stp|system|tacacs+]|[outfile <filename>]}

Parameter Description

all Display full information

atmf Display ATMF- specific information

dhcpsn Display DHCP Snooping specific information

epsr Display EPSR specific information

igmp Display IGMP specific information

ip Display IP specific information

ipv6 Display IPv6 specific information

mld Display MLD specific information

outfile Output file name

pim Display PIM related information

rip Display Routing Information Protocol (RIP) related information

stack Display stacking device information

stp Display STP specific information

system Display general system information

tacacs+ Display TACACS+ information

|Output modifier

>Output redirection

>> Output redirection (append)

<filename>Specifies a name for the output file. If no name is specified, this file

will be saved as: tech-support.txt.gz.

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.64 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Default Captures all information for the switch.

By default the output is saved to the file ‘tech-support.txt.gz’ in the current directory.

If this file already exists in the current directory then a new file is generated with the time

stamp appended to the file name, for example ‘tech-support20080109.txt.gz’, s o t h e

last saved file is retained.

Usage This command is useful for collecting a large amount of information about all protocols or

specific protocols on your switch so that it can then be analyzed for troubleshooting

purposes. The output of this command can be provided to technical support staff when

reporting a problem.

Mode Privileged Exec

Examples show tech-support

Output The output of this command may include the result of the following commands:

show arp

show arp security

show arp security interface

show arp security statistics

show boot

show counter dhcp-client

show counter log

show counter mail

show counter ntp

show counter ping-poll

show counter snmp-server

show counter stack

show cpu

show cpu history

show diagnostic channel-group

show etherchannel

show etherchannel detail

show exception log

show interface

show interface brief

show ip dhcp snooping

show ip dhcp snooping acl

show ip dhcp snooping binding

show ip dhcp snooping interface

show ip dhcp snooping statistics

show ip igmp groups

show ip igmp interface

show ip interface

show ip route

show ip source binding

show lacp-counter

awplus# show tech-support

Note You can manage your show output, or make it a more selective, by using a command

modifier. For information on using show-command modifiers see “Controlling “show”

Command Output” on page 1.35.

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.65

show lacp sys-id

show log

show log permanent

show memory

show memory allocations

show memory history

show memory pools

show ntp associations

show ntp status

show platform

show platform port

show power-inline

show reboot history

show running-config

show spanning-tree

show stack

show stack detail (see the show stack command)

show startup-config

show static-channel-group

show system

show system environment

show system pluggable

show users

show vlan brief (see the show vlan command)

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.66 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

speed (asyn)

This command changes the console speed from the switch. Note that a change in console

speed is applied for subsequent console sessions. Exit the current session to enable the

console speed change using the clear line console command.

Syntax speed <console-speed-in-bps>

Default The default console speed baud rate is 9600 bps.

Mode Line Configuration

Usage This command is used to change the console (asyn) port speed. Set the console speed to

match the transmission rate of the device connected to the console (asyn) port on your

switch.

Example To set the terminal console (asyn0) port speed from the switch to 57600 bps, then exit the

session, and log in again to enable the change, use the commands:

Related Commands line

clear line console

show running-config

Parameter Description

<console-speed-in-bps>Console speed Baud rate

1200 1200 Baud

2400 2400 Baud

9600 9600 Baud

19200 19200 Baud

38400 38400 Baud

57600 57600 Baud

115200 115200 Baud

awplus# configure terminal

awplus(config)# line console 0

awplus(config-line)# speed 57600

awplus(config-line)# exit

awplus(config)# exit

awplus# exit

The new console speed of 57600 bps is applied after exiting the session and before

awplus login:

Password:

awplus>

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.67

show startup-config

speed

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.68 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

system territory (deprecated)

This command has been deprecated in version 5.4.4-0.1. It now has no effect.

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 8.69

terminal monitor

Use this command to display debugging output on a terminal.

To display the cursor after a line of debugging output, press the Enter key.

Use the command terminal no monitor to stop displaying debugging output on the

terminal, or use the timeout option to stop displaying debugging output on the terminal

after a set time.

Syntax terminal monitor [<1-60>]

terminal no monitor

Default Disabled

Mode User Exec and Privileged Exec

Examples To display debugging output on a terminal, enter the command:

To specify timeout of debugging output after 60 seconds, enter the command:

To stop displaying debugging output on the terminal, use the command:

Related Commands All debug commands

Parameter Description

<1-60>Set a timeout between 1 and 60 seconds for terminal output.

awplus# terminal monitor

awplus# terminal monitor 60

awplus# terminal no monitor

System Configuration and Monitoring Commands

Software Reference for GS900MX/MPX Series Switches

8.70 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

undebug all

This command applies the functionality of the no debug all command.

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 9.1

Chapter 9: Debugging and Logging

Introduction ...........................................................................................................................................9.2

Debugging .............................................................................................................................................9.2

Logging to a Terminal .................................................................................................................9.2

Turning Off Debugging ..............................................................................................................9.3

Logging....................................................................................................................................................9.3

Log Outputs....................................................................................................................................9.4

Debugging and Logging

Software Reference for GS900MX/MPX Series Switches

9.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Introduction

AlliedWare PlusTM has a comprehensive debugging and logging facility in various

protocols and components. This chapter describes how to start/stop debugging and

logging. For detailed descriptions of the commands used to configure logging, see

Chapter 10, Logging Commands.

Debugging

Many protocols have debug commands. Debug commands, when used with the

parameters, log protocol-specific information. For example, using the debug mstp

protocol command, results in the device writing all debugging messages generated by

the MSTP algorithm to the logging system.

On using a debug command, the protocol continues to generate output until the no

parameter is used with the command. To specify where logging output is sent, and the

level of events to log, use the log commands in Chapter 10, Logging Commands.

Logging to a Terminal

To start debugging to the terminal:

Step 1: Turn on the debug options by using the relevant debug

command

Step 2: Run the terminal monitor command

awplus> enable

awplus# configure terminal

awplus(config)# debug <protocol> (parameter)

awplus(config)# exit

awplus# terminal monitor

Sample Output This is a sample output of the debug rsvp events command displayed on the terminal:

awplus#terminal monitor

Dec 2 16:41:49 localhost RSVP[6518]: RSVP: RSVP message sent to

10.10.23.60/32 via interface vlan2

Dec 2 16:41:57 localhost RSVP[6518]: RSVP: Received an RSVP message

of type RSVP Reservation from 192.168.0.60 via interface vlan2

Dec 2 16:41:57 localhost RSVP[6518]: RSVP: Received a RESV message

from 10.10.23.60/32

Debugging and Logging

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 9.3

Turning Off Debugging

To turn off debugging, use the no debug or undebug command. When a protocol is

specified with the no debug or undebug commands, debugging is stopped for the

specified protocol. To stop all debugging, use the all parameter with these commands.

awplus(config)# no debug rstp

awplus#undebug all

Logging

Protocols generate important debugging messages by default, and send them to the

logging system. Additional more detailed messages can be generated by enabling

debugging (“Debugging” on page 9.2).

Messages can be filtered based on: the program that generated the message, the severity

level of the message, the type of facility that generated the message, substrings within the

message text.

The severity levels in order are:

■emergencies

■alerts

■critical

■errors

■warnings

■notifications

■informational

■debugging

The facility categories are:

■auth Security/authorization messages

■authpriv Security/authorization messages (private)

■cron Clock daemon

■daemon System daemons

■ftp FTP daemon

■kern Kernel messages

■lpr Line printer subsystem

■mail Mail system

■news Network news subsystem

■syslog Messages generated internally by syslogd

■user Random user-level messages

■uucp UUCP subsystem

Debugging and Logging

Software Reference for GS900MX/MPX Series Switches

9.4 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Log Outputs

The following types of logging output are available:

■buffered

■permanent

■terminal

■console

■host

■email

Buffered log The buffered log is a file stored in RAM on the device. Because it is stored in RAM its

content does not survive a reboot of the device. A device can only have one instance of

the buffered log. The buffered log is enabled by default and has a filter to include

messages with a severity level of ‘notifications’ and above. The buffered log can be

enabled or disabled using the commands:

Additional filters can be added and removed using the commands described in log

buffered (filter) command on page 10.8:

The following log buffered commands are available:

awplus# configure terminal

awplus(config)# log buffered

awplus(config)# no log buffered

awplus(config)# log buffered {facility|level|msgtext|program}

awplus(config)# no log buffered {facility|level|msgtext|

program}

show log Displays the entire contents of the buffered log.

show log tail Displays the 10 most recent entries in the buffered

log.

show log tail <10-250> Displays a specified number of the most recent

entries in the buffered log.

show log config Displays the configuration of all log outputs.

log buffered size Specify the amount of memory the buffered log

may use.

clear log Remove the contents of the buffered log (and

permanent log if it exists).

clear log buffered Remove the contents of the buffered log only.

default log buffered Restore the buffered log to its default

configuration.

Debugging and Logging

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 9.5

Permanent log A device can only have one instance of the permanent log. The permanent log is enabled

by default and has a filter to include messages with a severity level of ‘warning’ and above.

The permanent log can be disabled using the command:

Additional filters can be added and removed using the commands described in log

permanent (filter):

Host log A host log sends log messages to a remote syslog server. A device may have many syslog

hosts configured. To configure or remove a host use the commands:

where <ip-addr> is the IP address of the remote syslog server.

There are no default filters associated with host outputs when they are created. Filters can

be added and removed with the log host (filter) command on page 10.23.

awplus# configure terminal

awplus(config)# no log permanent

awplus# configure terminal

awplus(config)# log permanent {facility|level|msgtext|

program}

awplus(config)# no log permanent {facility|level|msgtext|

program}

Table 9-1: Permanent log commands

Command Description

show log permanent Display the entire contents of the permanent log.

show log permanent tail Display the 10 most recent entries in the permanent

log.

show log permanent tail

<10-250> Display a specified number of the most recent

entries in the permanent log.

show log config Display the configuration of all log outputs.

log permanent size Specify the amount of memory the permanent log

may use.

clear log Remove the contents of the buffered log and

permanent log.

clear log permanent Remove the contents of the permanent log only.

default log permanent Restore the permanent log to its default

configuration.

awplus# configure terminal

awplus(config)# log host <ip-addr>9

awplus(config)# no log host <ip-addr>9

Debugging and Logging

Software Reference for GS900MX/MPX Series Switches

9.6 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

It is not possible to view the log messages sent to this type of output as they are not

retained on the device. They must be viewed on the remote device. The other host log

commands are:

Email log An email log sends log messages to an email address. A device may have many email logs

configured. To configure or remove an email log use the commands:

where <email-address> is the destination email address.

There are no default filters associated with email outputs when they are created. Filters

can be added and removed with the commands described in log email (filter):

It is not possible to view the log messages sent to this type of output as they are not

retained on the device. They must be viewed by the email recipient.

The other email log commands are:

Email logs are sent in batches of approximately 20 messages and have the subject line

“Log messages”

show log config Displays the configuration of all log outputs.

log host time Adjust the time information in messages to a time zone

other than the one configured on this device.

default log host

<ip-address> Restores the device default settings for log sent to a remote

syslog server.

awplus# configure terminal

awplus(config)# log email <email-address>

awplus(config)# no log email <email-address>

awplus# configure terminal

awplus(config)# log email <email-address> {facility|level|

msgtext|program}

awplus(config)# no log email <email-address> {facility|

level|msgtext|program}

show log config Displays the configuration of all log outputs.

log email time Adjust the time information in messages to a time zone

other than the one configured on this device.

default log email Restores the device default settings for log messages sent to

an email address.

Note An email server and “from” address must be configured on the device in order

for email logs to work:

■mail from <email-address>

■mail smtpserver <ip-address>

where the <email-address> is the ‘From:’ field on the sent email, and the

<ip-address> is the email’s destination SMTP server.

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.1

Chapter 10: Logging Commands

Command List .................................................................................................................................... 10.2

clear exception log ........................................................................................................................... 10.2

clear log ................................................................................................................................................ 10.2

clear log buffered.............................................................................................................................. 10.3

clear log permanent......................................................................................................................... 10.3

default log buffered ......................................................................................................................... 10.4

default log console........................................................................................................................... 10.4

default log email................................................................................................................................ 10.5

default log host.................................................................................................................................. 10.5

default log monitor .......................................................................................................................... 10.6

default log permanent .................................................................................................................... 10.6

log buffered......................................................................................................................................... 10.7

log buffered (filter)............................................................................................................................ 10.8

log buffered size..............................................................................................................................10.11

log console ........................................................................................................................................10.12

log console (filter) ...........................................................................................................................10.13

log email.............................................................................................................................................10.16

log email (filter)................................................................................................................................10.17

log email time...................................................................................................................................10.20

log host ...............................................................................................................................................10.22

log host (filter)..................................................................................................................................10.23

log host time.....................................................................................................................................10.26

log monitor (filter)...........................................................................................................................10.28

log permanent .................................................................................................................................10.30

log permanent (filter) ....................................................................................................................10.31

log permanent size.........................................................................................................................10.33

log-rate-limit nsm ...........................................................................................................................10.34

show counter log ............................................................................................................................10.35

show exception log........................................................................................................................10.36

show log .............................................................................................................................................10.37

show log config ...............................................................................................................................10.39

show log permanent......................................................................................................................10.42

show running-config log..............................................................................................................10.43

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Command List

This chapter provides an alphabetical reference of commands used to configure logging.

clear exception log

This command resets the contents of the exception log, but does not remove the

associated core files.

Syntax clear exception log

Mode Privileged Exec

Example

clear log

This command removes the contents of the buffered and permanent logs.

Syntax clear log

Mode Privileged Exec

Example To delete the contents of the buffered and permanent log use the command:

Validation

Commands

show log

Related Commands clear log buffered

clear log permanent

Note When this command is used within a stacked environment, it will remove the

contents of the exception logs in all stack members.

awplus# clear exception log

Note When this command is used within a stacked environment, it will remove the

contents of the buffered and permanent logs in all stack members.

awplus# clear log

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.3

clear log buffered

This command removes the contents of the buffered log.

Syntax clear log buffered

Mode Privileged Exec

Example To delete the contents of the buffered log use the following commands:

Validation

Commands

show log

Related Commands clear log

clear log permanent

This command removes the contents of the permanent log.

Syntax clear log permanent

Mode Privileged Exec

Example To delete the contents of the permanent log use the following commands:

Validation

Commands

show log

Related Commands clear log

clear log buffered

Note When this command is used within a stacked environment, it will remove the

contents of the buffered logs in all stack members.

awplus# clear log buffered

Note When this command is used within a stacked environment, it will remove the

contents of the buffered logs in all stack members.

awplus# clear log permanent

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.4 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

default log buffered

This command restores the default settings for the buffered log stored in RAM. By default

the size of the buffered log is 50 kB and it accepts messages with the severity level of

“warnings” and above.

Syntax default log buffered

Default The buffered log is enabled by default.

Mode Global Configuration

Example To restore the buffered log to its default settings use the following commands:

Validation

Commands

show log config

Related Commands log buffered

log buffered size

default log console

This command restores the default settings for log messages sent to the terminal when a

log console command is issued. By default all messages are sent to the console when a

log console command is issued.

Syntax default log console

Mode Global Configuration

Example To restore the log console to its default settings use the following commands:

Validation

Commands

show log config

Related Commands log console

log console (filter)

awplus# configure terminal

awplus(config)# default log buffered

awplus# configure terminal

awplus(config)# default log console

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.5

default log email

This command restores the default settings for log messages sent to an email address. By

default no filters are defined for email addresses. Filters must be defined before messages

will be sent. This command also restores the remote syslog server time offset value to local

(no offset).

Syntax default log email <email-address>

Mode Global Configuration

Example To restore the default settings for log messages sent to the email address

admin@alliedtelesis.com use the following commands:

Related Commands show log config

default log host

This command restores the default settings for log sent to a remote syslog server. By

default no filters are defined for remote syslog servers. Filters must be defined before

messages will be sent. This command also restores the remote syslog server time offset

value to local (no offset).

Syntax default log host <ip-addr>

Mode Global Configuration

Example To restore the default settings for messages sent to the remote syslog server with IP

address 10.32.16.21 use the following commands:

Validation

Commands

show log config

Related Commands log email

Parameter Description

<email-address> The email address to send log messages to

awplus# configure terminal

awplus(config)# default log email admin@alliedtelesis.com

Parameter Description

<ip-addr>The IP address of a remote syslog server

awplus# configure terminal

awplus(config)# default log host 10.32.16.21

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.6 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

default log monitor

This command restores the default settings for log messages sent to the terminal when a

terminal monitor command is used.

Syntax default log monitor

Default All messages are sent to the terminal when a terminal monitor command is used.

Mode Global Configuration

Example To restore the log monitor to its default settings use the following commands:

Related Commands log monitor (filter)

show log config

default log permanent

This command restores the default settings for the permanent log stored in NVS. By

default, the size of the permanent log is 50 kB and it accepts messages with the severity

level of warnings and above.

Syntax default log permanent

Default The permanent log is enabled by default.

Mode Global Configuration

Example To restore the permanent log to its default settings use the following commands:

Related Commands log permanent

log permanent size

show log config

awplus# configure terminal

awplus(config)# default log monitor

awplus# configure terminal

awplus(config)# default log permanent

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.7

log buffered

This command configures the device to store log messages in RAM. Messages stored in

RAM are not retained on the device over a restart. Once the buffered log reaches its

configured maximum allowable size old messages will be deleted to make way for new

ones.

Syntax log buffered

no log buffered

Default The buffered log is configured by default.

Mode Global Configuration

Examples To configured the device to store log messages in RAM use the following commands:

To configure the device to not store log messages in a RAM buffer use the following

commands:

Validation

Commands

show log config

Related Commands default log buffered

log buffered (filter)

log buffered size

awplus# configure terminal

awplus(config)# log buffered

awplus# configure terminal

awplus(config)# no log buffered

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.8 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

log buffered (filter)

Use this command to create a filter to select messages to be sent to the buffered log.

Selection can be based on the priority/ severity of the message, the program that

generated the message, the logging facility used, a sub-string within the message or a

combination of some or all of these.

The no variant of this command removes the corresponding filter, so that the specified

messages are no longer sent to the buffered log.

Syntax log buffered [level <level>] [program <program-name>]

[facility <facility>] [msgtext <text-string>]

no log buffered [level <level>] [program <program-name>]

[facility <facility>] [msgtext <text-string>]

Parameter Description

level Filter messages to the buffered log by severity level.

<level>The minimum severity of message to send to the buffered log. The

level can be specified as one of the following numbers or level

names, where 0 is the highest severity and 7 is the lowest severity:

0 emergencies: System is unusable

1 alerts Action must be taken immediately

2 critical Critical conditions

3 errors Error conditions

4 warnings Warning conditions

5 notices Normal, but significant, conditions

6 informational Informational messages

7 debugging Debug-level messages

program Filter messages to the buffered log by program. Include messages

from a specified program in the buffered log.

<program-

name>

The name of a program to log messages from, either one of the

following predefined program names (not case-sensitive), or

another program name (case-sensitive) that you find in the log

output.

rip Routing Information Protocol (RIP)

rsvp Resource Reservation Protocol (RSVP)

dot1x IEEE 802.1X Port-Based Access Control

lacp Link Aggregation Control Protocol (LACP)

stp Spanning Tree Protocol (STP)

rstp Rapid Spanning Tree Protocol (RSTP)

mstp Multiple Spanning Tree Protocol (MSTP)

imi Integrated Management Interface (IMI)

imish Integrated Management Interface Shell (IMISH)

epsr Ethernet Protection Switched Rings (EPSR)

rmon Remote Monitoring

loopprot Loop Protection

poe Power-inline (Power over Ethernet)

dhcpsn DHCP snooping (DHCPSN)

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.9

Default By default the buffered log has a filter to select messages whose severity level is “notices

(5)” or higher. This filter may be removed using the no variant of this command.

Mode Global Configuration

Examples To add a filter to send all messages generated by EPSR that have a severity of notices or

higher to the buffered log use the following commands:

To add a filter to send all messages containing the text “Bridging

initialization”, to the buffered log use the following commands:

To remove a filter that sends all messages generated by EPSR that have a severity of

notices or higher to the buffered log use the following commands:

facility Filter messages to the buffered log by syslog facility.

<facility>Specify one of the following syslog facilities to include messages

from in the buffered log:

kern Kernel messages

user Random user-level messages

mail Mail system

daemon System daemons

auth Security/authorization messages

syslog Messages generated internally by syslogd

lpr Line printer subsystem

news Network news subsystem

uucp UUCP subsystem

cron Clock daemon

authpriv Security/authorization messages (private)

ftp FTP daemon

msgtext Select messages containing a certain text string (maximum 128

characters).

<text-

string>

A text string to match (maximum 128 characters). This is case

sensitive, and must be the last text on the command line.

Parameter Description

awplus# configure terminal

awplus(config)# log buffered level notices program epsr

awplus# configure terminal

awplus(config)# log buffered msgtext Bridging initialization

awplus# configure terminal

awplus(config)# no log buffered level notices program epsr

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.10 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

To remove a filter that sends all messages containing the text “Bridging

initialization”, to the buffered log use the following commands:

Validation

Commands

show log config

Related Commands default log buffered

log buffered

log buffered size

awplus# configure terminal

awplus(config)# no log buffered msgtext Bridging initialization

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.11

log buffered size

This command configures the amount of memory that the buffered log is permitted to

use. Once this memory allocation has been filled old messages will be deleted to make

room for new messages.

Syntax log buffered size <50-250>

Mode Global Configuration

Example To allow the buffered log to use up to 100 kB of RAM use the following commands:

Validation

Commands

show log config

Related Commands default log buffered

log buffered

Parameter Description

<50-250> Size of the RAM log in kilobytes

awplus# configure terminal

awplus(config)# log buffered size 100

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.12 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

log console

This command configures the device to send log messages to consoles. The console log is

configured by default to send messages to the devices main console port.

Use the no variant of this command to configure the device not to send log messages to

consoles.

Syntax log console

no log console

Mode Global Configuration

Examples To configure the device to send log messages use the following commands:

To configure the device not to send log messages in all consoles use the following

commands:

Validation

Commands

show log config

Related Commands log console (filter)

awplus# configure terminal

awplus(config)# log console

awplus# configure terminal

awplus(config)# no log console

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.13

log console (filter)

This command creates a filter to select messages to be sent to all consoles when the log

console command is given. Selection can be based on the priority/severity of the

message, the program that generated the message, the logging facility used, a sub-string

within the message or a combination of some or all of these.

Syntax log console [level <level>] [program <program-name>]

[facility <facility>] [msgtext <text-string>]

no log console [level <level>] [program <program-name>]

[facility <facility>] [msgtext <text-string>]

Parameter Description

level Filter messages by severity level.

<level>The minimum severity of message to send. The level can be specified

as one of the following numbers or level names, where 0 is the highest

severity and 7 is the lowest severity:

0 emergencies: System is unusable

1|alerts Action must be taken immediately

2|critical Critical conditions

3|errors Error conditions

4|warnings Warning conditions

5|notices Normal, but significant, conditions

6|informational Informational messages

7|debugging Debug-level messages

program Filter messages by program. Include messages from a specified

program.

<program-

name>

The name of a program to log messages from, either one of the

following predefined program names (not case-sensitive), or another

program name (case-sensitive) that you find in the log output.

rip Routing Information Protocol (RIP)

rsvp Resource Reservation Protocol (RSVP)

dot1x IEEE 802.1X Port-Based Access Control

lacp Link Aggregation Control Protocol (LACP)

stp Spanning Tree Protocol (STP)

rstp Rapid Spanning Tree Protocol (RSTP)

mstp Multiple Spanning Tree Protocol (MSTP)

imi Integrated Management Interface (IMI)

imish Integrated Management Interface Shell (IMISH)

epsr Ethernet Protection Switched Rings (EPSR)

rmon Remote Monitoring

loopprot Loop Protection

poe Power-inline (Power over Ethernet)

dhcpsn DHCP snooping (DHCPSN)

facility Filter messages to the buffered log by syslog facility.

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.14 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Default By default the buffered log has a filter to select messages whose severity level is

critical or higher. This filter may be removed using the no variant of this command.

This filter may be removed and replaced by filters that are more selective.

Mode Global Configuration

Examples To create a filter to send all messages generated by MSTP that have a severity of info or

higher to console instances where the log console command has been given, remove the

default filter that includes everything use the following commands:

and then use the command:

To create a filter to send all messages containing the text “Bridging

initialization” to console instances where the log console command has been

given use the following commands:

To remove a filter that sends all messages generated by EPSR that have a severity of

notices or higher to consoles use the following commands:

<facility>Specify one of the following syslog facilities to include messages from:

kern Kernel messages

user Random user-level messages

mail Mail system

daemon System daemons

auth Security/authorization messages

syslog Messages generated internally by syslogd

lpr Line printer subsystem

news Network news subsystem

uucp UUCP subsystem

cron Clock daemon

authpriv Security/authorization messages (private)

ftp FTP daemon

msgtext Select messages containing a certain text string

<text-

string>

A text string to match. This is case sensitive, and must be the last text

on the command line.

Parameter Description

awplus# configure terminal

awplus(config)# log console level info program mstp

awplus# configure terminal

awplus(config)# log console msgtext "Bridging initialization"

awplus# configure terminal

awplus(config)# no log console level notices program epsr

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.15

To remove a default filter that includes sending critical, alert and emergency

level messages to the console use the following commands:

Validation

Commands

show log config

Related Commands log console

awplus# configure terminal

awplus(config)# no log console level critical

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.16 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

log email

This command configures the device to send log messages to an email address. The email

address is specified in this command.

Syntax log email <email-address>

Default By default no filters are defined for email log targets. Filters must be defined before

messages will be sent.

Mode Global Configuration

Example To have log messages emailed to the email address admin@alliedtelesis.com use

the following commands:

Validation

Commands

show log config

Related Commands default log email

log email

Parameter Description

<email-address> The email address to send log messages to

awplus# configure terminal

awplus(config)# log email admin@alliedtelesis.com

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.17

log email (filter)

This command creates a filter to select messages to be sent to an email address. Selection

can be based on the priority/ severity of the message, the program that generated the

message, the logging facility used, a sub-string within the message or a combination of

some or all of these.

The no variant of this command configures the device to no longer send log messages to

a specified email address. All configuration relating to this log target will be removed.

Syntax log email <email-address> [level <level>] [program <program-name>]

[facility <facility>] [msgtext <text-string>]

no log email <email-address> [level <level>] [program <program-name>]

[facility <facility>] [msgtext <text-string>]

Parameter Description

<email-

address>

The email address to send logging messages to

level Filter messages by severity level.

<level>The minimum severity of messages to send. The level can be

specified as one of the following numbers or level names, where 0 is

the highest severity and 7 is the lowest severity:

0 emergencies: System is unusable

1 alerts Action must be taken immediately

2 critical Critical conditions

3 errors Error conditions

4 warnings Warning conditions

5 notices Normal, but significant, conditions

6 informational Informational messages

7 debugging Debug-level messages

program Filter messages by program. Include messages from a specified

program in the log.

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.18 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

<program-

name>

The name of a program to log messages from, either one of the

following predefined program names (not case-sensitive), or

another program name (case -sensitive) that you find in the log

output.

rip Routing Information Protocol (RIP)

rsvp Resource Reservation Protocol (RSVP)

dot1x IEEE 802.1X Port-Based Access Control

lacp Link Aggregation Control Protocol (LACP)

stp Spanning Tree Protocol (STP)

rstp Rapid Spanning Tree Protocol (RSTP)

mstp Multiple Spanning Tree Protocol (MSTP)

imi Integrated Management Interface (IMI)

imish Integrated Management Interface Shell (IMISH)

epsr Ethernet Protection Switched Rings (EPSR)

rmon Remote Monitoring

loopprot Loop Protection

poe Power-inline (Power over Ethernet)

dhcpsn DHCP snooping (DHCPSN)

facility Filter messages to the log by syslog facility.

<facility>Specify one of the following syslog facilities to include messages

from in the log:

kern Kernel messages

user Random user-level messages

mail Mail system

daemon System daemons

auth Security/authorization messages

syslog Messages generated internally by syslogd

lpr Line printer subsystem

news Network news subsystem

uucp UUCP subsystem

cron Clock daemon

authpriv Security/authorization messages (private)

ftp FTP daemon

msgtext Select messages containing a certain text string

<text-

string>

A text string to match. This is case sensitive, and must be the last

text on the command line.

Parameter Description

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.19

Mode Global Configuration

Examples To create a filter to send all messages generated by EPSR that have a severity of notices

or higher to the email address admin@homebase.com use the following commands:

To create a filter to send all messages containing the text “Bridging

initialization”, to the email address admin@homebase.com use the following

commands:

To create a filter to send messages with a severity level of informational and above to

the email address admin@alliedtelesis.com use the following commands:

To stop the device emailing log messages emailed to the email address

admin@alliedtelesis.com use the following commands:

To remove a filter that sends all messages generated by EPSR that have a severity of

notices or higher to the email address admin@homebase.com use the following

commands:

To remove a filter that sends messages with a severity level of informational and

above to the email address admin@alliedtelesis.com use the following

commands:

Related Commands default log email

log email

show log config

awplus# configure terminal

awplus(config)# log email admin@homebase.com level notices

program epsr

awplus# configure terminal

awplus(config)# log email admin@homebase.com msgtext

"Bridging initialization"

awplus# configure terminal

awplus(config)# log email admin@alliedtelesis.com level

informational

awplus# configure terminal

awplus(config)# no log email admin@homebase.com

awplus# configure terminal

awplus(config)# no log email admin@homebase.com level

notices program epsr

awplus# configure terminal

awplus(config)# no log email admin@alliedtelesis.com level

informational

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.20 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

log email time

This command configures the time used in messages sent to an email address. If the

syslog server is in a different time zone to your switch then the time offset can be

configured using either the utc-offset parameter option keyword or the local-offset

parameter option keyword, where utc-offset is the time difference from UTC (Universal

Time, Coordinated) and local-offset is the difference from local time.

Syntax log email <email-address> time {local|local-offset|utc-offset {plus|

minus}<0-24>}

Default The default is local time.

Mode Global Configuration

Usage Use the local option if the email recipient is in the same time zone as this device. Messages

will display the time as on the local device when the message was generated.

Use the offset option if the email recipient is in a different time zone to this device. Specify

the time offset of the email recipient in hours. Messages will display the time they were

generated on this device but converted to the time zone of the email recipient.

Examples To send messages to the email address test@home.com in the same time zone as the

switch’s local time zone, use the following commands:

Parameter Description

<email-address> The email address to send log messages to

time Specify the time difference between the email recipient and the

switch you are configuring.

local The switch is in the same time zone as the email recipient

local-offset The switch is in a different time zone to the email recipient. Use

the plus or minus keywords and specify the difference (offset)

from local time of the switch to the email recipient in hours.

utc-offset The switch is in a different time zone to the email recipient. Use

the plus or minus keywords and specify the difference (offset)

from UTC time of the switch to the email recipient in hours.

plus Negative offset (difference) from the switch to the email

recipient.

minus Positive offset (difference) from the switch to the email

recipient.

<0-24> World Time zone offset in hours

awplus# configure terminal

awplus(config)# log email admin@base.com time local 0

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.21

To send messages to the email address admin@base.com with the time information

converted to the time zone of the email recipient, which is 3 hours ahead of the switch’s

local time zone, use the following commands:

To send messages to the email address user@remote.com with the time information

converted to the time zone of the email recipient, which is 3 hours behind the switch’s UTC

time zone, use the following commands:

Validation

Commands

show log config

Related Commands default log buffered

awplus# configure terminal

awplus(config)# log email admin@base.com time local-offset

plus 3

awplus# configure terminal

awplus(config)# log email user@remote.com time utc-offset

minus 3

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.22 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

log host

This command configures the device to send log messages to a remote syslog server via

UDP port 514. The IP address of the remote server must be specified. By default no filters

are defined for remote syslog servers. Filters must be defined before messages will be

sent.

Syntax log host <ip-addr>

no log host <ip-addr>

Mode Global Configuration

Examples To configure the device to send log messages to a remote syslog server with IP address

10.32.16.99 use the following commands:

To stop the device from sending log messages to the remote syslog server with IP address

10.32.16.99 use the following commands:

Validation

Commands

show log config

Related Commands default log host

Parameter Description

<ip-addr> The IP address of a remote syslog server in dotted decimal format

A.B.C.D

awplus# configure terminal

awplus(config)# log host 10.32.16.99

awplus# configure terminal

awplus(config)# no log host 10.32.16.99

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.23

log host (filter)

This command creates a filter to select messages to be sent to a remote syslog server.

Selection can be based on the priority/severity of the message, the program that

generated the message, the logging facility used, a substring within the message or a

combination of some or all of these.

The no variant of this command configures the device to no longer send log messages to

a remote syslog server. The IP address of the syslog server must be specified. All

configuration relating to this log target will be removed.

Syntax log host <ip-addr> [level <level>] [program <program-name>]

[facility <facility>] [msgtext <text-string>]

no log host <ip-addr> [level <level>] [program <program-name>]

[facility <facility>] [msgtext <text-string>]

Parameter Description

<ip-addr>The IP address of a remote syslog server

level Filter messages by severity level.

<level> The minimum severity of messages to send. The level can be specified

as one of the following numbers or level names, where 0 is the highest

severity and 7 is the lowest severity:

0|emergencies: System is unusable

1|alerts Action must be taken immediately

2|critical Critical conditions

3|errors Error conditions

4|warnings Warning conditions

5|notices Normal, but significant, conditions

6|informational Informational messages

7|debugging Debug-level messages

program Filter messages by program. Include messages from a specified

program in the log.

<program-

name>

The name of a program to log messages from, either one of the

following predefined program names (not case-sensitive), or another

program name (case -sensitive) that you find in the log output.

rip Routing Information Protocol

rsvp Resource Reservation Protocol (RSVP)

dot1x IEEE 802.1X Port-Based Access Control

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.24 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Mode Global Configuration

Examples To create a filter to send all messages generated by EPSR that have a severity of notices

or higher to a remote syslog server with IP address 10.32.16.21 use the following

commands:

<program-

name>

(cont.)

lacp Link Aggregation Control Protocol (LACP)

stp Spanning Tree Protocol (STP)

rstp Rapid Spanning Tree Protocol (RSTP)

mstp Multiple Spanning Tree Protocol (MSTP)

imi Integrated Management Interface (IMI)

imish Integrated Management Interface Shell (IMISH)

epsr Ethernet Protection Switched Rings (EPSR)

rmon Remote Monitoring

loopprot Loop Protection

poe Power-inline (Power over Ethernet)

dhcpsn DHCP snooping (DHCPSN)

facility Filter messages to the log by syslog facility.

<facility>Specify one of the following syslog facilities to include messages from

in the log:

kern Kernel messages

user Random user-level messages

mail Mail system

daemon System daemons

auth Security/authorization messages

syslog Messages generated internally by syslogd

lpr Line printer subsystem

news Network news subsystem

uucp UUCP subsystem

cron Clock daemon

authpriv Security/authorization messages (private)

ftp FTP daemon

msgtext Select messages containing a certain text string

<text-

string>

A text string to match. This is case sensitive, and must be the last text

on the command line.

Parameter Description

awplus# configure terminal

awplus(config)# log host 10.32.16.21 level notices program epsr

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.25

To create a filter to send all messages containing the text “Bridging

initialization”, to a remote syslog server with IP address 10.32.16.21 use the

following commands:

To create a filter to send messages with a severity level of informational and above to

the syslog server with IP address 10.32.16.21 use the following commands:

To remove a filter that sends all messages generated by EPSR that have a severity of

notices or higher to a remote syslog server with IP address 10.32.16.21 use the

following commands:

To remove a filter that sends all messages containing the text “Bridging

initialization”, to a remote syslog server with IP address 10.32.16.21 use the

following commands:

To remove a filter that sends messages with a severity level of informational and

above to the syslog server with IP address 10.32.16.21 use the following commands:

Related Commands default log host

show log config

awplus# configure terminal

awplus(config)# log host 10.32.16.21 msgtext "Bridging

initialization"

awplus# configure terminal

awplus(config)# log host 10.32.16.21 level informational

awplus# configure terminal

awplus(config)# no log host 10.32.16.21 level notices program

epsr

awplus# configure terminal

awplus(config)# no log host 10.32.16.21 msgtext "Bridging

initialization"

awplusawpluls# configure terminal

awplus(config)# no log host 10.32.16.21 level informational

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.26 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

log host time

This command configures the time used in messages sent to a remote syslog server. If the

syslog server is in a different time zone to your switch then the time offset can be

configured using either the utc-offset parameter option keyword or the local-offset

parameter option keyword, where utc-offset is the time difference from UTC (Universal

Time, Coordinated) and local-offset is the difference from local time.

Syntax log host <email-address> time {local|local-offset|utc-offset {plus|

minus} <0-24>}

Default The default is local time.

Mode Global Configuration

Usage Use the local option if the remote syslog server is in the same time zone as the switch.

Messages will display the time as on the local device when the message was generated.

Use the offset option if the email recipient is in a different time zone to this device. Specify

the time offset of the remote syslog server in hours. Messages will display the time they

were generated on this device but converted to the time zone of the remote syslog server.

Examples To send messages to the remote syslog server with the IP address 10.32.16.21 in the

same time zone as the switch’s local time zone, use the following commands:

To send messages to the remote syslog server with the IP address 10.32.16.12 with

the time information converted to the time zone of the remote syslog server, which is 3

hours ahead of the switch’s local time zone, use the following commands:

Parameter Description

<email-address> The email address to send log messages to

time Specify the time difference between the email recipient and the

switch you are configuring.

local The switch is in the same time zone as the email recipient

local-offset The switch is in a different time zone to the email recipient. Use

the plus or minus keywords and specify the difference (offset)

from local time of the switch to the email recipient in hours.

utc-offset The switch is in a different time zone to the email recipient. Use

the plus or minus keywords and specify the difference (offset)

from UTC time of the switch to the email recipient in hours.

plus Negative offset (difference) from the switch to the syslog server.

minus Positive offset (difference) from the switch to the syslog server.

<0-24> World Time zone offset in hours

awplus# configure terminal

awplus(config)# log host 10.32.16.21 time local 0

awplus# configure terminal

awplus(config)# log host 10.32.16.12 time local-offset plus 3

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.27

To send messages to the remote syslog server with the IP address 10.32.16.02 with

the time information converted to the time zone of the email recipient, which is 3 hours

behind the switch’s UTC time zone, use the following commands:

Validation

Commands

show log config

Related Commands default log buffered

awplus# configure terminal

awplus(config)# log host 10.32.16.02 time utc-offset minus 3

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.28 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

log monitor (filter)

This command creates a filter to select messages to be sent to the terminal when the

terminal monitor command is given. Selection can be based on the priority/severity of the

message, the program that generated the message, the logging facility used, a sub-string

within the message or a combination of some or all of these.

Syntax log monitor [level <level>] [program <program-name>]

[facility <facility>] [msgtext <text-string>]

no log monitor [level <level>] [program <program-name>]

[facility <facility>] [msgtext <text-string>]

Parameter Description

level Filter messages to the permanent log by severity level.

<level>The minimum severity of message to send to the log. The level can be

specified as one of the following numbers or level names, where 0 is

the highest severity and 7 is the lowest severity:

0|emergencies: System is unusable

1|alerts Action must be taken immediately

2|critical Critical conditions

3|errors Error conditions

4|warnings Warning conditions

5|notices Normal, but significant, conditions

6|informational Informational messages

7|debugging Debug-level messages

program Filter messages to the permanent log by program. Include messages

from a specified program in the log.

<program-

name>

The name of a program to log messages from, either one of the

following predefined program names (not case-sensitive), or another

program name (case -sensitive) that you find in the log output.

rip Routing Information Protocol (RIP)

rsvp Resource Reservation Protocol (RSVP)

dot1x IEEE 802.1X Port-Based Access Control

lacp Link Aggregation Control Protocol (LACP)

stp Spanning Tree Protocol (STP)

rstp Rapid Spanning Tree Protocol (RSTP)

mstp Multiple Spanning Tree Protocol (MSTP)

imi Integrated Management Interface (IMI)

<program-

name>

(cont.)

imish Integrated Management Interface Shell (IMISH)

epsr Ethernet Protection Switched Rings (EPSR)

rmon Remote Monitoring

loopprot Loop Protection

poe Power-inline (Power over Ethernet)

dhcpsn DHCP snooping (DHCPSN)

facility Filter messages to the permanent log by syslog facility.

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.29

Default By default there is a filter to select all messages. This filter may be removed and replaced

by filters that are more selective.

Mode Global Configuration

Examples To create a filter to send all messages generated by MSTP that have a severity of info or

higher to terminal instances where the terminal monitor command has been given use

the following commands:

To remove a filter that sends all messages generated by EPSR that have a severity of

notices or higher to the terminal use the following commands:

To remove a default filter that includes sending everything to the terminal use the

following commands:

Validation

Commands

show log config

Related Commands terminal monitor

<facility>Specify one of the following syslog facilities to include messages from

in the log:

kern Kernel messages

user Random user-level messages

mail Mail system

daemon System daemons

auth Security/authorization messages

syslog Messages generated internally by syslogd

lpr Line printer subsystem

news Network news subsystem

uucp UUCP subsystem

cron Clock daemon

authpriv Security/authorization messages (private)

ftp FTP daemon

msgtext Select messages containing a certain text string

<text-

string>

A text string to match. This is case sensitive, and must be the last text

on the command line.

Parameter Description

awplus# configure terminal

awplus(config)# log monitor level info program mstp

awplus# configure terminal

awplus(config)# no log monitor level notices program epsr

awplus# configure terminal

awplus(config)# no log monitor level debugging

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.30 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

log permanent

This command configures the device to send permanent log messages to non-volatile

storage (NVS) on the device. The content of the permanent log is retained over a reboot.

Once the permanent log reaches its configured maximum allowable size old messages

will be deleted to make way for new messages.

The no variant of this command configures the device not to send any messages to the

permanent log. Log messages will not be retained over a restart.

Syntax log permanent

no log permanent

Mode Global Configuration

Examples To enable permanent logging use the following commands:

To disable permanent logging use the following commands:

Validation

Commands

show log config

Related Commands default log permanent

log permanent (filter)

log permanent size

show log permanent

awplus# configure terminal

awplus(config)# log permanent

awplus# configure terminal

awplus(config)# no log permanent

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.31

log permanent (filter)

This command creates a filter to select messages to be sent to the permanent log.

Selection can be based on the priority/ severity of the message, the program that

generated the message, the logging facility used, a sub-string within the message or a

combination of some or all of these.

The no variant of this command removes the corresponding filter, so that the specified

messages are no longer sent to the permanent log.

Syntax log permanent [level <level>] [program <program-name>]

[facility <facility>] [msgtext <text-string>]

no log permanent [level <level>] [program <program-name>]

[facility <facility>] [msgtext <text-string>]

Parameter Description

level Filter messages to the permanent log by severity level.

<level>The minimum severity of message to send to the log. The level can be

specified as one of the following numbers or level names, where 0 is

the highest severity and 7 is the lowest severity:

0|emergencies: System is unusable

1|alerts Action must be taken immediately

2|critical Critical conditions

3|errors Error conditions

4|warnings Warning conditions

5|notices Normal, but significant, conditions

6|informational Informational messages

7|debugging Debug-level messages

program Filter messages to the permanent log by program. Include messages

from a specified program in the log.

<program-

name>

The name of a program to log messages from, either one of the

following predefined program names (not case-sensitive), or another

program name (case -sensitive) that you find in the log output.

rip Routing Information Protocol (RSVP)

rsvp Resource Reservation Protocol (RSVP)

dot1x IEEE 802.1X Port-Based Access Control

lacp Link Aggregation Control Protocol (LACP)

stp Spanning Tree Protocol (STP)

rstp Rapid Spanning Tree Protocol (RSTP)

mstp Multiple Spanning Tree Protocol (MSTP)

imi Integrated Management Interface (IMI)

imish Integrated Management Interface Shell (IMISH)

epsr Ethernet Protection Switched Rings (EPSR)

rmon Remote Monitoring

loopprot Loop Protection

poe Power-inline (Power over Ethernet)

dhcpsn DHCP snooping (DHCPSN)

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.32 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Default By default the buffered log has a filter to select messages whose severity level is notices

(5) or higher. This filter may be removed using the no variant of this command.

Mode Global Configuration

Examples To create a filter to send all messages generated by EPSR that have a severity of notices

or higher to the permanent log use the following commands:

To create a filter to send all messages containing the text “Bridging

initialization”, to the permanent log use the following commands:

Validation

Commands

show log config

Related Commands default log permanent

log permanent

log permanent size

show log permanent

facility Filter messages to the permanent log by syslog facility.

<facility>Specify one of the following syslog facilities to include messages from

in the log:

kern Kernel messages

user Random user-level messages

mail Mail system

daemon System daemons

auth Security/authorization messages

syslog Messages generated internally by syslogd

lpr Line printer subsystem

news Network news subsystem

uucp UUCP subsystem

cron Clock daemon

authpriv Security/authorization messages (private)

ftp FTP daemon

msgtext Select messages containing a certain text string

<text-

string>

A text string to match. This is case sensitive, and must be the last text

on the command line.

Parameter Description

awplus# configure terminal

awplus(config)# log permanent level notices program epsr

awplus# configure terminal

awplus(config)# log permanent msgtext Bridging initialization

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.33

log permanent size

This command configures the amount of memory that the permanent log is permitted to

use. Once this memory allocation has been filled old messages will be deleted to make

room for new messages.

Syntax log permanent size <50-250>

Mode Global Configuration

Example To allow the permanent log to use up to 100 kB of NVS use the following commands:

Validation

Commands

show log config

Related Commands default log permanent

log permanent

Parameter Description

<50-250> Size of the permanent log in kilobytes

awplus# configure terminal

awplus(config)# log permanent size 100

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.34 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

log-rate-limit nsm

This command limits the number of log messages generated by the switch for a given

interval.

Use the no variant of this command to revert to the default number of log messages

generated by the switch of up to 200 log messages per second.

Syntax log-rate-limit nsm messages <message-limit> interval <time-interval>

no log-rate-limit nsm

Default By default, the switch will allow 200 log messages to be generated per second.

Mode Global Configuration

Usage Previously, if the switch received a continuous stream of IGMP packets with errors, such as

when a packet storm occurs because of a network loop, then the switch generates a lot of

log messages using more and more memory, which may ultimately cause the switch to

shutdown. This log rate limiting feature constrains the rate that log messages are

generated by the switch.

Note that if within the given time interval, the number of log messages exceeds the limit,

then any excess log messages are discarded. At the end of the time interval, a single log

message is generated indicating that log messages were discarded due to the log rate

limit being exceeded.

Thus if the expectation is that there will be a lot of discarded log messages due to log rate

limiting, then it is advisable to set the time interval to no less than 100, which means that

there would only be one log message, indicating log excessive log messages have been

discarded.

Examples To limit the switch to generate up to 300 log messages per second, use the following

commands:

To return the switch the default setting, to generate up to 200 log messages per second,

use the following commands:

Parameter Description

<message-limit><1-65535>

The number of log messages generated by the switch.

<time-interval><0-65535>

The time period for log message generation in 1/100 seconds.

If an interval of 0 is specified then no log message rate limiting

is applied.

awplus# configure terminal

awplus(config)# log-rate-limit nsm messages 300 interval 100

awplus# configure terminal

awplus(config)# no log-rate-limit nsm

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.35

show counter log

This command displays log counter information.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show counter log

Mode User Exec and Privileged Exec

Example To display the log counter information, use the command:

Output Figure 10-1: Example output from the show counter log command

Table 10-1: Parameters in output of the show counter log command

Related Commands show log config

awplus# show counter log

Log counters

Total Received ......... 2328

Total Received P0 ......... 0

Total Received P1 ......... 0

Total Received P2 ......... 1

Total Received P3 ......... 9

Total Received P4 ......... 32

Total Received P5 ......... 312

Total Received P6 ......... 1602

Total Received P7 ......... 372

Parameter Description

Total Received Total number of messages received by the log

Total Received P0 Total number of Priority 0 (Emergency) messages received

Total Received P1 Total number of Priority 1 (Alert) messages received

Total Received P2 Total number of Priority 2 (Critical) messages received

Total Received P3 Total number of Priority 3 (Error) messages received

Total Received P4 Total number of Priority 4 (Warning) messages received

Total Received P5 Total number of Priority 5 (Notice) messages received

Total Received P6 Total number of Priority 6 (Info) messages received

Total Received P7 Total number of Priority 7 (Debug) messages received

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.36 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show exception log

This command displays the contents of the exception log. When used within a stacked

environment, this command will display the contents of the exception log for all the stack

members.

Syntax show exception log

Mode User Exec and Privileged Exec

Example To display the exception log, use the command:

Output Figure 10-2: Example output from the show exception log command on a switch

awplus# show exception log

awplus#show exception log

Stack member 1:

-------------------------------------------------------------------------

2014 Jan 27 09:57:47 local7.debug awplus corehandler : Process imish (PID:3746)

signal 11, core dumped to /flash/imish-x610-5.4.3-3.7-1-1390816667-3746.tgz

2014 Jan 27 09:57:47 local7.debug awplus corehandler : Process imish (PID:2504)

signal 11, core dumped to /flash/imish-x610-5.4.3-3.7-1-1390816667-2504.tgz

2014 Jan 27 09:58:02 local7.debug awplus corehandler : Process ospfd (PID:1512)

signal 5, core dumped to /flash/ospfd-x610-5.4.3-3.7-1-1390816682-1512.tgz

-------------------------------------------------------------------------

Stack member 2:

-------------------------------------------------------------------------

2014 Jan 27 09:58:16 local7.debug awplus-2 corehandler : Process imi (PID:1427)

signal 5, core dumped to /flash/imi-x610-5.4.3-3.7-2-1390816696-1427.tgz

-------------------------------------------------------------------------

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.37

show log

This command displays the contents of the buffered log.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show log [tail [<10-250>]]

Default By default the entire contents of the buffered log is displayed.

Mode User Exec, Privileged Exec and Global Configuration

Usage If the optional tail parameter is specified only the latest 10 messages in the buffered log

are displayed. A numerical value can be specified after the tail parameter to select how

many of the latest messages should be displayed.

Examples To display the contents of the buffered log use the command:

To display the 10 latest entries in the buffered log use the command:

Output Figure 10-3: Example output from the show log command

Parameter Description

tail Display only the latest log entries.

<10-250> Specify the number of log entries to display.

awplus# show log

awplus# show log tail 10

awplus#show log

--------------------------------------------------------------------

2011 Aug 29 07:55:22 kern.notice awplus kernel: Linux version 2.6.32.12-at1 (mak

er@awpmaker03-dl) (gcc version 4.3.3 (Gentoo 4.3.3-r3 p1.2, pie-10.1.5) ) #1 Wed

Dec 8 11:53:40 NZDT 2010

2011 Aug 29 07:55:22 kern.warning awplus kernel: No pci config register base in

dev tree, using default

2011 Aug 29 07:55:23 kern.notice awplus kernel: Kernel command line: console=tty

S0,9600 releasefile=GS900-5.4.4E-1.1.rel ramdisk=14688 bootversion=1.1.0-rc12

loglevel=1

extraflash=00000000

2011 Aug 29 07:55:25 kern.notice awplus kernel: RAMDISK: squashfs filesystem fou

nd at block 0

2011 Aug 29 07:55:28 kern.warning awplus kernel: ipifwd: module license 'Proprie

tary' taints kernel.

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.38 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Figure 10-4: Example output from the show log tail command

Related Commands show log config

show log permanent

awplus#show log tail

--------------------------------------------------------------------

2006 Nov 10 13:30:01 cron.notice crond[116]: USER manager pid 469 cmd logrotate /

etc/logrotate.conf

2006 Nov 10 13:30:01 cron.notice crond[116]: USER manager pid 471 cmd nbqueue --

wipe

2006 Nov 10 13:35:01 cron.notice crond[116]: USER manager pid 472 cmd nbqueue --

wipe

2006 Nov 10 13:40:01 cron.notice crond[116]: USER manager pid 477 cmd nbqueue --

wipe

2006 Nov 10 13:44:36 syslog.notice syslog-ng[67]: Log statistics;

processed=\’center(queued)=70\’, processed=\’2006 Nov 10 13:45:01 cron.notice

crond[116]: USER manager pid 478 cmd logrotate /etc/logrotate.conf

2006 Nov 10 13:45:01 cron.notice crond[116]: USER manager pid 480 cmd nbqueue --

wipe

2006 Nov 10 13:49:32 syslog.notice syslog-ng[67]: SIGHUP received, reloading

configuration;

2006 Nov 10 13:50:01 cron.notice crond[116]: USER manager pid 482 cmd nbqueue --

wipe

2006 Nov 10 13:55:01 cron.notice crond[116]: USER manager pid 483 cmd nbqueue --

wipe

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.39

show log config

This command displays information about the logging system. This includes the

configuration of the various log destinations, buffered, permanent, syslog servers (hosts)

and email addresses. This also displays the latest status information for each of these

destinations.

Syntax show log config

Mode User Exec, Privileged Exec and Global Configuration

Example To display the logging configuration use the command:

awplus# show log config

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.40 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Output Figure 10-5: Example output from the show log config command

Buffered log:

Status ......... enabled

Maximum size ... 100kb

Filters:

*1 Level ........ notices

Program ...... any

Facility ..... any

Message text . any

2 Level ........ informational

Program ...... mstp

Facility ..... daemon

Message text . any

Statistics ..... 1327 messages received, 821 accepted by filter (2006 Dec 11

10:36:16)

Permanent log:

Status ......... enabled

Maximum size ... 60kb

Filters:

1 Level ........ error

Program ...... any

Facility ..... any

Message text . any

*2 Level ........ warnings

Program ...... dhcp

Facility ..... any

Message text . "pool exhausted"

Statistics ..... 1327 messages received, 12 accepted by filter (2006 Dec 11

10:36:16)

Host 10.32.16.21:

Time offset .... +2:00

Offset type .... UTC

Filters:

1 Level ........ critical

Program ...... any

Facility ..... any

Message text . any

Statistics ..... 1327 messages received, 1 accepted by filter (2006 Dec 11

10:36:16)

Email admin@alliedtelesis.com:

Time offset .... +0:00

Offset type .... Local

Filters:

1 Level ........ emergencies

Program ...... any

Facility ..... any

Message text . any

Statistics ..... 1327 messages received, 0 accepted by filter (2006 Dec 11

10:36:16)

Monitor log:

Filters:

*1 Level ...... debugging

Program .... any

Facility ... any

Msg text ... any

Statistics ..... Not available

Console log:

Status ......... enabled

List of consoles:

1 .............. ttyS0

Filters:

*1 Level ...... critical

Program .... any

Facility ... any

Msg text ... any

Statistics ..... 1327 messages received, 1 accepted by filter (2006 Dec 11

10:36:16)

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.41

In the above example the ’*’ next to filter 1 in the buffered log configuration indicates that

this is the default filter. The permanent log has had its default filter removed, so none of

the filters are marked with “*’.

Related Commands show counter log

show log

show log permanent

Note Terminal log and console log cannot be set at the same time. If console logging

is enabled then the terminal logging is turned off.

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.42 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show log permanent

This command displays the contents of the permanent log.

When used within a stacked environment, this command will display the contents of the

permanent log for all the stack members, unless you specify a particular stack member.

Syntax show log permanent[<stack-ID>][tail [<10-250>]]

Default If the optional tail parameter is specified only the latest 10 messages in the permanent

log are displayed. A numerical value can be specified after the tail parameter to select

how many of the latest messages should be displayed.

Mode User Exec, Privileged Exec and Global Configuration

Example To display the permanent log of stack member 2, use the command:

Output Figure 10-6: Example output from the show log permanent command

Related Commands show log

Parameter Description

<stack-ID> Stack member number, from 1 to 4.

tail Display only the latest log entries.

<10-250> Specify the number of log entries to display.

awplus# show log permanent 2

awplus#show log permanent 2

Stack member 2:

-------------------------------------------------------------------------

2014 Feb 25 09:10:48 daemon.crit awplus-2 HPI: HOTSWAP Pluggable 2.0.51 hotswapped

in: AT-StackXS/1.0

2014 Feb 25 09:10:48 daemon.crit awplus-2 HPI: HOTSWAP Pluggable 2.0.52 hotswapped

in: 2127931-2

2014 Feb 25 09:10:50 user.crit awplus-2 VCS[922]: Member 1 (eccd.6d7d.a50e) has

joined the stack

2014 Feb 25 09:10:52 user.crit awplus-2 VCS[922]: Member 1 (eccd.6d7d.a50e) has

become the Active Master

2014 Feb 25 09:10:52 local6.alert awplus-2 VCS[922]: stack member has booted from

non-default location, SW version auto synchronization cannot be supported.

2014 Feb 25 09:10:52 user.crit awplus-2 VCS[922]: Stack Virtual MAC is

0000.cd37.0002

2014 Feb 25 09:11:46 user.crit awplus-2 ATMF[862]: awplus-x510 has joined. 1

member in total.

Logging Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 10.43

show running-config log

This command displays the current running configuration of the Log utility.

Syntax show running-config log

Mode Privileged Exec and Global Configuration

Example To display the current configuration of the log utility, use the command:

Related Commands show log

show log config

awplus# show running-config log

Logging Commands

Software Reference for GS900MX/MPX Series Switches

10.44 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 11.1

Chapter 11: Scripting Commands

Command List .................................................................................................................................... 11.2

activate.................................................................................................................................................. 11.2

echo........................................................................................................................................................ 11.3

wait......................................................................................................................................................... 11.4

Scripting Commands

Software Reference for GS900MX/MPX Series Switches

11.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Command List

This chapter provides commands used for command scripts.

activate

This command activates a script file.

Syntax activate [background] <script>

Mode Privileged Exec

Usage When a script is activated, the privilege level is set to 1 enabling User Exec commands to

run in the script. If you need to run Privileged Exec commands in your script you need to

add an enable (Privileged Exec mode) command to the start of your script. If you need to

run Global Configuration commands in your script you need to add a configure terminal

command after the enable command at the start of your script.

The activate command executes the script in a new shell. A terminal length shell

command, such as terminal length 0 may also be required to disable a delay that would

pause the display.

A script must be a text file with a filename extension of either .sh or .scp only for the

AlliedWare Plus™ CLI to activate the script file. The .sh filename extension indicates the file

is an ASH script, and the .scp filename extension indicates the file is an AlliedWare Plus™

script.

Examples To activate a command script to run as a background process, use the command:

Related Commands configure terminal

echo

enable (Privileged Exec mode)

wait

Parameter Description

background Activate a script to run in the background. A process that is running in

the background will operate as a separate task, and will not interrupt

foreground processing. Generally, we recommend running short,

interactive scripts in the foreground and longer scripts in the

background. The default is to run the script in the foreground.

consisting of commands documented in this software reference.

Note that you must use either a .scp or a .sh filename extension for a

valid script text file, as described below in the usage section for this

command.

awplus# activate background test.scp

Scripting Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 11.3

echo

This command echoes a string to the terminal, followed by a blank line.

Syntax echo <line>

Mode User Exec and Privileged Exec

Usage This command may be useful in CLI scripts, to make the script print user-visible comments.

Example To echo the string Hello World to the console, use the command:

Output

Related Commands activate

wait

Parameter Description

<line>The string to echo

awplus# echo Hello World

Hello World

Scripting Commands

Software Reference for GS900MX/MPX Series Switches

11.4 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

wait

This command pauses execution of the active script for the specified period of time.

Syntax wait <delay>

Default No wait delay is specified by default to pause script execution.

Mode Privileged Exec (when executed from a script not directly from the command line)

Usage Use this command to pause script execution in an .scp (AlliedWare Plus™ script) or an .sh

(ASH script) file executed by the activate command. The script must contain an enable

(Privileged Exec mode) command since the wait command is only executed in the

Privileged Exec mode.When a script is activated, the privilege level is set to 1 enabling

User Exec commands to run in the script. If you need to run Privileged Exec commands in

your script you need to add an enable (Privileged Exec mode) command to the start of

your script.

Related Commands activate

echo

enable (Privileged Exec mode)

Parameter Description

<delay><1-65335> Specify the time delay in seconds

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 12.1

Chapter 12: Interface Commands

Command List .................................................................................................................................... 12.2

description (interface) ..................................................................................................................... 12.2

interface (to configure) ................................................................................................................... 12.3

mru ......................................................................................................................................................... 12.5

mtu ......................................................................................................................................................... 12.7

show interface.................................................................................................................................... 12.9

show interface brief........................................................................................................................12.12

show interface status.....................................................................................................................12.13

shutdown...........................................................................................................................................12.15

Interface Commands

Software Reference for GS900MX/MPX Series Switches

12.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Command List

This chapter provides an alphabetical reference of commands used to configure and

display interfaces.

description (interface)

Use this command to add a description to a specific port or interface.

Syntax description <description>

Mode Interface Configuration

Example The following example uses this command to describe the device that a switch port is

connected to.

Parameter Description

<description> Text describing the specific interface.

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# description Boardroom PC

Interface Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 12.3

interface (to configure)

Use this command to select one or more interfaces to configure.

Syntax interface <interface-list>

interface lo

Usage A local loopback interface is one that is always available for higher layer protocols to use

and advertise to the network. Although a local loopback interface is assigned an IP

address, it does not have the usual requirement of connecting to a lower layer physical

entity. This lack of physical attachment creates the perception of a local loopback interface

always being accessible via the network.

Local loopback interfaces can be utilized by a number of protocols for various purposes.

They can be used to improve access to the switch and also increase its reliability, security,

scalability and protection. In addition, local loopback interfaces can add flexibility and

simplify management, information gathering and filtering.

One example of this increased reliability is for OSPF to advertise a local loopback interface

as an interface-route into the network irrespective of the physical links that may be “up” or

“down” at the time. This provides a higher probability that the routing traffic will be

received and subsequently forwarded.

Mode Global Configuration

Example The following example shows how to enter Interface mode to configure vlan1. Note how

the prompt changes.

Parameter Description

<interface-list>The interfaces or ports to configure.

An interface-list can be:

■an interface such as a VLAN (e.g. vlan2), a switch port

(e.g. port1.0.6), a static channel group (e.g. sa2) or a

dynamic (LACP) channel group (e.g. po2)

■a continuous range of interfaces, ports, static channel

groups or dynamic (LACP) channel groups separated by a

hyphen;

e.g. vlan2-8,orport1.0.1-1.0.6,orsa1-2, or

po1-2

■a comma-separated list of the above;

e.g. port1.0.1,port1.0.4-1.0.6. Do not mix

interface types in a list

The specified interfaces must exist.

lo The local loopback interface.

awplus# configure terminal

awplus(config)# interface vlan1

awplus(config-if)#

Interface Commands

Software Reference for GS900MX/MPX Series Switches

12.4 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

The following example shows how to enter Interface mode to configure the local

loopback interface.

Related Commands ip address

show interface

show interface brief

awplus# configure terminal

awplus(config)# interface lo

awplus(config-if)#

Interface Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 12.5

mru

Use this command to set the Maximum Receive Unit (MRU) size for switch ports, where

MRU is the maximum frame size (excluding headers) that switch ports can receive. For

more information, see “Support for Jumbo Frames” on page 14.16.

Use the no variant of this command to remove a previously specified Maximum Receive

Unit (MRU) size for switch ports, and restore the default MRU size (1500 bytes) for switch

ports.

Syntax mru <mru-size>

no mru

Default The default MRU size is 1500 bytes for switch ports.

Mode Interface Configuration for switch ports.

Usage Note that show interface output will only show MRU size for switch ports.

Examples To configure an MRU of 16357 bytes on port1.0.2, use the commands:

Note The figure of 1500 bytes specifies the payload only. For an IEEE 802.1q frame,

provision is made (internally) for the following additional components:

■Source and Destination addresses

■EtherType field

■Priority and VLAN tag fields

■FCS

These additional components increase the frame size internally to 1522 bytes.

Parameter Description

<mru-size><68-16357>

Specifies the Maximum Receive Unit (MRU) size in bytes, where 1500

bytes is the default Ethernet MRU size for an interface.

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# mru 16357

Interface Commands

Software Reference for GS900MX/MPX Series Switches

12.6 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

To configure an MRU of 1500 bytes on port1.0.2 to port1.0.4 use the commands:

To restore the MRU size of 1500 bytes on port1.0.2, use the commands:

Related Commands show interface

awplus# configure terminal

awplus(config)# interface port1.0.2-port1.0.4

awplus(config-if)# mru 1500

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# no mru

Interface Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 12.7

mtu

Use this command to set the Maximum Transmission Unit (MTU) size for VLANs, where

MTU is the maximum packet size that VLANs can transmit. The MTU size setting is applied

to both IPv4 and IPv6 packet transmission.

Use the no variant of this command to remove a previously specified Maximum

Transmission Unit (MTU) size for VLANs, and restore the default MTU size (1500 bytes) for

VLANs.

Syntax mtu <mtu-size>

no mtu

Default The default MTU size is 1500 bytes for VLAN interfaces.

Mode Interface Configuration for VLAN interfaces.

Usage If a switch receives an IPv4 packet for Layer 3 switching to another VLAN with an MTU size

smaller than the packet size, and if the packet has the ‘don’t fragment’ bit set, then the

switch will send an ICMP ‘destination unreachable’ (3) packet type and a ‘fragmentation

needed and DF set’ (4) code back to the source. For IPv6 packets bigger than the MTU size

of the transmitting VLAN interface, an ICMP ‘packet too big’ (ICMP type 2 code 0) message

is sent to the source.

Note that show interface output will only show MTU size for VLAN interfaces.

Examples To configure an MTU size of 1500 bytes on interface vlan2, use the commands:

To configure an MTU size of 1500 bytes on interfaces vlan2 to vlan4, use the

commands:

To restore the MTU size to the default MTU size of 1500 bytes on vlan2, use the

commands

Parameter Description

<mtu-size><68-1582>

Specifies the Maximum Transmission Unit (MTU) size in bytes, where

1500 bytes is the default Ethernet MTU size for an interface.

awplus# configure terminal

awplus(config)# interface vlan2

awplus(config-if)# mtu 1500

awplus# configure terminal

awplus(config)# interface vlan2-vlan4

awplus(config-if)# mtu 1500

awplus# configure terminal

awplus(config)# interface vlan2

awplus(config-if)# no mtu

Interface Commands

Software Reference for GS900MX/MPX Series Switches

12.8 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

To restore the MTU size to the default MTU size of 1500 bytes on vlan2 and vlan4, use

the commands

Related Commands show interface

awplus# configure terminal

awplus(config)# interface vlan2-vlan4

awplus(config-if)# no mtu

Interface Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 12.9

show interface

Use this command to display interface configuration and status.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Mode User Exec and Privileged Exec

Usage Note that the output displayed with this command will show MTU (Maximum

Transmission Unit) size for VLAN interfaces, and MRU (Maximum Received Unit) size for

switch ports.

Parameter Description

<interface-list>The interfaces or ports to configure. An interface-list can be:

■an interface such as a VLAN (e.g. vlan2), a switch port (e.g.

port1.0.6), a static channel group (e.g. sa2) or a

dynamic (LACP) channel group (e.g. po2)

■a continuous range of interfaces, ports, static channel

groups or dynamic (LACP) channel groups separated by a

hyphen;

e.g. vlan2-8,orport1.0.1-1.0.6,orsa1-2,

or po1-2

■a comma-separated list of the above;

e.g. port1.0.1,port1.0.4-1.0.6. Do not mix

interface types in a list

The specified interfaces must exist.

lo The local loopback interface.

Interface Commands

Software Reference for GS900MX/MPX Series Switches

12.10 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Example To display configuration and status information for all interfaces, use the command:

Figure 12-1: Example output from the show interface command

awplus# show interface

awplus#show interface

Interface port1.0.1

Scope: both

Link is UP, administrative state is UP

Thrash-limiting

Status Not Detected, Action link-down, Timeout 60(s)

Hardware is Ethernet, address is 0000.cd24.daeb

index 5001 metric 1 mru 1500

<UP,BROADCAST,RUNNING,MULTICAST>

current duplex half, current speed 100

configured duplex auto, configured speed auto, configured polarity auto

current ecofriendly lpi

configured ecofriendly lpi

SNMP link-status traps: Sending (Suppressed after 20 traps in 60 sec.)

input packets 2396, bytes 324820, dropped 0, multicast packets 2370

output packets 73235, bytes 406566, multicast packets 7321 broadcast packets 7

Time since last state change: 0 days 16:35:52

Interface port2.0.2

Scope: both

Link is DOWN, administrative state is UP

Thrash-limiting

Status Unknown, Action learn-disable, Timeout 1(s)

Hardware is Provisioned, address is 0000.0000.0000

index 8001 metric 1 mru 1500

<BROADCAST,MULTICAST>

current duplex half, current speed 100

configured duplex auto, configured speed auto, configured polarity auto

current ecofriendly lpi

configured ecofriendly lpi

SNMP link-status traps: Disabled

input packets 0, bytes 0, dropped 0, multicast packets 0

output packets 0, bytes 0, multicast packets 0 broadcast packets 0

Time since last state change: 0 days 16:35:52

Interface lo

Scope: both

Link is UP, administrative state is UP

Hardware is Loopback

index 1 metric 1

<UP,LOOPBACK,RUNNING>

SNMP link-status traps: Disabled

input packets 0, bytes 0, dropped 0, multicast packets 0

output packets 0, bytes 0, multicast packets 0 broadcast packets 0

Time since last state change: 0 days 16:35:52

Interface vlan1

Scope: both

Link is DOWN, administrative state is UP

Hardware is VLAN, address is 0000.cd24.daa8

index 201 metric 1 mtu 1500

arp ageing timeout 300

<UP,BROADCAST,MULTICAST>

VRF Binding: Not bound

SNMP link-status traps: Disabled

Bandwidth 1g

input packets 0, bytes 0, dropped 0, multicast packets 0

output packets 29, bytes 1334, multicast packets 0 broadcast packets 0

Time since last state change: 0 days 05:36:40

Interface Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 12.11

To display configuration and status information for interface lo, use the command:

Figure 12-2: Example output from the show interface lo command

To display configuration and status information for interfaces vlan1 and vlan2, use the

command:

Figure 12-3: Example output from the show interface vlan1,vlan2 command

Related Commands ecofriendly lpi

mru

mtu

show interface brief

awplus# show interface lo

awplus#show interface lo

Interface lo

Scope: both

Link is UP, administrative state is UP

Hardware is Loopback

index 1 metric 1

<UP,LOOPBACK,RUNNING>

SNMP link-status traps: Disabled

input packets 0, bytes 0, dropped 0, multicast packets 0

output packets 0, bytes 0, multicast packets 0 broadcast packets 0

Time since last state change: 69 days 01:28:47

awplus# show interface vlan1,vlan2

awplus#show interface vlan1,vlan2

Interface vlan1

Scope: both

Link is UP, administrative state is UP

Hardware is VLAN, address is 0015.77e9.5c50

IPv4 address 192.168.1.1/24 broadcast 192.168.1.255

index 201 metric 1 mtu 1500

arp ageing timeout 300

<UP,BROADCAST,RUNNING,MULTICAST>

SNMP link-status traps: Disabled

Bandwidth 1g

input packets 295606, bytes 56993106, dropped 5, multicast packets 156

output packets 299172, bytes 67379392, multicast packets 0 broadcast packets 0

Time since last state change: 0 days 14:22:39

Interface vlan2

Scope: both

Link is DOWN, administrative state is UP

Hardware is VLAN, address is 0015.77e9.5c50

IPv4 address 192.168.2.1/24 broadcast 192.168.2.255

Description: ip_phone_vlan

index 202 metric 1 mtu 1500

arp ageing timeout 300

<UP,BROADCAST,MULTICAST>

SNMP link-status traps: Disabled

Bandwidth 1g

input packets 0, bytes 0, dropped 0, multicast packets 0

output packets 90, bytes 4244, multicast packets 0 broadcast packets 0

Time since last state change: 0 days 14:22:39

Interface Commands

Software Reference for GS900MX/MPX Series Switches

12.12 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show interface brief

Use this command to display brief interface, configuration, and status information,

including provisioning information.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show interface brief

Mode User Exec and Privileged Exec

Output Figure 12-4: Example output from the show interface brief command

Table 12-1: Parameters in the output of the show interface brief command

Related Commands show interface

show interface memory

awplus#show int brief

Interface Status Protocol

port1.0.1 admin up down

port1.0.2 admin up down

port1.0.3 admin up down

port1.0.4 admin up down

port1.0.5 admin up down

port1.0.6 admin up running

lo admin up running

vlan1 admin up down

vlan2 admin up down

Parameter Description

Interface The name or type of interface.

Status The administrative state. This can be either admin up or

admin down.

Protocol The link state. This can be either down, running, or provisioned.

Interface Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 12.13

show interface status

Use this command to display the status of the specified interface or interfaces. Note that

when no interface or interfaces are specified then the status of all interfaces on the switch

are shown.

Syntax show interface [<port-list>] status

Examples To display the status of ports 1.0.1 to 1.0.5, use the commands:

To display the status of all ports, use the commands:

Parameter Description

<port-list>The ports to display information about. The port list can be:

■a switch port (e.g. port1.0.6) a static channel group (e.g. sa2)

or a dynamic (LACP) channel group (e.g. po2)

■a continuous range of ports separated by a hyphen,

e.g. port1.0.1-1.0.6, or sa1-2, or po1-2

■a comma-separated list of ports and port ranges,

e.g. port1.0.1,port1.0.4-1.0.6. Do not mix switch ports,

static channel groups, and dynamic (LACP) channel groups in the

same list

awplus# show interface port1.0.1-1.0.4 status

Figure 12-5: Example output from the show interface <port-list> status command

awplus#show interface port1.0.1 -1.0.5 status

Port Name Status Vlan Duplex Speed Type

port1.0.1 notconnect 1 auto auto 1000BASE-T

port1.0.2 notconnect 1 auto auto 1000BASE-T

port1.0.3 notconnect 1 auto auto 1000BASE-T

port1.0.4 notconnect 1 auto auto 1000BASE-T

awplus# show interface status

Figure 12-6: Example output from the show interface status command

awplus#sho int status

Port Name Status Vlan Duplex Speed Type

port1.0.1 Trunk_Net connected trunk a-full a-1000 1000BaseTX

port1.0.2 Access_Net1 connected 5 full 100 1000BaseTX

port1.0.3 Access_Net1 disabled 5 auto auto 1000BaseTX

port1.0.4 Access_Net2 connected 6 a-half a-100 1000BaseTX

port1.0.5 Private_Prom connected 10 a-full a-100 1000BaseTX

port1.0.6 Private_Net1 connected 10,11 a-full a-100 1000BaseTX

port1.0.7 Private_Net2 connected 10,12 a-full a-100 1000BaseTX

port1.0.8 notconnect 1 auto auto 1000BaseTX

port1.0.23 disabled 1 auto auto not present

port1.0.24 notconnect 1 auto auto unknown

sa1 notconnect trunk auto auto

Interface Commands

Software Reference for GS900MX/MPX Series Switches

12.14 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Related Commands show interface

show interface memory

Table 12-2: Parameters in the output from the show interface status command

Parameter Description

Port Name/Type of the interface.

Name Description of the interface.

Status The administrative and operational status of the interface; one of:

■disabled: the interface is administratively down.

■connect: the interface is operationally up.

■notconnect: the interface is operationally down.

Vlan VLAN type or VLAN IDs associated with the port:

■When the VLAN mode is trunk, it displays trunk (it does not

display the VLAN IDs).

■When the VLAN mode is access, it displays the VLAN ID.

■When the VLAN mode is private promiscuous, it displays the

primary VLAN ID if it has one, and promiscuous if it does not

have a VLAN ID.

■When the VLAN mode is private host, it displays the primary

and secondary VLAN IDs.

■When the port is an Eth port, it displays none: there is no VLAN

associated with it.

■When the VLAN is dynamically assigned, it displays the current

dynamically assigned VLAN ID (not the access VLAN ID), or

dynamic if it has multiple VLANs dynamically assigned.

Duplex The actual duplex mode of the interface, preceded by a- if it has

autonegotiated this duplex mode. If the port is disabled or not

connected, it displays the configured duplex setting.

Speed The actual link speed of the interface, preceded by a- if it has

autonegotiated this speed. If the port is disabled or not

connected, it displays the configured speed setting.

Type The type of interface, e.g. 1000BaseTX. For SFP bays, it displays

Unknown if it does not recognize the type of SFP installed, or

Not present if an SFP is not installed or is faulty.

Interface Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 12.15

shutdown

This command shuts down the selected interface. This administratively disables the link

and takes the link down at the physical (electrical) layer.

Use the no variant of this command to disable this function and therefore to bring the link

back up again.

Syntax shutdown

no shutdown

Mode Interface Configuration

Example The following example shows the use of the shutdown command to shut down

port1.0.2.

The following example shows the use of the no shutdown command to bring up

port1.0.2.

The following example shows the use of the shutdown command to shut down vlan2.

The following example shows the use of the no shutdown command to bring up

vlan2.

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# shutdown

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# no shutdown

awplus# configure terminal

awplus(config)# interface vlan2

awplus(config-if)# shutdown

awplus# configure terminal

awplus(config)# interface vlan2

awplus(config-if)# no shutdown

Interface Commands

Software Reference for GS900MX/MPX Series Switches

12.16 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 13.1

Chapter 13: Interface Testing Commands

Command List .................................................................................................................................... 13.2

clear test interface............................................................................................................................. 13.2

service test........................................................................................................................................... 13.3

test interface ....................................................................................................................................... 13.4

Interface Testing Commands

Software Reference for GS900MX/MPX Series Switches

13.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Command List

This chapter provides an alphabetical reference of commands used for testing interfaces.

clear test interface

This command clears test results and counters after issuing a test interface command. Test

results and counters must be cleared to issue subsequent test interface commands later

on.

Syntax clear test interface {<port-list>|all}

Mode Privileged Exec

Examples To clear the counters for port1.0.1 use the command:

To clear the counters for all interfaces use the command:

Related Commands test interface

Parameter Description

<port-list>The ports to test. A port-list can be:

■a switch port (e.g. port1.0.6)

■a continuous range of ports separated by a hyphen,

e.g. port1.0.1-port1.0.6

■a comma-separated list of the above,

e.g. port1.0.1,port1.0.5-1.0.6

The specified ports must exist.

all All interfaces

awplus# clear test interface port1.0.1

awplus# clear test interface all

Interface Testing Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 13.3

service test

This command puts the device into the interface testing state, ready to begin testing. After

entering this command, enter Interface Configuration mode for the desired interfaces and

enter the command test interface.

Do not test interfaces on a device that is part of a live network—disconnect the device

first.

Use the no variant of this command to stop the test service.

Syntax service test

no service test

Mode Global Configuration

Example To put the device into a test state, use the command:

Related Commands test interface

awplus(config)# service test

Interface Testing Commands

Software Reference for GS900MX/MPX Series Switches

13.4 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

test interface

This command starts a test on a port or all ports or a selected range or list of ports.

Use the no variant of this command to disable this function. The test duration can be

configured by specifying the time in minutes after specifying a port or ports to test.

For an example of all the commands required to test switch ports, see the Examples

section in this command. To test the Eth port, set its speed to 100 by using the command

speed 100.

Syntax test interface {<port-list>|all} [time{<1-60>|cont}]

no test interface {<port-list>|all}

Mode Privileged Exec

Example To test the switch ports in VLAN 1, install loopbacks in the ports, and enter the following

commands:

Note Do not run test interface on live networks because this will degrade network

performance.

Parameter Description

<port-list>The ports to test. A port-list can be:

■a switch port (e.g. port1.0.6)

■a continuous range of ports separated by a hyphen,

e.g. port1.0.1-port1.0.6

■a comma-separated list of the above,

e.g. port1.0.1,port1.0.5-1.0.6

The specified ports must exist.

all All ports

time Keyword entered prior to the value for the time duration of the

interface test.

<1-60>Specifies duration of time to test the interface or interfaces in

minutes (from a minimum of 1 minute to a maximum of 60 minutes).

The default is 4 minutes.

cont Specifies continuous interface testing until canceled with command

negation.

awplus(config)# service test

awplus(config)# no spanning-tree rstp enable bridge-forward

awplus(config)# interface vlan1

awplus(config-if)# shutdown

awplus(config-if)# end

awplus# test interface all

Interface Testing Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 13.5

To see the output, use the commands:

To start the test on all interfaces for 1 minute use the command:

Related Commands clear test interface

awplus# show test

awplus# show test count

awplus# test interface all time 1

Interface Testing Commands

Software Reference for GS900MX/MPX Series Switches

13.6 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Part 2: Layer Two Switching

■Chapter 14 Switching Introduction

■Chapter 15 Switching Commands

■Chapter 16 VLAN Introduction

■Chapter 17 VLAN Commands

■Chapter 18 Spanning Tree Introduction: STP, RSTP, and

MSTP

■Chapter 19 Spanning Tree Commands

■Chapter 20 Link Aggregation Introduction and

Configuration

■Chapter 21 Link Aggregation Commands

■Chapter 22 Power over Ethernet Introduction

■Chapter 23 Power over Ethernet Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 14.1

Chapter 14: Switching Introduction

Introduction ........................................................................................................................................ 14.2

Physical Layer Information ............................................................................................................ 14.3

Switch Ports ................................................................................................................................. 14.3

Activating and Deactivating Switch Ports ........................................................................ 14.4

Autonegotiation......................................................................................................................... 14.4

Duplex Mode ............................................................................................................................... 14.4

Speed Options ............................................................................................................................ 14.4

MDI/MDIX Connection Modes .............................................................................................. 14.5

The Layer 2 Switching Process ..................................................................................................... 14.7

The Ingress Rules........................................................................................................................ 14.7

The Learning Process................................................................................................................ 14.8

The Forwarding Process ..........................................................................................................14.9

The Egress Rules......................................................................................................................... 14.9

Layer 2 Filtering ...............................................................................................................................14.11

Ingress Filtering ........................................................................................................................14.11

Storm Control ...................................................................................................................................14.12

Loop Protection ...............................................................................................................................14.13

Loop Detection ........................................................................................................................14.13

Thrash Limiting.........................................................................................................................14.14

Support for Jumbo Frames..........................................................................................................14.16

Port Mirroring ...................................................................................................................................14.17

Port Security......................................................................................................................................14.18

IEEE 802.1X .................................................................................................................................14.18

Static MAC Address.................................................................................................................14.18

Quality of Service ............................................................................................................................14.19

IGMP Snooping................................................................................................................................14.20

Switching Introduction

Software Reference for GS900MX/MPX Series Switches

14.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Introduction

This chapter gives an overview of Layer 1 and 2 switching.

Layer 2 switches are used to connect multiple Local Area Network (LAN) segments

together to form an extended LAN. Stations connected to different LANs can be

configured to communicate with one another as if they were on the same LAN. They can

also divide one physical LAN into multiple Virtual LANs (VLANs). Stations connected to

each other on the same extended LAN can be grouped in separate VLANs, so that a station

in one VLAN can communicate directly with other stations in the same VLAN, but must go

through higher layer routing protocols to communicate with those stations in other

VLANs.

Layer 2 switches appear transparent to higher layer protocols, transferring frames

between the data link layers of the networks to which they are attached. A Layer 2 switch

accesses each physical link according to the rules for that particular network. Access may

not always be instant, so the switch must be capable of storing and forwarding frames.

Storing and forwarding enables the switch to examine both the VLAN tag fields and

Ethernet MAC address fields in order to forward the frames to their appropriate

destination. In this way, the switch can act as an intelligent filtering device, redirecting or

blocking the movement of frames between networks.

Because switch ports can sometimes receive frames faster than it can forward them, the

switch has Quality of Service (QoS) queues in which frames await transmission according

to their priority. Such a situation could occur where data enters a number of input ports all

destined for the same output port.

The switch can be used to:

■Increase both the physical extent and the maximum number of stations on a LAN.

LANs are limited in their physical extent by the signal distortion and propagation

delay characteristics of the media. The switch overcomes this limitation by receiving a

frame on one LAN and then retransmitting it to another. The physical characteristics

of the LAN media also place a practical limit on the number of stations that can be

connected to a single LAN segment. The switch overcomes this limitation by joining

LAN segments to form an extended LAN capable of supporting more stations than

either of the individual LAN segments.

■Connect LANs that have a common data link layer protocol but different physical

media, for example, Ethernet 10BASET, 100BASET, and 10BASEF.

■Increase the availability of LANs by allowing multiple redundant paths to be

physically configured and selected dynamically, using the Spanning Tree algorithm.

■Reduce the load on a LAN or increase the effective bandwidth of a LAN, by filtering

traffic.

■Prioritize the transmission of data with high Quality of Service requirements.

By using Virtual LANs (VLANs), a single physical LAN can be separated into multiple Virtual

LANs. VLANs can be used to:

■Further improve LAN performance, as broadcast traffic is limited to LAN segments

serving members of the VLAN to which the sender belongs.

■Provide security, as frames are forwarded to those stations belonging to the sender’s

VLAN, and not to stations in other VLANs on the same physical LAN.

■Reduce the cost of moving or adding stations to function or security based LANs, as

this generally requires only a change in the VLAN configuration.

Switching Introduction

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 14.3

Physical Layer Information

Switch Ports

A unique port number identifies each switch port. The software supports a number of

features at the physical level that allow it to be connected in a variety of physical networks.

This physical layer (Layer 1) versatility includes:

■Enabling and disabling of ports

■Auto negotiation of port speed and duplex mode, where supported by the port type

■Manual setting of port speed and duplex mode, where supported by the port type

■Link up and link down triggers

■Packet storm protection

■Port mirroring

■Support for SNMP management

Port numbering

Ports are numbered using a 3 digit format x.y.z where x is the device number (within a

stacked configuration), y is the module number within the device, and z is the port

number within the module. Ports connected directly to the switch chassis or baseboard

(rather than a pluggable module) are given the module number 0. In an unstacked

configuration all device numbers are 1. For example, port1.2.6 represents device 1,

module 2, port 6.

Adding a

description

You can add a description to an interface to help identify its purpose or position. For

example, to add the description “connected to Nerv” to port1.0.3, use the commands:

Port ranges

Continuous To configure a continuous range of ports at the same time, enter the range in the format:

portx.y.z-portx.y.z

For example, to configure the same interface setting on port1.0.1 to port1.0.2,

enter the Global Configuration mode command:

Non-continuous To configure a non-continuous set of ports at the same time, enter a comma-separated

list:

portx.y.z,portx.y.z

For example, to configure the same interface setting on port1.0.1 and port1.0.5,

enter the Global Configuration mode command:

awplus(config)# interface port1.0.3

awplus(config-if)# description connected to Nerv

awplus(config)# interface port1.0.1-port1.0.2

awplus(config)# interface port1.0.1,port1.0.5

Switching Introduction

Software Reference for GS900MX/MPX Series Switches

14.4 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

You can combine a hyphen-separated range and a comma-separated list. To configure the

same setting on port1.0.1 to port1.0.3 and port1.0.5, enter the Global

Configuration mode command:

Activating and Deactivating Switch Ports

An active switch port is one that is available for packet reception and transmission.

Disabling a switch port does not affect the STP operation on the port. By default ports and

VLANs are activated.

To shutdown a port or VLAN use the shutdown command on page 12.15. Use the no

variant of this command to reactivate it.

Autonegotiation

Autonegotiation lets the port adjust its speed and duplex mode to accommodate the

device connected to it. When the port connects to another autonegotiating device, they

negotiate the highest possible speed and duplex mode for both of them.

By default, all ports autonegotiate. Setting the port to a fixed speed and duplex mode may

be necessary when connecting to a device that cannot autonegotiate.

Duplex Mode

Ports can operate in full duplex or half duplex mode depending on the type of port it is.

When in full duplex mode, a port transmits and receives data simultaneously. When in half

duplex mode, the port transmits or receives but not both at the same time.

You can set a port to use either of these options, or allow it to autonegotiate the duplex

mode with the device at the other end of the link. To configure the duplex mode, use

these commands:

Speed Options

Before configuring a port’s speed, check the hardware limit for the particular port type.

The following list can be used as a guide:

■non-SFP RJ-45 copper switch ports: 10, 100 or 1000 Mbps

■supported tri-speed copper SFPs: 10, 100 or 1000 Mbps

■fiber SFPs: 100 Mbps to 1000Mbps, depending on the SFP type

■SFP+ / XFP modules: 10 Gbps

awplus(config)# interface port1.0.1-port1.0.3,port1.0.5

awplus#

configure terminal Enter Global Configuration mode

awplus(config)#

interface port1.0.1 Enter Interface Configuration mode for port 1.0.1

awplus(config-if)#

duplex {auto|full|half} Enter the Duplex mode for port 1.0.1

Switching Introduction

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 14.5

For the latest list of approved SFP transceivers either contact your authorized distributor

or reseller, or visit alliedtelesis.com.

You can set a port to use one of these speed options, or allow it to autonegotiate the

speed with the device at the other end of the link.

Most types of switch port can operate in either full duplex or half duplex mode. In full

duplex mode a port can transmit and receive data simultaneously. In half duplex mode

the port can either transmit or receive, but not at the same time.

Make sure that the configuration of the switch matches the configuration of the device at

the far end of the link. In particular, avoid having one end autonegotiate duplex mode

while the other end is fixed. For example, if you set one end of a link to autonegotiate and

fix the other end at full duplex, the autonegotiating end cannot determine that the fixed

end is full duplex capable. Therefore, the autonegotiating end selects half-duplex

operation. This results in a duplex mismatch and packet loss. To avoid this, either fix the

mode at both ends, or use autonegotiation at both ends.

Configuring the port speed

To set the port speed to 1000 Mbps on port 1.0.1, use the commands:

MDI/MDIX Connection Modes

By default, copper 10Base-T, 100Base-T, and 1000Base-T ports on the switch automatically

set the Media Dependant Interface mode to MDI or MDIX for successful physical

connections. We recommend using this default setting. However, you can configure them

to have either fixed MDI mode or fixed MDIX mode by using the polarity command on

page 15.24. MDI/MDIX mode polarity does not apply to fiber ports.

Connections to 10BASE-T, 100BASE-T, and 1000BASE-T networks may either be straight

though (MDI) or crossover (MDIX). The crossover connection can be achieved by using

either a crossover cable or by integrating the crossover function within the device. In the

latter situation, the connector is referred to as an MDIX connection. Refer to your switch’s

Hardware Reference for more detailed information on physical connections cabling.

The IEEE 802.3 standard defines a series of Media Dependant Interface types and their

physical connections. For twisted pair (10BASE-T) networking, the standard defines that

connectors that conform to the IEC 60603-7 standard. The Figure 14-1f shows a

connector of this type.

awplus#

configure terminal Enter the Global Configuration mode.

awplus(config)#

interface port1.0.1 Enter Interface Configuration mode for port

1.0.1

awplus(config-if)#

speed 1000 Set the port speed for port 1.0.1 to 1000 Mbps.

Switching Introduction

Software Reference for GS900MX/MPX Series Switches

14.6 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Figure 14-1: Connector used for 10BASE-T networks

RJPIN

Switching Introduction

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 14.7

The Layer 2 Switching Process

The Layer 2 switching process comprises these related but separate processes:

■The Ingress Rules

■The Learning Process

■The Forwarding Process

■The Egress Rules

Ingress rules admit or discard frames based on their VLAN tagging.

The Learning process learns the MAC addresses and VLAN membership of frames

admitted on each port.

The Forwarding process determines which ports the frames are forwarded to, and the

Quality of Service priority with which they are transmitted.

Finally, Egress rules determine for each frame whether VLAN tags are included in the

Ethernet frames that are transmitted.

These processes assume that each station on the extended LAN has a unique data link

layer address, and that all data link layer frames have a header which includes the source

(sender’s) MAC address and destination (recipient’s) MAC address.

The Ingress Rules

All frames, tagged and untagged, that a VLAN-aware switch receives must be classified

into a VLAN. Each received frame is mapped to exactly one VLAN. If an incoming frame is

tagged with a valid VLAN identifier (VID) then that VID is used. If an incoming frame is

untagged or is priority tagged (a tagged frame with a VID of all zeros), then the switch

uses internal VLAN association rules to determine the VLAN it belongs to. The default

settings for the ingress rules are to Admit All Frames, and for Ingress Filtering to be on.

Every port belongs to one or more VLANs so every incoming frame has a VID to show

which VLAN it belongs. The final part of the Ingress Rules depends on whether Ingress

Filtering is enabled for the port. If Ingress Filtering is disabled, all frames are passed on to

the Learning process, regardless of which VLAN they belong to. If Ingress Filtering is

enabled (by default), frames are admitted only when they have the VID of a VLAN to which

the port belongs. Frames are discarded when they do not have an associated VID

matching the VLAN assigned to a port.

The possible association rules, in order of precedence, are:

■IP subnet/IPX network classification

■protocol classification

■port classification

The default VLAN classification is based upon the port on which the incoming frame

(untagged, or priority tagged) was received. It is possible for an incoming untagged, or

priority tagged, frame to match more than one of the association rules.

Each port on the switch can be configured to be one of two modes:

■only untagged frames - access mode

■VLAN-tagged frames - trunk mode

Switching Introduction

Software Reference for GS900MX/MPX Series Switches

14.8 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Access mode

This mode can be used to connect to VLAN unaware devices. Frames to and from access

mode ports carry no VLAN tagging information.

Trunk mode

This mode is used to connect VLAN capable devices. All devices that connect using trunk

mode ports must be VLAN aware.

You can specify a “native” VLAN on a trunk port. When the port receives untagged packets,

it will tag the packets with the VID of the native VLAN. Note that packets from the native

VLAN egress the port untagged.

To specify the native VLAN, use the switchport trunk native vlan command on page

17.28.

The Learning Process

The learning process uses an adaptive learning algorithm, sometimes called backward

learning, to discover the location of each station on the extended LAN.

All frames admitted by the ingress rules on any port are passed on to the forwarding

process when they are for destinations in the same VLAN. Frames destined for other

VLANs are passed to a Layer 3 protocol, such as IP. For every frame admitted, the frame’s

source MAC address and VID are compared with entries in the forwarding database for the

VLAN (also known as a MAC Address table) maintained by the switch. When the frame’s

source address is not in the forwarding database for the VLAN, the address is added and

an ageing timer for that entry is started. When the frame’s source address is already in the

forwarding database, the ageing timer for that entry is restarted.

By default, switch learning is enabled. It can be disabled with the no mac address-table

acquire command, and re-enabled using the mac address-table acquire command on

page 15.16.

If the ageing timer for an entry in the forwarding database expires before another frame

with the same source address is received, the entry is removed from the forwarding

database. This prevents the forwarding database from being filled with information about

stations that are inactive or have been disconnected from the network. It also ensures that

entries for active stations are kept alive in the forwarding database.

By default, the ageing timer is enabled with a default ageing-time. The ageing timer can

be reset to the default with the no mac address-table ageing-time command. The

ageing timer can be increased or decreased using the mac address-table ageing-time

command.

If switch learning is disabled and the ageing timer has aged out all dynamically learned

filter entries, only statically entered MAC source addresses decide the packets to forward

or discard. When the switch finds no matching entries in the forwarding database during

the forwarding process, all switch ports in the VLAN are flooded with the packet, except

the port that received it.

The default for the mac address-table ageing-time is 300 seconds (5 minutes) and can be

modified by using the command mac address-table ageing-time. The no mac address-

table ageing-time command will reset the ageing-time back to the default (5 minutes).

Switching Introduction

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 14.9

To set the mac address-table ageing-time to 1000 seconds:

To display general switch settings, including settings for switch learning and the switch

ageing timer, use the show system command on page 8.46.

The Forwarding Process

After a VID is assigned to a frame using the ingress rules, the switch forwards it to the

destination MAC address specified in the frame. To do this the switch must learn which

MAC addresses are available on each port for each VLAN. When the destination MAC

address is not found, the switch floods the frame on all ports that are members of the

VLAN except the port on which the frame was received.

The forwarding database (also known as the MAC Address table) determines the egress

port on which the destination MAC address has been learned. MAC addresses are learned

dynamically as part of the Layer 2 switching process.

The forwarding database is ordered according to MAC address and VLAN identifier. This

means a MAC address can appear more than once in the forwarding database having

been learned on the same port but for different VLANs. This could occur if the IP address of

an end station is changed thereby moving the end station to a different IP subnet-based

VLAN while still connected to the same switch port. When the forwarding database

ageing process is enabled, old entries in the forwarding database are deleted after a

user-configurable period.

If the destination address is found, the switch discards the frame when the port is not in

the STP forwarding or disabled state if the destination address is on the same port as the

source address, or if there is a static filter entry for the destination address set to discard

(see “Layer 2 Filtering” on page 14.11). Otherwise, the frame is forwarded on the

indicated port.

Forwarding occurs only when the port on which the frame was received is in the Spanning

Tree forwarding or disabled state. The destination address is then looked up in the

forwarding database for the VLAN.

The Egress Rules

After the forwarding process has determined from which ports and transmission queues

to forward a frame, the egress rules for each port determine whether the outgoing frame

is VLAN-tagged with its numerical VLAN identifier (VID).

A port must belong to a VLAN at all times unless the port has been set as the mirror port

for the switch.

awplus#

configure terminal Enter the config terminal mode

awplus(config)#

mac address-table ageing-time 1000 Set the ageing time to 1000

seconds

Switching Introduction

Software Reference for GS900MX/MPX Series Switches

14.10 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

A port can transmit VLAN-tagged frames for any VLAN to which the port belongs. A port

can transmit untagged frames for any VLAN for which the port is configured, e.g. IP

subnet-based or protocol-based, unless prevented by the port-based VLAN egress rules. A

port that belongs to a port-based VLAN can transmit untagged packets for only one VLAN.

For more information about VLANs and VLAN tagging, see Chapter 16, VLAN

Introduction.

For more information on port tagging see the following commands:

switchport mode access command on page 17.16

switchport mode trunk command on page 17.22

Switching Introduction

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 14.11

Layer 2 Filtering

The switch has a forwarding database (also known as the MAC address table) whose

entries determine whether frames are forwarded or discarded over each port. Entries in

the forwarding database are created dynamically by the learning process. A dynamic entry

is automatically deleted from the forwarding database when its ageing timer expires.

The forwarding database supports queries by the forwarding process as to whether

frames with given values of the destination MAC address field should be forwarded to a

given port.

For each VLAN, the destination MAC address of a frame to be forwarded is checked against

the forwarding database. If there is no entry for the destination address and VLAN, the

frame is transmitted on all ports in the VLAN that are in the forwarding state, except the

port on which the frame was received. This process is referred to as flooding. If an entry is

found in the forwarding database but the entry is not marked forwarding or the entry

points to the same port the frame was received on, the frame is discarded. Otherwise, the

frame is transmitted on the port specified by the forwarding database.

Ingress Filtering

The ingress-filter parameter of the switchport mode trunk command on page 17.22 and

the switchport mode access command on page 17.16, enables or disables ingress

filtering of frames entering the specified port (or port range).

Each port on the switch belongs to one or more VLANs. If ingress filtering is enabled, any

frame received on the specified port is only admitted if its VID matches one for which the

port is tagged. Any frame received on the port is discarded if its VID does not match one

for which the port is tagged.

Untagged frames are admitted and are assigned the VLAN Identifier (VID) of the port’s

native VLAN. Ingress filtering can be turned off by setting the disable parameter of the

above two commands. The default setting of the enable / disable parameter option is

enable.

Note Enabling the vlan-disable parameter of the thrash-limiting command on

page 15.46 will also enable ingress filtering, and will override the setting of the

switchport mode access, and trunk commands

Switching Introduction

Software Reference for GS900MX/MPX Series Switches

14.12 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Storm Control

The packet storm-control feature enables you to set limits on the reception rate of

broadcast, multicast frames and destination lookup failures. You can set separate limits

beyond which each of the different packet types are discarded.

For more information on applying storm-control, see the storm-control level command

on page 15.45.

To apply storm-control by limiting broadcasts to 30% on port1.0.4:

To turn off storm protection on port1.0.4:

Note A destination lookup failure (DLF) is the event of receiving a unicast Ethernet

frame with an unknown destination address.

awplus(config-if)#

configure terminal Enter Global Configuration mode.

awplus(config-if)#

interface port1.0.4 Enter the Interface Configuration

mode for the selected port.

awplus(config-if)#

storm-control broadcast level 30 Configure the interface.

awplus(config-if)#

configure terminal Enter Global Configuration mode.

awplus(config-if)#

interface port1.0.4 Enter the Interface Configuration mode

for the selected port.

awplus(config-if)#

no storm-control broadcast level Configure the interface.

Switching Introduction

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 14.13

Loop Protection

Loop protection is a general term that embraces several different methods you can apply

to protect your network from effects such as broadcast storms that can result from data

loops or equipment malfunction.

Two methods of loop protection are available:

■Loop Detection

■Thrash Limiting

Loop Detection

Introduction

This feature is used to detect loops with a network segment. If a loop is detected then a

selected protection mechanism is applied to limit the effect of the loop. The loop

protection actions can be applied either to the port at which the loop is detected or to the

VLAN within which the loop was detected.

Limiting Actions You can configure loop detection to apply one of the following mechanisms when a loop

condition is detected:

■Block all traffic on the port (or aggregated link) that detected the loop, and take down

the link.

■Block all traffic on the port (or aggregated link) that detected the loop, but keep the

link in the up state.

■Block all traffic on a vlan. Note that setting this parameter will also enable ingress

filtering. This is the default action.

■Take no action, but log the details.

■Take no action.

Operation

To detect loops this feature operates by transmitting a series of Loop Detection Frames

(LDFs) from each switch port out into the network. If no loops exist, then none of these

frame should ever return. If a frame returns to its original port, the detection mechanism

assumes that there is a loop somewhere in the network and offers a number of protective

options.

Each LDF is a Layer 2 LLC frame that contains the following components:

■the source MAC address of the originating switch

■the destination MAC address of the non-existent end station 00-00-F4-27-71-01

■VLAN ID (where the port is a tagged member of a VLAN).

■a randomly generated LDF ID number.

You can set the detection mechanism to remember the LDF ID of up to 5 of the most

recently transmitted LDF frames. Each of the 5 most recently transmitted frames is

compared with every frame that arrives at that same port.

Switching Introduction

Software Reference for GS900MX/MPX Series Switches

14.14 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Configuration

To enable loop protection and configure its basic parameters, you use the loop-

protection command on page 15.12.

Example To enable the loop-detect mechanism, and generate loop-detect frames once every 5

seconds, use the command:

You can now use the loop-protection action command on page 15.13 configure the

action that the switch will take if a loop is detected.

Example To disable an interface, and bring the link down, when a network loop is detected, use the

command:

Now decide how long you want the protective action to apply for. You configure this

function by using the loop-protection timeout command on page 15.15.

Example To configure a loop protection action timeout of 10 seconds, use the command:

Example To configure a loop protection action delay time of 10 seconds, use the commands:

Thrash Limiting

MAC address thrashing occurs when MAC addresses move rapidly between one or more

ports or trunks, for example, due to a network loop.

Thrash limiting enables you to apply actions to a port when thrashing is detected. It is

supported on all port types and also on aggregated ports.

awplus(config)# loop-protection loop-detect ldf-interval 5

Note LDFs are sent sequentially for each VLAN defined to a particular port. For

example, if a particular port in this example is a member of 4 VLANs, then the

LDFs will be sent from this port at the rate of 4 frames every 5 seconds.

awplus(config-if)# loop-protection action link-down

awplus(config-if)# loop-protection timeout 10

awplus(config-if)# loop-protection action-delay-time

Switching Introduction

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 14.15

Limiting Actions There are several different thrash actions that you can apply to a port when thrashing is

detected. These actions are:

■learnDisable: MAC address learning is temporarily disabled on the port.

■portDisable: The port is logically disabled. Traffic flow is prevented, but the link

remains up. The device at the other end does not notice that the port has changed

status, and the link LEDs at both ends stay on.

■linkDown: The port is physically disabled and the link is down. This is equivalent to

entering the shutdown command on page 12.15.

■vlanDisable: The port is disabled only for the VLAN on which thrashing has occurred.

It can still receive and transmit traffic for any other VLANs of which it is a member.

When a MAC address is thrashing between two ports, one of these ports (the first to cross

its thrashing threshold) is disabled. All other ports on the device will then have their

threshold counters reset.

To set a thrash action for a port, use the thrash-limiting command on page 15.46:

Re-enabling a port When a port is disabled, either completely or for a specific VLAN, it remains disabled until

it is manually re-enabled in any of the following ways:

■by using SNMP

■by rebooting the switch or stack

■by specifying a thrash timeout value along with the thrash action

■via the CLI

Switching Introduction

Software Reference for GS900MX/MPX Series Switches

14.16 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Support for Jumbo Frames

Jumbo frames are frames with more than 1500 bytes of payload. You can enable jumbo

frame support on the switch to improve throughput and network utilization. Jumbo frame

support allows you to put more data in each packet that the switch has to process.

The maximum received packet size is 16357 bytes.

You can increase the Maximum Receive Unit (MRU) size for switch ports to receive jumbo

frames with payload larger than 1500 bytes. To increase MRU size, use the mru command

on page 12.5.

Note Jumbo packet switching is supported for L2 and L3 traffic flows that have

established traffic paths. Jumbo frames cannot be used for establishing these

network paths. Please use frames less than 1518 bytes to establish the path, for

example by pinging the destination.

Switching Introduction

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 14.17

Port Mirroring

Port mirroring enables traffic being received and transmitted on a switch port to be sent

to another switch port, the mirror port, usually for the purposes of capturing the data with

a protocol analyzer.

The mirror port is the only switch port that does not belong to a VLAN, and therefore does

not participate in any other switching. Before the mirror port can be set, it must be

removed from all trunk groups and all VLANs except the default VLAN.

The following example sets mirroring on ports 1.0.2 and 1.0.5 for both incoming and

outgoing data.

To configure port 1.0.2 to mirror port 1.0.5:

Note Due to the internal hardware properties of the switch, frames that are destined

to leave the mirrored port untagged (i.e. will have their VLAN tag removed on

egress) will be received by the mirror port with the tag retained. Consequently,

if frames were being transmitted by the mirror port (into the network) at wire

speed, then the mirror port might be unable to accept all the frames supplied

to it.

awplus#

configure terminal Enter Global Configuration mode.

awplus(config)#

interface port1.0.2 Enter the Interface Configuration mode for

port1.0.2.

awplus(config-if)#

mirror interface port1.0.5

direction both

Configure this port to mirror port 1.0.5.

Switching Introduction

Software Reference for GS900MX/MPX Series Switches

14.18 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Port Security

The port security features provide control over the stations connected to each switch port.

■802.1x

■Static MAC address

IEEE 802.1X

IEEE 802.1X restricts unauthenticated devices from connecting to the switch. After

authentication is successful, traffic is allowed through the switch. For more information

see Chapter 46, 802.1X Introduction and Configuration.

Static MAC Address

If a new MAC address is seen on a port with port security enabled and the MAC address is

statically configured for another port, a violation is triggered. The maximum learn limit will

be ignored and the specified intrusion action for the port will be carried out.

Switching Introduction

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 14.19

Quality of Service

Quality of Service (QoS) enables you to both prioritize traffic and limit its available

bandwidth. The concept of QoS is a departure from the original networking protocols, in

which all traffic on the Internet or within a LAN had the same available bandwidth.

Without QoS, all traffic types are equally likely to be dropped if a link becomes

oversubscribed. This approach is now inadequate in many networks, because traffic levels

have increased and networks often carry time-critical applications such as streams of real-

time video data. QoS also enables service providers to easily supply different customers

with different amounts of bandwidth.

Configuring Quality of Service involves two separate stages:

1. Classifying traffic into flows, according to a wide range of criteria. Classification is

performed by the switch’s class maps.

2. Acting on these traffic flows.

For more information on QoS see Chapter 40, Quality of Service (QoS) Introduction and

Chapter 41, QoS Commands.

Switching Introduction

Software Reference for GS900MX/MPX Series Switches

14.20 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

IGMP Snooping

IGMP (Internet Group Management Protocol) is used by IP hosts to report their multicast

group memberships to routers and switches. IP hosts join a multicast group to receive

broadcast messages directed to the multicast group address. IGMP is an IP-based protocol

and uses IP addresses to identify both the multicast groups and the host members. For a

VLAN-aware devices, this means multicast group membership is on a per-VLAN basis. If at

least one port in the VLAN is a member of a multicast group, by default multicast packets

will be flooded onto all ports in the VLAN.

IGMP snooping enables the switch to forward multicast traffic intelligently on the switch.

The switch listens to IGMP membership reports, queries and leave messages to identify

the switch ports that are members of multicast groups. Multicast traffic will only be

forwarded to ports identified as members of the specific multicast group.

IGMP snooping is performed at Layer 2 on VLAN interfaces automatically. By default, the

switch will forward traffic only from those ports with multicast listeners, therefore it will

not act as a simple hub and flood all multicast traffic out all ports. IGMP snooping is

independent of the IGMP and Layer 3 configuration, so an IP interface does not have to be

attached to the VLAN, and IGMP does not have to be enabled or configured.

IGMP snooping is enabled by default.

For more information on IGMP see Chapter 32, IGMP Snooping Introduction and

Chapter 33, IGMP Snooping Commands.

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.1

Chapter 15: Switching Commands

Command List .................................................................................................................................... 15.2

backpressure....................................................................................................................................... 15.2

clear loop-protection counters .................................................................................................... 15.3

clear mac address-table static ...................................................................................................... 15.4

clear mac address-table dynamic................................................................................................ 15.5

clear port counter ............................................................................................................................. 15.7

duplex.................................................................................................................................................... 15.8

flowcontrol (switch port)................................................................................................................ 15.9

linkflap action...................................................................................................................................15.11

loop-protection................................................................................................................................15.12

loop-protection action ..................................................................................................................15.13

loop-protection action-delay-time...........................................................................................15.14

loop-protection timeout ..............................................................................................................15.15

mac address-table acquire...........................................................................................................15.16

mac address-table ageing-time.................................................................................................15.17

mac address-table static...............................................................................................................15.18

mac address-table thrash-limit ..................................................................................................15.19

mirror interface ................................................................................................................................15.20

platform stop-unreg-mc-flooding ............................................................................................15.22

polarity................................................................................................................................................15.24

show flowcontrol interface..........................................................................................................15.25

show loop-protection....................................................................................................................15.26

show mac address-table...............................................................................................................15.27

show mac address-table thrash-limit ......................................................................................15.29

show mirror .......................................................................................................................................15.30

show mirror interface ....................................................................................................................15.31

show platform ..................................................................................................................................15.32

show platform classifier statistics utilization brief ..............................................................15.33

show platform port.........................................................................................................................15.34

show port-security interface .......................................................................................................15.40

show port-security intrusion.......................................................................................................15.41

show storm-control........................................................................................................................15.42

speed ...................................................................................................................................................15.43

storm-control level .........................................................................................................................15.45

thrash-limiting..................................................................................................................................15.46

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Command List

This chapter provides an alphabetical reference of commands used to configure

switching. For more information see Chapter 14, Switching Introduction.

backpressure

This command provides a method of applying flow control to ports running in half duplex

mode. The setting will only apply when the link is in the half-duplex state.

You can disable backpressure on an interface using the off parameter or the no variant of

this command.

Syntax backpressure {on|off}

no backpressure

Default Backpressure is turned off by default. You can determine whether an interface has

backpressure enabled by viewing the running-config output; backpressure on is shown

for interfaces if this feature is enabled.

Mode Interface Configuration

Usage The backpressure feature enables half duplex Ethernet ports to control traffic flow during

congestion by preventing further packets arriving. Back pressure utilizes a pre-802.3x

mechanism in order to apply Ethernet flow control to switch ports that are configured in

the half duplex mode.

The flow control applied by the flowcontrol (switch port) command on page 15.9

operates only on full-duplex links, whereas back pressure operates only on half-duplex

links.

If a port has insufficient capacity to receive further frames, the switch will simulate a

collision by transmitting a CSMACD jamming signal from this port until the buffer empties.

The jamming signal causes the sending switch to stop transmitting and wait a random

period of time, before retransmitting its data, thus providing time for the buffer to clear.

Although this command is only valid for switch ports operating in half-duplex mode the

remote switch (the one sending the data) can be operating in the full duplex mode.

To see the currently-negotiated duplex mode for ports whose links are up, use the

command show interface. To see the configured duplex mode (when different from the

default), use the command show running-config.

Examples To enable back pressure flow control on interfaces port1.0.1-port1.0.2 enter the

following commands:

Parameters Description

on Enables half-duplex flow control.

off Disables half-duplex flow control.

awplus# configure terminal

awplus(config)# interface port1.0.1-port1.0.2

awplus(config-if)# backpressure on

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.3

To disable back pressure flow control on interface port1.0.2 enter the following

commands:

Validation

Commands

show running-config

show interface

Related Commands duplex

clear loop-protection counters

Use this command to clear the counters for the Loop Protection counters.

Syntax clear loop-protection [interface <port-list>] counters

Mode Privileged Exec

Examples To clear the counter information:

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# backpressure off

Parameters Description

interface The interface whose counters are to be cleared.

<port-list>A port, a port range, or an aggregated link.

awplus# clear loop-protection counters

awplus# clear loop-protection interface port1.0.1 counters

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.4 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

clear mac address-table static

Use this command to clear the filtering database of all statically configured entries for a

selected MAC address, interface, or VLAN.

Syntax clear mac address-table static [address <mac-address>|

interface <port>|vlan <vid>]

Mode Privileged Exec

Usage Use this command with options to clear the filtering database of all entries made from the

CLI for a given MAC address, interface or VLAN. Use this command without options to clear

any entries made from the CLI.

Compare this usage with clear mac address-table dynamic command on page 15.5.

Examples This example shows how to clear all filtering database entries configured through the CLI.

This example shows how to clear all filtering database entries for a given interface

configured through the CLI.

This example shows how to clear filtering database entries filtering database entries

configured through the CLI for a given mac address.

Related Commands clear mac address-table dynamic

mac address-table static

show mac address-table

Parameter Description

address Specify a MAC (Media Access Control) address to be cleared from

the filtering database.

<mac-address> Enter a MAC address to be cleared from the database in the format

HHHH.HHHH.HHHH.

interface Specify a switch port to be cleared from the filtering database.

<port> Specify the switch port from which address entries will be cleared.

This can be a single switch port, (e.g. port1.0.4), a static

channel group (e.g. sa2), or a dynamic (LACP) channel group (e.g.

po2).

vlan Specify a VLAN to be cleared from the filtering database.

<vid> Enter a VID (VLAN ID) in the range <1-4094> to be cleared from

the filtering database.

awplus# clear mac address-table static

awplus# clear mac address-table static interface port1.0.3

awplus# clear mac address-table static address 0202.0202.0202

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.5

clear mac address-table dynamic

Use this command to clear the filtering database of all entries learned for a selected MAC

address, an MSTP instance, a switch port interface or a VLAN interface.

Syntax clear mac address-table dynamic [address <mac-address>|

interface <port> [instance <inst>]|vlan <vid>]

Mode Privileged Exec

Usage Use this command with options to clear the filtering database of all entries learned for a

given MAC address, interface or VLAN. Use this command without options to clear any

learned entries.

Use the optional instance parameter to clear the filtering database entries associated

with a specified MSTP instance Note that you must first specify a switch port interface

before you can specify an MSTP instance.

Compare this usage and operation with the clear mac address-table static command on

page 15.4. Note that an MSTP instance cannot be specified with clear mac address-table

static.

Examples This example shows how to clear all dynamically learned filtering database entries for all

interfaces, addresses, VLANs.

This example shows how to clear all dynamically learned filtering database entries when

learned through switch operation for a given MAC address.

Parameter Description

interface Specify a switch port to be cleared from the filtering database.

<port> Specify the switch port from which address entries will be cleared.

This can be a single switch port, (e.g. port1.0.4), a static

channel group (e.g. sa2), or a dynamic (LACP) channel group (e.g.

po2).

address Specify a MAC (Media Access Control) address to be cleared from

the filtering database.

<mac-address> Enter a MAC address to be cleared from the database in the format

HHHH.HHHH.HHHH.

instance Specify an MSTP (Multiple Spanning Tree) instance to be cleared

from the filtering database.

<inst> Enter an MSTP instance in the range <1-63> to be cleared from

the filtering database.

vlan Specify a VLAN to be cleared from the filtering database.

<vid> Enter a VID (VLAN ID) in the range <1-4094> to be cleared from

the filtering database.

awplus# clear mac address-table dynamic

awplus# clear mac address-table dynamic address 0202.0202.0202

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.6 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

This example shows how to clear all dynamically learned filtering database entries when

learned through switch operation for a given MSTP instance 1 on switch port interface

port1.0.2.

Related Commands clear mac address-table static

show mac address-table

awplus# clear mac address-table dynamic interface port1.0.2

instance 1

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.7

clear port counter

Use this command to clear the packet counters of the port.

Syntax clear port counter [<port>]

Mode Privileged Exec

Example To clear the packet counter for port1.0.1, use the command:

Related Commands show platform port

Parameter Description

<port> The port number or range

awplus# clear port counter port1.0.1

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.8 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

duplex

This command changes the duplex mode for the specified port.

To see the currently-negotiated duplex mode for ports whose links are up, use the

command show interface. To see the configured duplex mode (when different from the

default), use the command show running-config.

Syntax duplex {auto|full|half}

Default By default, ports auto-negotiate duplex mode (except for 100Base-FX ports which do not

support auto-negotiation, so default to full duplex mode).

Mode Interface Configuration

Usage Switch ports in a static or dynamic (LACP) channel group must have the same port speed

and be in full duplex mode. Once switch ports have been aggregated into a channel

group, you can set the duplex mode of all the switch ports in the channel group by

applying this command to the channel group.

Examples To specify full duplex for port1.0.4, enter the following commands:

To specify half duplex for port1.0.4, enter the following commands:

To auto-negotiate duplex mode for port1.0.4, enter the following commands:

Related Commands backpressure

polarity

speed

show interface

Parameter Description

auto Auto-negotiate duplex mode.

full Operate in full duplex mode only.

half Operate in half duplex mode only.

awplus# configure terminal

awplus(config)# interface port1.0.4

awplus(config-if)# duplex full

awplus# configure terminal

awplus(config)# interface port1.0.4

awplus(config-if)# duplex half

awplus# configure terminal

awplus(config)# interface port1.0.4

awplus(config-if)# duplex auto

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.9

flowcontrol (switch port)

Use this command to enable flow control, and configure the flow control mode for the

switch port.

Use the no variant of this command to disable flow control for the specified switch port.

Syntax flowcontrol {send|receive} {off|on}

no flowcontrol

Default By default, flow control is disabled.

Mode Interface Configuration

Usage The flow control mechanism specified by 802.3x is only for full duplex links. It operates by

sending PAUSE frames to the link partner to temporarily suspend transmission on the link

Flow control enables connected Ethernet ports to control traffic rates during congestion

by allowing congested nodes to pause link operation at the other end. If one port

experiences congestion, and cannot receive any more traffic, it notifies the other port to

stop sending until the condition clears. When the local device detects congestion at its

end, it notifies the remote device by sending a pause frame. On receiving a pause frame,

the remote device stops sending data packets, which prevents loss of data packets during

the congestion period.

Flow control is not recommended when running QoS or ACLs, because the complex

queuing, scheduling, and filtering configured by QoS or ACLs may be slowed by applying

flow control.

For half-duplex links, an older form of flow control known as backpressure is supported.

See the related backpressure command on page 15.2.

For flow control on async serial (console) ports, see the flowcontrol hardware (asyn/

console) command on page 5.11.

Examples

Parameter Description

receive When the port receives pause frames, it temporarily stops (pauses)

sending traffic.

on Enable the specified flow control.

off Disable the specified flow control.

send When the port is congested (receiving too much traffic), it sends

pause frames to request the other end to temporarily stop (pause)

sending traffic.

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# flowcontrol receive on

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.10 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Validation

Commands

show running-config

Related Commands backpressure

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# flowcontrol receive off

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.11

linkflap action

Use this command to detect flapping on all ports. If more than 15 flaps occur in less than

15 seconds the flapping port will shut down.

Use the no variant of this command to disable flapping detection at this rate.

Syntax linkflap action [shutdown]

no linkflap action

Default Linkflap action is disabled by default.

Mode Global Configuration

Example To enable the linkflap action command on the switch, use the following commands:

Parameter Description

linkflap Global setting for link flapping.

action Specify the action for port.

shutdown Shutdown the port.

awplus# configure terminal

awplus(config)# linkflap action shutdown

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.12 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

loop-protection

Use this command to enable the loop-protection loop-detection feature, and configure

the detection mechanism parameters.

Use the no variant of this command to disable the loop-protection loop-detection feature.

Syntax loop-protection loop-detect [ldf-interval <period>]

[ldf-rx-window <frames>] [fast-block]

no loop-protection [loop-detect]

Default The loop-protection loop-detection feature is disabled by default.

The default interval is 10 seconds, and the default window size is 3 frames.

Mode Global Configuration

Usage See the Loop Protection section in Chapter 14, Switching Introduction for relevant

conceptual, configuration, and overview information prior to applying this command.

Example To enable the loop-detect mechanism on the switch, and generate loop-detect frames

once every 5 seconds, use the following commands:

Related Commands loop-protection action

loop-protection timeout

show loop-protection

thrash-limiting

Parameter Description

loop-detect Enables loop detection when used with loop-protection

keywords. Disables loop detection when used with no loop-

protection keywords.

ldf-interval The time (in seconds) between successive loop-detect frames

being sent.

<period> Specify a period between 1 and 600 seconds. The default is 10

seconds.

ldf-rx-window The number of transmitted loop detection frames whose

details are held for comparing with frames arriving at the same

port.

<frames> Specify a value for the window size between 1 and 5 frames.

The default is 3 frames.

[fast-block] The fast-block blocks transmitting port to keep partial

connectivity.

awplus# configure terminal

awplus(config)# loop-protection loop-detect ldf-interval 5

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.13

loop-protection action

Use this command to specify the protective action to apply when a network loop is

detected on an interface.

Use the no variant of this command to reset the loop protection actions to the default

action, vlan-disable, on an interface.

Syntax loop-protection action {link-down|log-only|port-disable|vlan-disable|

none}

no loop-protection action

Default loop-protection action vlan-disable

Mode Interface Configuration

Usage See the Loop Protection section in Chapter 14, Switching Introduction for relevant

conceptual, configuration, and overview information prior to applying this command.

Example To disable an interface (port1.0.4), and bring the link down, when a network loop is

detected, use the commands:

Related Commands loop-protection

loop-protection timeout

show loop-protection

thrash-limiting

Parameter Description

link-down Block all traffic on a port (or aggregated link) that detected the

loop, and take down the link.

log-only Details of loop conditions are logged. No action is applied to the

port (or aggregated link).

port-disable Block all traffic on interface for which the loop occurred, but keep

the link in the up state.

vlan-disable Block all traffic for the VLAN on which the loop traffic was detected.

Note that setting this parameter will also enable ingress filtering.

This is the default action.

none Applies no protective action.

awplus# configure terminal

awplus(config)# interface port1.0.4

awplus(config-if)# loop-protection action link-down

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.14 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

loop-protection action-delay-time

Use this command to sets the loop protection action delay time for an interface to

specified values in seconds. The action delay time specifies the waiting period for the

action.

Use the no variant of this command to reset the loop protection action delay time for an

interface to default.

Syntax loop-protection action-delay-time <0-86400>

no loop-protection action

Default Action delay timer is disabled by default.

Mode Interface Configuration

Example To configure a loop protection action delay time of 10 seconds, use the commands:

To reset the Loop Protection action delay time to default, use the commands:

Related Commands show loop-protection

Parameter Description

<0-86400> Time in seconds; 0 means action delay timer is disabled.

awplus# configure terminal

awplus(config)# interface port1.0.4

awplus(config-if)# loop-protection action-delay-time

awplus# configure terminal

awplus(config)# interface port1.0.4

awplus(config-if)# no loop-protection action-delay-

time

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.15

loop-protection timeout

Use this command to specify the Loop Protection recovery action duration on an

interface.

Use the no variant of this command to set the loop protection timeout to the default.

Syntax loop-protection timeout <duration>

no loop-protection timeout

Default The default is 7 seconds.

Mode Interface Configuration

Usage See the Loop Protection section in Chapter 14, Switching Introduction for relevant

conceptual, configuration, and overview information prior to applying this command.

Example To configure a loop protection action timeout of 10 seconds for port1.0.4, use the

command:

Related Commands loop-protection

loop-protection action

show loop-protection

thrash-limiting

Parameter Description

<duration> The time (in seconds) for which the configured action will apply

before being disabled. This duration can be set between 0 and 86400

seconds (24 hours). The set of 0 means infinity so timeout does not

expire.

awplus# configure terminal

awplus(config)# interface port1.0.4

awplus(config-if)# loop-protection timeout 10

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.16 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

mac address-table acquire

Use this command to enable MAC address learning on the device.

Use the no variant of this command to disable learning.

Syntax mac address-table acquire

no mac address-table acquire

Default Learning is enabled by default for all instances.

Mode Global Configuration

Example

awplus# configure terminal

awplus(config)# mac address-table acquire

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.17

mac address-table ageing-time

Use this command to specify an ageing-out time for a learned MAC address. The learned

MAC address will persist for at least the specified time.

The no variant of this command will reset the ageing-out time back to the default of 300

seconds (5 minutes).

Syntax mac address-table ageing-time <ageing-timer> none

no mac address-table ageing-time

Default The default ageing time is 300 seconds.

Mode Global Configuration

Examples The following commands specify various ageing timeouts on the switch:

Parameter Description

<ageing-timer> <10-1000000> The number of seconds of persistence.

none Disable learned MAC address timeout.

awplus# configure terminal

awplus(config)# mac address-table ageing-time 1000

awplus# configure terminal

awplus(config)# mac address-table ageing-time none

awplus# configure terminal

awplus(config)# no mac address-table ageing-time

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.18 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

mac address-table static

Use this command to statically configure the MAC address-table to forward or discard

frames with a matching destination MAC address.

Syntax mac address-table static <mac-addr> {forward|discard} interface

<port> [vlan <vid>]

no mac address-table static <mac-addr> {forward|discard} interface

<port> [vlan <vid>]

Mode Global Configuration

Usage The mac address-table static command is only applicable to Layer 2 switched traffic

within a single VLAN. Do not apply the mac address-table static command to Layer 3

switched traffic passing from one VLAN to another VLAN. Frames will not be discarded

across VLANs because packets are routed across VLANs. This command only works on

Layer 2 traffic.

Example

Related Commands clear mac address-table static

show mac address-table

Parameter Description

<mac-addr> The destination MAC address in HHHH.HHHH.HHHH format.

<port>The port to display information about. The port may be a switch port

(e.g. port1.0.4), a static channel group (e.g. sa2), or a dynamic

(LACP) channel group (e.g. po2).

<vid> The VLAN ID. If you do not specify a VLAN, its value defaults to vlan 1.

awplus# configure terminal

awplus(config)# mac address-table static 2222.2222.2222 forward

interface port1.0.4 vlan 3

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.19

mac address-table thrash-limit

Use this command to set the thrash limit on the switch or stack. Thrashing occurs when a

MAC address table rapidly “flips” its mapping of a single MAC address between two

subnets, usually as a result of a network loop.

Use the no variant of this command to disable thrash limiting.

Syntax mac address-table thrash-limit <rate>

no mac address-table thrash-limit

Default No thrash limiting

Mode Global Configuration

Usage Use this command to limit thrashing on the selected port range.

Example To apply a thrash limit of 100 MAC address flips per second:

Related Commands show mac address-table thrash-limit

Parameter Description

<rate> sets the maximum thrash rate at which limiting is applied. This rate can

be set between 5 and 255 MAC thrashing flips per second. Once the

thrash limit rate is reached, the port is considered to be thrashing.

awplus# configure terminal

awplus(config)# mac address-table thrash-limit 100

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.20 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

mirror interface

Use this command to define a mirror port and mirrored (monitored) ports and direction of

traffic to be mirrored. The port for which you enter interface mode will be the mirror port.

The destination port is removed from all VLANs, and no longer participates in other

switching.

Use the no variant of this command to disable port mirroring by the destination port on

the specified source port.

Use the none variant of this command when using copy-to-mirror ACL and QoS

commands.

Syntax mirror interface <source-port-list> direction {both|receive|transmit}

mirror interface none

no mirror interface <source-port-list>

no mirror interface none

Mode Interface Configuration

Usage Use this command to send traffic to another device connected to the mirror port for

monitoring.

See “Port Mirroring” on page 14.17.

Parameter Description

<source-port-list> The source switch ports to mirror. A port-list can be:

■a port (e.g. port1.0.2)

■a continuous range of ports separated by a hyphen,

e.g. port1.0.1-1.0.2

■a comma-separated list of ports and port ranges,

e.g. port1.0.1,port1.0.4-1.0.6

The source port list cannot include dynamic or static

channel groups (link aggregators).

direction Specifies whether to mirror traffic that the source port

receives, transmits, or both.

both Mirroring traffic both received and transmitted by the

source port.

receive Mirroring traffic received by the source port.

transmit Mirroring traffic transmitted by the source port.

none Specify this parameter for use with the ACL (Access Control

List) access-list and QoS (Quality of Service) default action

commands when used with the copy-to-mirror parameter

option, so you can specify the destination port (the

analyzer port) for the traffic without specifying a source

mirror port. See the ACL commands access-list (hardware

IP numbered) and access-list (hardware MAC

numbered), and the QoS command default-action for

further information.

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.21

A mirror port cannot be associated with a VLAN. If a switch port is configured to be a

mirror port, it is automatically removed from any VLAN it was associated with.

This command can only be applied to a single mirror (destination) port, not to a range of

ports, nor to a static or dynamic channel group. Do not apply multiple interfaces with an

interface command before issuing the mirror interface command. One interface may have

multiple mirror interfaces.

Example To mirror traffic received and transmitted on port1.0.4 and port1.0.5 to destination

port1.0.3, use the commands:

To enable use with the access-list (hardware IP numbered) ACL and default-action QoS

commands to destination port1.0.3 without specifying a source port, use the

commands:

To mirror all TCP traffic, received or transmitted to analyzer port1.0.1, see the sample

config below:

Related Commands access-list (hardware IP numbered)

access-list (hardware MAC numbered)

default-action

awplus# configure terminal

awplus(config)# interface port1.0.3

awplus(config-if)# mirror interface port1.0.4,port1.0.5

direction both

awplus# configure terminal

awplus(config)# interface port1.0.3

awplus(config-if)# mirror interface none

awplus#show running-config

mls qos enable

access-list 3000 copy-to-mirror tcp any any

access-group 3000

interface port1.0.1

mirror interface none

switchport

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.22 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

platform stop-unreg-mc-flooding

This command stops multicast packets flooding out of all the ports in the VLAN until these

packets are registered. This command does this by sending unregistered multicast packets

to the switch processor, so there is no flooding of the multicast traffic onto the VLAN.

Unregistered traffic will not flow until the switch has registered it, regardless of attempts

to subscribe to it. Once the traffic is registered, it flows to registered subscribers and ports.

Use the no variant of this command to revert to default behavior and disable this feature.

Syntax platform stop-unreg-mc-flooding

no platform stop-unreg-mc-flooding

Default This feature is disabled by default.

Mode Global Configuration

Usage This command stops the periodic flooding of unknown or unregistered multicast packets

when the Group Membership interval timer expires and there are no subscribers to a

multicast group. If there is multicast traffic in a VLAN without subscribers, multicast traffic

temporarily floods out of the VLAN when the Group Membership interval timer expires,

which happens when the switch does not get replies from Group Membership queries.

For further information about query messages see the Staying in the Multicast Group

(Query Message) section in Chapter 32, IGMP Snooping Introduction.

This command also stops the initial flood of multicast packets that happens when a new

multicast source starts to send traffic. This flooding lasts until snooping recognizes the

multicast group. For example, in sites where IP cameras have multicast groups, traffic is

flooded to the VLAN and causes large bursts of traffic. Use this command when there is

limited processing available for large bursts of traffic, such as in sites with IP cameras.

Output See the console message warning about IPv6 operation after entering this command:

See these sample console messages when the Group Membership interval timer expires,

which happens when the switch does not get replies from Group Membership queries:

Note This command should not be used within any IPv6 networks.

IPv6 neighbor discovery operation is inhibited by this feature.

This command does not stop reserved Local Network Control Block IPv4

multicast packets in the address range 224.0.0.1 to 224.0.0.255 (224.0.0/24).

See www.iana.org/assignments/multicast-addresses/multicast-

addresses.xml#multicast-addresses-1

% WARNING: IPv6 will not work with this setting enabled

% Please consult the documentation for more information

awplus: [MLD-EVENTS] Grp - Rec Liveness Timer: Expiry for Grp ff0e::1 on port1.2.7

awplus: [IGMP-EVENTS] : Expiry (Unreg MC Timer) for Grp 224.2.2.2 on vlan4

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.23

Examples To enable this feature and stop multicast packet flooding, use the following commands:

To disable this feature and allow multicast packet flooding, use the following commands:

Related Commands show platform

show running-config

awplus# configure terminal

awplus(config)# platform stop-unreg-mc-flooding

awplus# configure terminal

awplus(config)# no platform stop-unreg-mc-flooding

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.24 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

polarity

This command sets the MDI/MDIX polarity on a copper-based switch port.

Syntax polarity {auto|mdi|mdix}

Default By default, switch ports set the polarity automatically (auto).

Mode Interface Configuration

Usage We recommend the default auto setting for MDI/MDIX polarity. Polarity applies to copper

10BASE-T, 100BASE-T, and 1000BASE-T switch ports; It does not apply to fiber ports. For

more information, see “MDI/MDIX Connection Modes” on page 14.5.

Example To set the polarity for port1.0.6 to fixed MDI mode, use the following commands:

Parameter Description

mdi Sets the polarity to MDI (medium dependent interface).

mdix Sets the polarity to MDI-X (medium dependent interface crossover).

auto The switch port sets the polarity automatically. This is the default option.

awplus# configure terminal

awplus(config)# interface port1.0.6

awplus(config-if)# polarity mdi

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.25

show flowcontrol interface

Use this command to display flow control information.

Syntax show flowcontrol interface <port>

Mode User Exec and Privileged Exec

Example To display the flow control for the port1.0.5, use the command:

Output Figure 15-1: Example output from the show flowcontrol interface command for a

specific interface

Parameter Description

<port> Specifies the name of the port to be displayed.

awplus# show flowcontrol interface port1.0.5

Port Send FlowControl Receive FlowControl RxPause TxPause

admin oper admin oper

----- ------- -------- ------- -------- ------- -------

port1.0.5 on on on on 0 0

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.26 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show loop-protection

Use this command to display the current loop protection setup for the device.

Syntax show loop-protection [interface <port-list>] [counters]

Mode User Exec and Privileged Exec

Usage This command is used to display the current configuration and operation of the Loop

Protection feature

Examples To display the current configuration status for port1.0.1, use the command:

Figure 15-2: Example output from the show loop-protection command

To display the counter information for port1.0.1, use the command:

Figure 15-3: Example output from the show loop-protection interface counters

command for port1.0.1

Parameter Description

interface The interface selected for display.

<port-list> A port, a port range, or an aggregated link.

counters Displays counter information for loop protection.

awplus# show loop-protection interface port1.0.1

Loop-Detection: Enabled

LDF Interval: 10 [sec]

Interface: port1.0.1

Action: port-disable

Timeout: 300 [sec]

Vlan: 1

Status: Blocking

Timeout Remaining: 115 [sec]

Vlan: 2

Status: Normal

Timeout Remaining: 0 [sec]

awplus #show loop-protection interface port1.0.1 counters

Interface: port1.0.1

Vlan: 1

LDF Tx: 3

LDF Rx: 1

Invalid LDF Rx: 1

Action: 1

Vlan: 2

LDF Tx: 3

LDF Rx: 0

Invalid LDF Rx: 0

Action: 0

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.27

show mac address-table

Use this command to display the mac address-table for all configured VLANs.

Syntax show mac address-table

Mode User Exec and Privileged Exec

Usage The show mac address-table command is only applicable to view a mac address-table for

Layer 2 switched traffic within VLANs.

Example To display the mac address-table, use the following command:

Output See the below sample output captured when there was no traffic being switched:

awplus# show mac address-table

awplus#show mac address-table

VLAN Port MAC State

1 unknown 0000.cd28.0752 static

ARP - 0000.cd00.0000 static

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.28 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

See the sample output captured when packets were switched and mac addresses were

learned:

Note the new mac addresses learned for port1.0.4 and port1.0.6 added as

dynamic entries.

Note the first column of the output below shows VLAN IDs if multiple VLANs are

configured:

Also note manually configured static mac-addresses are shown to the right of the type

column:

Related Commands clear mac address-table dynamic

clear mac address-table static

mac address-table static

awplus#show mac address-table

VLAN Port MAC State

1 unknown 0000.cd28.0752 static

1 port1.0.6 0030.846e.9bf4 dynamic

1 port1.0.4 0030.846e.bac7 dynamic

ARP - 0000.cd00.0000 static

awplus#show mac address-table

VLAN Port MAC State

1 unknown 0000.cd28.0752 static

1 port1.0.4 0030.846e.bac7 dynamic

2 unknown 0000.cd28.0752 static

2 port1.0.6 0030.846e.9bf4 dynamic

ARP - 0000.cd00.0000 static

awplus(config)#mac address-table static 0000.1111.2222 for int

port1.0.3 vlan 2

awplus(config)#end

awplus#

awplus#show mac address-table

VLAN Port MAC State

1 unknown 0000.cd28.0752 static

1 port1.0.2 0030.846e.bac7 dynamic

2 port1.0.3 0000.1111.2222 static

2 unknown 0000.cd28.0752 static

2 port1.0.5 0030.846e.9bf4 dynamic

ARP - 0000.cd00.0000 statics

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.29

show mac address-table thrash-limit

Use this command to display the current thrash limit set for all interfaces on the device.

Syntax show mac address-table thrash-limit

Mode User Exec and Privileged Exec

Example To display the current, use the following command:

Output Figure 15-4: Example output from the show mac address-table thrash-limit

command

Related Commands mac address-table thrash-limit

awplus# show mac address-table thrash-limit

% Thrash-limit 7 movements per second

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.30 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show mirror

Use this command to display the status of all mirrored ports.

Syntax show mirror

Mode User Exec and Privileged Exec

Example To display the status of all mirrored ports, use the following command:

Output Figure 15-5: Example output from the show mirror command

awplus# show mirror

Mirror Test Port Name: port1.0.1

Mirror option: Enabled

Mirror direction: both

Monitored Port Name: port1.0.2

Mirror Test Port Name: port1.0.3

Mirror option: Enabled

Mirror direction: receive

Monitored Port Name: port1.0.4

Mirror Test Port Name: port1.0.3

Mirror option: Enabled

Mirror direction: receive

Monitored Port Name: port1.0.1

Mirror Test Port Name: port1.0.1

Mirror option: Enabled

Mirror direction: receive

Monitored Port Name: port1.0.3

Mirror Test Port Name: port1.0.1

Mirror option: Enabled

Mirror direction: transmit

Monitored Port Name: port1.0.4

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.31

show mirror interface

Use this command to display port mirroring configuration for a mirrored (monitored)

switch port.

Syntax show mirror interface <port>

Mode User Exec, Privileged Exec and Interface Configuration

Example To display port mirroring configuration for the port1.0.4, use the following commands:

Output Figure 15-6: Example output from the show mirror interface command

Parameter Description

<port>The monitored switch port to display information about.

awplus# configure terminal

awplus(config)# interface port1.0.4

awplus(config-if)# show mirror interface port1.0.4

Mirror Test Port Name: port1.0.3

Mirror option: Enabled

Mirror direction: both

Monitored Port Name: port1.0.4

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.32 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show platform

This command displays the settings configured by using the platform commands.

Syntax show platform

Mode Privileged Exec

Usage This command displays the settings in the running config. For changes in some of these

settings to take effect, the switch must be rebooted with the new settings in the startup

config.

Example To check the settings configured with platform commands on the switch, use the

following command:

awplus# show platform

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.33

show platform classifier statistics utilization brief

This command displays the number of used entries available for various platform

functions, and the percentage that number of entries represents of the total available.

Syntax show platform classifier statistics utilization brief

Mode Privileged Exec

Example To display the platform classifier utilization statistics, use the following command:

Output Figure 15-7: Output from the show platform classifier statistics utilization brief

command

Related Commands show platform

awplus# show platform classifier statistics utilization brief

[Instance 3.0]

(Port1.0.1-1.0.24)

Number of Entries:

Policy Type Group ID Used / Total

----------------------------------------------

ACL 1476395009 0 / 122 ( 0%)

DoS -1 0 / 0 ( 0%)

VLAN Counter -1 0 / 0 ( 0%)

QoS 0 / 768 ( 0%)

[Instance 3.1]

(Port1.0.25-1.0.48)

Number of Entries:

Policy Type Group ID Used / Total

----------------------------------------------

ACL 1476395009 0 / 122 ( 0%)

DoS -1 0 / 0 ( 0%)

VLAN Counter -1 0 / 0 ( 0%)

QoS 2 / 768 ( 0%)

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.34 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show platform port

This command displays the various port registers or platform counters for specified

switchports.

Syntax show platform port [<port-list>|counters]

Mode Privileged Exec

Examples To display port registers for port1.0.1 and port1.0.2 use the following command:

To display platform counters for port1.0.1 and port1.0.2 use the following

command:

Output Figure 15-8: Example output from the show platform port command

Parameter Description

<port-list> The ports to display information about. A port-list can be:

■a continuous range of ports separated by a hyphen,

e.g. port1.0.1-1.0.6

■a comma-separated list of ports and port ranges,

e.g. port1.0.1,port1.0.4-1.0.6.

counters Show the platform counters.

awplus# show platform port port1.0.1-port1.0.2

awplus# show platform port port1.0.1-port1.0.2 counters

awplus#show platform port port1.0.1

Phy register value for port1.0.1 (ifindex: 5001)

00:1140 01:7949 02:0020 03:60B1 04:01E1 05:0000 06:0004 07:2001

08:0000 09:0600 10:0000 11:0000 12:0000 13:0000 14:0000 15:0000

16:0000 17:0000 18:0000 19:0000 20:0000 21:0000 22:0000 23:0000

24:0000 25:0000 26:0000 27:0000 28:0000 29:0000 30:0000 31:0000

Port configuration for lport 0x08001000:

enabled: 1

loopback: 0

link: 0

speed: 0 max speed: 1000

duplex: 0

linkscan: 2

autonegotiate: 1

master: 2

tx pause: 1 rx pause: 1

untagged vlan: 1

vlan filter: 3

stp state: 1

learn: 5

discard: 0

max frame size: 1522

MC Disable SA: no

MC Disable TTL: no

MC egress untag: 0

MC egress vid: 0

MC TTL threshold: -1

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.35

Table 15-1: Parameters in the output from the show platform port command

Parameter Description

Ethernet MAC counters

Combined receive/

transmit packets by

size (octets) counters

Number of packets in each size range received and

transmitted.

64 Number of 64 octet packets received and

transmitted.

65 - 127 Number of 65 - 127 octet packets received and

transmitted.

128 - 255 Number of 128 - 255 octet packets received and

transmitted.

256 - 511 Number of 256 - 511 octet packets received and

transmitted.

512 - 1023 Number of 512 - 1023 octet packets received and

transmitted.

1024 - MaxPktSz Number of packets received and transmitted with

size 1024 octets to the maximum packet length.

1519 - 1522 Number of 1519 - 1522 octet packets received and

transmitted.

1519 - 2047 Number of 1519 - 2047 octet packets received and

transmitted.

2048 - 4095 Number of 2048 - 4095 octet packets received and

transmitted.

4096 - 9216 Number of 4096 - 9216 octet packets received and

transmitted.

General Counters

Receive Counters for traffic received.

Octets Number of octets received.

Pkts Number of packets received.

FCSErrors Number of FCS (Frame Check Sequence) error events

received.

UnicastPkts Number of unicast packets received.

MulticastPkts Number of multicast packets received.

BroadcastPkts Number of broadcast packets received.

PauseMACCtlFrms Number of Pause MAC Control Frames received.

OversizePkts Number of oversize packets received.

Fragments Number of fragments received.

Jabbers Number of jabber frames received.

UnsupportOpcode Number of MAC Control frames with unsupported

opcode received.

AlignmentErrors Receive Alignment Error Frame Counter.

SysErDurCarrier Receive Code Error Counter.

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.36 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

CarrierSenseErr Receive False Carrier Counter.

UndersizePkts Number of undersized packets received.

Transmit Counters for traffic transmitted.

Octets Number of octets transmitted.

Pkts Number of packets transmitted.

UnicastPkts Number of unicast packets transmitted.

MulticastPkts Number of multicast packets transmitted.

BroadcastPkts Number of broadcast packets transmitted.

PauseMACCtlFrms Number of Pause MAC Control Frames transmitted.

OversizePkts Number of oversize packets transmitted.

FrameWDeferrdTx Transmit Single Deferral Frame counter.

FrmWExcesDefer Transmit Multiple Deferral Frame counter.

SingleCollsnFrm Transmit Single Collision Frame counter.

MultCollsnFrm Transmit Multiple Collision Frame counter.

LateCollisions Transmit Late Collision Frame counter.

ExcessivCollsns Transmit Excessive Collision Frame counter.

Collisions Transmit Total Collision counter

Layer 3 Counters

ifInUcastPkts Inbound interface Unicast counter.

ifInDiscards Inbound interface Discarded Packets counter.

ipInHdrErrors Inbound interface Header Errors counter.

ifOutUcastPkts Outbound interface Unicast counter.

ifOutErrors Outbound interface Error counter.

Miscellaneous Counters

DropEvents Drop Event counter

ifOutDiscards Outbound interface Discarded Packets counter.

MTUExcdDiscard Receive MTU Check Error Frame Counter

Table 15-1: Parameters in the output from the show platform port command (cont.)

Parameter Description

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.37

Output Figure 15-9: Example output from the show platform port counters command

awplus#show platform port port1.0.1 counters

Switch Port Counters

--------------------------------------------------------------------------

Port port1.0.1 Ethernet MAC counters:

Combined receive/transmit packets by size (octets) counters:

64 0 1024 - MaxPktSz 0

65 - 127 0 1519 - 1522 0

128 - 255 0 1519 - 2047 0

256 - 511 0 2048 - 4095 0

512 - 1023 0 4096 - 9216 0

General Counters:

Receive Transmit

Octets 0 Octets 0

Pkts 0 Pkts 0

FCSErrors 0

UnicastPkts 0 UnicastPkts 0

MulticastPkts 0 MulticastPkts 0

BroadcastPkts 0 BroadcastPkts 0

PauseMACCtlFrms 0 PauseMACCtlFrms 0

OversizePkts 0

Fragments 0

Jabbers 0

UnsupportOpcode 0

AlignmentErrors 0

SymErDurCarrier 0

CarrierSenseErr 0

UndersizePkts 0

FrameWDeferrdTx 0

FrmWExcesDefer 0

SingleCollsnFrm 0

MultCollsnFrm 0

LateCollisions 0

ExcessivCollsns 0

Collisions 0

Layer 3 Counters:

ifInUcastPkts 0 ifOutUcastPkts 0

ifInDiscards 0 ifOutErrors 0

ipInHdrErrors 0

Miscellaneous Counters:

DropEvents 0

ifOutDiscards 0

MTUExcdDiscard 0

--------------------------------------------------------------------------

Table 15-2: Output parameters from the show platform port counters command

Parameter Description

Ethernet MAC counters

Combined receive/

transmit packets by

size (octets)

counters

Number of packets in each size range received and

transmitted.

64 Number of 64 octet packets received and transmitted.

65 - 127 Number of 65 - 127 octet packets received and

transmitted.

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.38 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

128 - 255 Number of 128 - 255 octet packets received and

transmitted.

256 - 511 Number of 256 - 511 octet packets received and

transmitted.

512 - 1023 Number of 512 - 1023 octet packets received and

transmitted.

1024 - MaxPktSz Number of packets received and transmitted with size

1024 octets to the maximum packet length.

General Counters

Receive Counters for traffic received.

Octets Number of octets received.

Pkts Number of packets received.

CRCErrors Number of CRC (Cyclic Redundancy Check) error events

received.

UnicastPkts Number of unicast packets received.

MulticastPkts Number of multicast packets received.

BroadcastPkts Number of broadcast packets received.

FlowCtrlFrms Number of good Flow Control frames received.

OversizePkts Number of oversize packets received.

Fragments Number of fragments received.

Jabbers Number of jabber frames received.

UnsupportOpcode Number of MAC Control frames with unsupported opcode

received.

UndersizePkts Number of undersized packets received.

Transmit Counters for traffic transmitted.

Octets Number of octets transmitted.

Pkts Number of packets transmitted.

UnicastPkts Number of unicast packets transmitted.

MulticastPkts Number of multicast packets transmitted.

BroadcastPkts Number of broadcast packets transmitted.

FlowCtrlFrms Number of good Flow Control frames transmitted.

OversizePkts Number of oversize packets transmitted.

FlowCtrlFrms The number of Flow Control frames transmitted.

Collisions Total number of collisions seen by the MAC.

LateCollisions Total number of late collisions seen by the MAC.

ExcessivCollsns Number of frames dropped in the transmit MAC due to

excessive collisions. This is applicable for Half-Duplex

mode only.

Table 15-2: Output parameters from the show platform port counters command

Parameter Description

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.39

Miscellaneous Counters

Mac TxErr Number of frames not transmitted correctly or dropped

due to internal MAC transmit error.

Mac RxErr Number of Receive Error events seen by the receive side of

the MAC.

DropEvents Number of instances that the port was unable to receive

packets due to insufficient bandwidth to one of the PP

internal resources, such as the DRAM or buffer allocation.

Table 15-2: Output parameters from the show platform port counters command

Parameter Description

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.40 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show port-security interface

Use this command to show the current port-security configuration and the switch port

status.

Syntax show port-security interface <port>

Mode Privileged Exec

Example To see the port-security status on port1.0.1, use the following command:

Output Figure 15-10: Example output from the show port-security interface command

Parameter Description

<port> The port to display information about. The port may be a switch

port (e.g. port1.0.4), a static channel group (e.g. sa3), or a

dynamic (LACP) channel group (e.g. po4).

awplus# show port-security interface port1.0.1

Port Security configuration

Security Enabled : YES

Port Status : ENABLED

Violation Mode : TRAP

Aging : OFF

Maximum MAC Addresses : 3

Total MAC ddresses : 1

Lock Status : UNLOCKED

Security Violation Count : 0

Last Violation Source Address : None

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.41

show port-security intrusion

Shows the intrusion list. If the port is not specified, the entire intrusion table is shown.

Syntax show port-security intrusion [interface <port>]

Mode Privileged Exec

Example To see the intrusion list on port1.0.1, use the following command:

Output Figure 15-11: Example output from the show port-security intrusion command for

port 1.0.1

Parameter Description

interface Specify a port

<port>The port to display information about. The port may be a switch

port (e.g. port1.0.4), a static channel group (e.g. sa3), or a

dynamic (LACP) channel group (e.g. po4).

awplus# show port-security intrusion interface port1.0.1

Port Security Intrusion List

Interface: port1.0.1 -3 intrusion(s) detected

11-22-33-44-55-04 11-22-33-44-55-06 11-22-33-44-55-08

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.42 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show storm-control

Use this command to display storm-control information for all interfaces or a particular

interface.

Syntax show storm-control [<port>]

Mode User Exec and Privileged Exec

Example To display storm-control information for port1.0.2, use the following command:

Output Figure 15-12: Example output from the show storm-control command for port1.0.2

Example To display storm-control information for all ports, use the following command:

Output Figure 15-13: Example output from the show storm-control command for all ports

Related Commands storm-control level

Parameter Description

<port>The port to display information about. The port may be a switch port

(e.g. port1.0.4), a static channel group (e.g. sa2), or a dynamic

(LACP) channel group (e.g. po2).

awplus# show storm-control port1.0.2

Port BcastLevel McastLevel DlfLevel

port1.0.2 40. 0% 100. 0% 100. 0%

awplus# show storm-control

awplus#show storm-control

Port BcastLevel McastLevel DlfLevel

port1.0.1 100.0% 100.0% 100.0%

port1.0.2 100.0% 100.0% 100.0%

port1.0.3 100.0% 100.0% 100.0%

port1.0.4 100.0% 100.0% 100.0%

port1.0.5 100.0% 100.0% 100.0%

port1.0.6 100.0% 100.0% 100.0%

port1.0.7 100.0% 100.0% 100.0%

port1.0.8 100.0% 100.0% 100.0%

port1.0.9 100.0% 100.0% 100.0%

port1.0.10 100.0% 100.0% 100.0%

port1.0.11 100.0% 100.0% 100.0%

port1.0.12 100.0% 100.0% 100.0%

port1.0.13 100.0% 100.0% 100.0%

port1.0.14 100.0% 100.0% 100.0%

port1.0.15 100.0% 100.0% 100.0%

port1.0.16 100.0% 100.0% 100.0%

port1.0.17 100.0% 100.0% 100.0%

port1.0.18 100.0% 100.0% 100.0%

port1.0.19 100.0% 100.0% 100.0%

port1.0.20 100.0% 100.0% 100.0%

port1.0.21 100.0% 100.0% 100.0%

port1.0.22 100.0% 100.0% 100.0%

port1.0.23 100.0% 100.0% 100.0%

port1.0.24 100.0% 100.0% 100.0%

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.43

speed

This command changes the speed of the specified port. You can optionally specify the

speed or speeds that get autonegotiated, so autonegotiation is only attempted at the

specified speeds.

To see the currently-negotiated speed for ports whose links are up, use the show

interface command. To see the configured speed (when different from the default), use

the show running-config command.

Syntax speed {10|100|1000|10000|auto [10][100][1000][10000]}

The following table shows the speed options for each type of port.

Mode Interface Configuration

Default By default, ports autonegotiate speed (except for 100Base-FX ports which do not support

auto-negotiation, so default to 100Mbps).

Usage Switch ports in a static or dynamic (LACP) channel group must have the same port speed

and be in full duplex mode. Once switch ports have been aggregated into a channel

group, you can set the speed of all the switch ports in the channel group by applying this

command to the channel group.

Examples To set the speed of a tri-speed port to

00Mbps, enter the following commands:

Port type Speed Options (units are Mbps)

RJ-45 and RJ.5copper ports auto (default)

000

supported tri-speed copper

SFPs

auto (default)

000

00Mb fiber SFPs

000Mb fiber SFPs auto (default)

000

10000Mb fiber SFP+ auto (default)

0000

Note Note that if multiple speeds are specified after the auto option to

autonegotiate speeds, then only those speeds specified are attempted for

autonegotiation.

awplus# configure terminal

awplus(config)# interface port1.0.4

awplus(config-if)# speed 100

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.44 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

To return the port to auto-negotiating its speed, enter the following commands:

To set a port to auto-negotiate its speed at 100Mbps and 1000Mbps, enter the following

commands:

To set a port to auto-negotiate its speed at 1000Mbps only, enter the following

commands:

Related Commands duplex

ecofriendly lpi

polarity

show interface

speed (asyn)

awplus# configure terminal

awplus(config)# interface port1.0.4

awplus(config-if)# speed auto

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# speed auto 100 1000

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# speed auto 1000

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.45

storm-control level

Use this command to specify the threshold level for broadcasting, multicast, or destination

lookup failure (DLF) traffic for the port. Storm-control limits the specified traffic type to the

specified threshold.

Use the no variant of this command to disable storm-control for broadcast, multicast or

DLF traffic.

Syntax storm-control {broadcast|multicast|dlf} level <level>

no storm-control {broadcast|multicast|dlf} level

Default By default, storm-control is disabled.

Mode Interface Configuration

Usage Flooding techniques are used to block the forwarding of unnecessary flooded traffic. A

packet storm occurs when a large number of broadcast packets are received on a port.

Forwarding these packets can cause the network to slow down or time out.

Example To limit broadcast traffic on port1.0.2 to 30% of the maximum port speed, use the

following commands:

Related Commands show storm-control

Parameter Description

<level> <0-100> Specifies the threshold as a percentage of the maximum

port speed.

broadcast Applies the storm-control to broadcast frames.

multicast Applies the storm-control to multicast frames.

dlf Applies the storm-control to destination lookup failure traffic.

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# storm-control broadcast level 30

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.46 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

thrash-limiting

Sets and configures the thrash limit action that will be applied to any port on the switch

when a thrashing condition is detected. The thrash-limiting timeout specifies the time, in

seconds, for which the thrash action is employed.

Syntax thrash-limiting {[action {learn-disable|link-down|port-disable|

vlan-disable|none}] [timeout <0-86400>]}

no thrash-limiting {action|timeout}

Default The default action is learn-disable.

Mode Interface Configuration

Usage See the Thrash Limiting section in Chapter 14, Switching Introduction for relevant

conceptual, configuration, and overview information prior to applying this command.

Examples To set the action to learn disable for port1.0.4, use the following commands:

To block all traffic on a vlan, use the following command:

To set the thrash limiting timeout to 5 seconds, use the following command:

Parameter Description

action The mac thrashing detected action. The default is vlan-disable.

learn-disable Disable mac address learning

link-down Block all traffic on an interface - link down

port-disable Block all traffic on an interface - link remains up

vlan-disable Block all traffic on a vlan. Note that setting this parameter will

also enable ingress filtering.

none No thrash action

timeout Set the duration for the thrash action

<0-86400> The duration of the applied thrash action in seconds. The

default is 1 seconds.

awplus# configure terminal

awplus(config)# interface port1.0.4

awplus(config-if)# thrash-limiting action learn-disable

awplus# configure terminal

awplus(config)# thrash-limiting action vlan-disable

awplus(config-if)# thrash-limiting timeout 5

Switching Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 15.47

To set the thrash limiting action to its default, use the following command:

To set the thrash limiting timeout to its default, use the following command:

Related Commands loop-protection

loop-protection action

loop-protection timeout

show loop-protection

awplus(config-if)# no thrash-limiting action

awplus(config-if)# no thrash-limiting timeout

Switching Commands

Software Reference for GS900MX/MPX Series Switches

15.48 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 16.1

Chapter 16: VLAN Introduction

VLANs Introduction .......................................................................................................................... 16.2

Virtual LANs (VLANs) ........................................................................................................................ 16.2

Configuring VLANs.................................................................................................................... 16.3

Private VLANs ..................................................................................................................................... 16.5

Private VLANs for Ports in Access Mode ............................................................................ 16.5

Private VLAN Operation with Ports in Access Mode ..................................................... 16.7

Access Mode Private VLAN Configuration Example...................................................... 16.8

Private VLANs for Trunked Ports ........................................................................................16.11

Trunked Port Private VLAN Configuration Example....................................................16.12

Protocol Based VLAN Configuration Example...............................................................16.16

VLAN Introduction

Software Reference for GS900MX/MPX Series Switches

16.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

VLANs Introduction

This chapter describes Virtual LANs (VLAN), VLAN features and configuration on the

switch. For detailed descriptions of commands used to configure VLANs, see Chapter 17,

VLAN Commands. For information about Voice VLAN and LLDP-MED, see Chapter 69,

LLDP, LLDP-MED and Voice VLAN Introduction and Configuration.

Virtual LANs (VLANs)

A Virtual LAN (VLAN) is a logical, software-defined subnetwork. It allows similar devices on

the network to be grouped together into one broadcast domain, irrespective of their

physical position in the network. Multiple VLANs can be used to group workstations,

servers, and other network equipment connected to the switch, according to similar data

and security requirements.

Decoupling logical broadcast domains from the physical wiring topology offers several

advantages, including the ability to:

■Move devices and people with minimal, or no, reconfiguration

■Change a device’s broadcast domain and access to resources without physically

moving the device, by software reconfiguration or by moving its cable from one

switch port to another

■Isolate parts of the network from other parts, by placing them in different VLANs

■Share servers and other network resources without losing data isolation or security

■Direct broadcast traffic to only those devices which need to receive it, to reduce traffic

across the network

■Connect 802.1Q-compatible switches together through one port on each switch

Devices that are members of the same VLAN only exchange data with each other through

the switch’s Layer 2 switching capabilities. To exchange data between devices that are

located in different VLANs, the switch’s Layer 3 (routing) capabilities are used.

Different IP subnets are associated with different VLANs. The switch’s IP router table will be

populated by the routes to the subnets on any active VLANs, and by routes statically

configured over active VLAN interfaces, or learned via routing protocols operating over

these interfaces.

The device supports up to 4094 VLANs (the maximum allowed by the VID field in the

802.1Q tag). On some devices a few of these VLANs may be reserved for management

purposes.

When the switch is first powered up (and therefore unconfigured), it creates a default

VLAN with a VID of 1 and an interface name of vlan1. In this initial condition, the switch

attaches all its ports to this default VLAN.

The default VLAN cannot be deleted, and ports can only be removed from it if they also

belong to at least one other VLAN. If all the devices on the physical LAN belong to the

same logical LAN, that is, the same broadcast domain, then the default settings will be

acceptable, and no additional VLAN configuration is required.

VLAN Introduction

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 16.3

Configuring VLANs

Defaults By default, all switch ports are in access mode, are associated with the default VLAN

(vlan1), and have ingress filtering on. You cannot delete vlan1.

VLAN names When you create a VLAN (using the vlan command), you give it a numerical VLAN

Identifier (VID) - a number from 2 to 4094. If tagged frames are transmitted from this VLAN,

they will contain this VID in their tag. You may also give it an arbitrary alphanumeric name

containing a meaningful description, which is not transmitted to other devices.

When referring to a VLAN, some commands require the VLAN to be specified by its VID

while some commands require it to be specified by its interface name: vlan<VID>. In

command output, the VLAN may be referred to by its VID, its interface name (vlan<VID>),

or its VLAN name (the arbitrary alphanumeric string).

You can name a VLAN with a string containing “vlan” and its VLAN Identifier (VID). To avoid

confusion, we recommend not naming it “vlan” followed by any number different from its

VID.

Access mode A switch port in access mode sends untagged Ethernet frames, that is, frames without a

VLAN tag. Each port is associated with one VLAN (the port-based VLAN, by default, vlan1),

and when it receives untagged frames, it associates them with the VID of this VLAN. You

can associate the port with another VLAN (using the switchport access vlan command).

This removes it from the default VLAN.

Use access mode for any ports connected to devices that do not use VLAN tagging, for

instance PC workstations.

Trunk mode A switch port in trunk mode is associated with one or more VLANs for which it transmits

VLAN-tagged frames, and for which it identifies incoming tagged frames with these VIDs.

To allow a switch port to distinguish and identify traffic from different VLANs, put it in

trunk mode (using the switchport mode trunk command), and add the VLANs (using the

switchport trunk allowed vlan command). Use trunk mode for ports connected to other

switches which send VLAN-tagged traffic from one or more VLANs.

A trunk mode port may also have a native VLAN (by default vlan1), for which it transmits

untagged frames, and with which it associates incoming untagged frames (using the

switchport trunk native vlan command).

Ports in trunk mode can be enabled as promiscuous ports for private VLANs (using the

switchport mode private-vlan trunk promiscuous) and secondary ports for private

VLANs (using the switchport mode private-vlan trunk secondary).

Mirror ports A mirror port cannot be associated with a VLAN. If a switch port is configured to be a

mirror port (using the mirror interface command), it is automatically removed from any

VLAN it was associated with.

VLANs and

channel groups

All the ports in a channel group must have the same VLAN configuration: they must

belong to the same VLANs and have the same tagging status, and can only be operated

on as a group.

VLAN Introduction

Software Reference for GS900MX/MPX Series Switches

16.4 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Table 16-1: Configuration procedure for VLANs

Step 1. Create VLANs

awplus#

configure terminal Enter Configuration mode.

awplus(config)#

vlan database Enter VLAN Configuration mode.

awplus(config-vlan)#

vlan <vid> [name <vlan-name>]

[state {enable|disable}]

vlan <vid-range> [state {enable|

disable}]

Create VLANs.

Step 2. Associate switch ports with VLANs

awplus(config-vlan)#

interface <port-list> Associate switch ports in access mode with VLANs:

Enter Interface Configuration mode for the switch ports

that will be in access mode for a particular VLAN.

Associate the VLAN with these ports in access mode.

Repeat for other VLANs and ports in access mode.

awplus(config-if)#

switchport access vlan <vlan-id>

awplus(config-if)#

interface <port-list> Associate switch ports in trunk mode with VLANs. Enter

Interface Configuration mode for all the switch ports that

will be in trunk mode for a particular set of VLANs.

Set these switch ports to trunk mode.

Allow these switch ports to trunk this set of VLANs.

awplus(config-if)#

switchport mode trunk

[ingress-filter {enable|disable}]

awplus(config-if)#

switchport trunk allowed vlan all

switchport trunk allowed vlan add

<vid-list>

awplus(config-if)#

switchport trunk native vlan

{<vid>|none}

By default, a trunk mode switch port’s native VLAN, the

VLAN that the port uses for untagged packet, is VLAN

If required, change the native VLAN from the default.

awplus(config-if)#

exit Return to Global Configuration mode.

awplus(config)#

exit Return to Privileged Exec mode.

awplus#

show vlan {all|brief|dynamic|

static|auto|static-ports<1-4094>}

Confirm VLAN configuration.

VLAN Introduction

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 16.5

Private VLANs

Private VLANs combine the network advantages of conventional VLANs, with an added

degree of privacy obtained by limiting the connectivity between selected ports.

This section provides an introduction to:

■Private VLANs for ports in access mode

■Private VLANs for Trunked Ports

Private VLANs for Ports in Access Mode

An example application of a private VLAN would be a library in which user booths each

have a PC with Internet access. In this situation it would usually be undesirable to allow

communication between these individual PCs. Connecting the PC to ports within a private

isolated VLAN would enable each PC to access the Internet or a library server via a single

connection, whilst preventing access between the PCs in the booths.

Another application might be to use private VLANs to simplify IP address assignment.

Ports can be isolated from each other whilst still belonging to the same subnet.

A private VLAN comprises the following components:

■a single promiscuous port

■one or more host ports. There are two types of host port:

« isolated ports: These can only communicate with the promiscuous port that is

associated with the isolated VLAN.

« community ports: These can communicate with their associated promiscuous

port and other community ports within the community VLAN.

■a single primary VLAN

■one or more secondary VLANs: There are two types of secondary VLAN:

« isolated VLANs: In this VLAN type, communication can only take place between

each host port and its associated promiscuous port.

« community VLANs: In this VLAN type, communication can take place between

host ports and between each host port and its associated promiscuous port.

Membership rules for private VLANs in access mode

The following membership rules apply when creating and operating private VLANs in

access mode.

Each private VLAN:

■must contain one promiscuous port (or aggregated link)

■may contain multiple host ports

■can be configured to span switch instances

■can only contain promiscuous and host ports

■cannot use the default VLAN (vlan1)

■a private isolated VLAN can only contain a single promiscuous port

■a private community VLAN can contain more than one promiscuous port

VLAN Introduction

Software Reference for GS900MX/MPX Series Switches

16.6 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

A promiscuous port:

■is a member of the primary VLAN and all its associated secondary VLANs

■cannot be a member of both private and non-private VLANs

A host port:

■can be a member of multiple private (community) VLANs, but all these VLANs must

share the same promiscuous port

■cannot be a host port in some VLANs and a non-host port in others

■cannot be a promiscuous port in another VLAN

Promiscuous ports

A promiscuous port can communicate with all ports that are members of its associated

secondary VLANs. Multiple promiscuous ports can exist in a primary VLAN, but only if the

primary VLAN is only associated with community VLANS (that is, that there are no isolated

VLANs associated with this port).

A promiscuous port is a member of the primary VLAN and all associated secondary VLANs.

Its Port VID is set to the VLAN ID of the primary VLAN.

Host ports

Host ports have two levels of connectivity depending on whether they exist in an isolated

or a community VLAN.

1. Host ports within an isolated VLAN

These ports are only allowed to communicate with their VLAN’s promiscuous port, even

though they share their secondary (isolated) VLAN with other hosts. The host ports receive

their data from the promiscuous port via the primary VLAN, and individually transmit their

data to the promiscuous port via their common secondary VLAN.

2. Host ports within a community VLAN

These ports are able to communicate with both the promiscuous port and the other ports

within the community VLAN that they are associated with. They receive their data from

the promiscuous port via the primary VLAN, and transmit their data to both the

promiscuous port and the other host ports (within their community VLAN) via their

common secondary VLAN. However, the only external path from a community VLAN is

from its promiscuous port.

VLAN Introduction

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 16.7

Private VLAN Operation with Ports in Access Mode

A basic private VLAN operation is shown in the following figure. It comprises a primary

VLAN 20 plus community and isolated VLANS.

Figure 16-1: Private VLAN

The ports on this switch have the following configuration:

■Port 1.0.1 is the promiscuous port and is a member of the primary VLAN 20 and all its

associated secondary VLANs.

■Ports 1.0.2 to 1.0.4 are members of the community VLAN 21 and are able to

communicate with both the promiscuous port and all other ports in VLAN 21.

■Ports 1.0.10 to 1.0.12 are members of the community VLAN 22 and are able to

communicate with both the promiscuous port and all other ports in VLAN 22.

■Ports 1.0.6 to 1.0.8 are members of the isolated VLAN 23. Each of these ports can only

communicate with the promiscuous port.

Table 16-2: Private VLANs - Port Tagging

Port Mode Untagged VLAN Membership PVID

1.0.1 Promiscuous 20, 21, 22, 23 20

1.0.2 to 1.0.4 Host 20, 21 21

1.0.10 to 1.0.12 Host 20, 22 22

1.0.6 to 1.0.8 Host 20, 23 23

1.0.5 Not members of the private VLAN -

1.0.9 Not members of the private VLAN -

private_VLAN_1_1

Internet

WEB

Server

Ports 1.0.2 to 1.0.4

Community VLAN 21

plus

Primary VLAN 20

Ports 1.0.10 to 1.0.12

Community VLAN 22

plus

Primary VLAN 20

Ports 1.0.6 to 1.0.8

Isolated VLAN 23

plus

Primary VLAN 20

Promiscuous

Port 1.0.1

VLANs 20 to 23

VLAN Introduction

Software Reference for GS900MX/MPX Series Switches

16.8 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Private VLANs operate within a single switch and comprise one primary VLAN plus a

number of secondary VLANS. All data enters the private VLAN ports untagged.

Using the example of Figure 16-1, data enters the switch via the promiscuous

port1.0.1 and is forwarded to the host ports using VLAN 20, the primary VLAN. Data

returning from the host ports to the promiscuous port (and exiting the switch) use the

secondary VLAN associated with its particular host port, VLAN 21, 22, or 23 in the example.

Thus the data flows into the switch via the primary VLAN and out of the switch via the

secondary VLANs. This situation is not detected outside of the switch, because all its

private ports are untagged. Note however, that data flowing between ports within the

same community VLAN will do so using the VID of the community VLAN.

Portfast on private VLANS

Within private VLANs, we recommend that you place all host ports into spanning-tree

portfast mode and enable BPDU guard. Portfast assumes that because host ports will also

be edge ports, they will have no alternative paths (loops) via other bridges. These ports

are therefore allowed to move directly from the spanning-tree blocking state into the

forwarding state, thus bypassing the intermediate states.

Applying BPDU guard is an extra precaution. This feature disables an edge port if it

receives a BPDU frame, because receiving such a frame would indicate that the port has a

connection to another network bridge.

For more information on BPDU guard and portfast, see their following commands:

■spanning-tree portfast bpdu-guard command on page 19.64

■spanning-tree portfast (STP) command on page 19.60

Access Mode Private VLAN Configuration Example

Table 16-3: Configuration procedure for access mode private VLANs

Command Description

Step 1. Create the VLANs

awplus#

configure terminal Enter Global Configuration mode.

awplus(config)#

vlan database Enter VLAN Configuration mode.

awplus(config-vlan)#

vlan 20-23 Create the VLANs.

Step 2. Create the private VLANs and set the type

awplus(config-vlan)#

private-vlan 20 primary Create primary VLAN 20.

awplus(config-vlan)#

private-vlan 21 community Create community VLAN 21.

awplus(config-vlan)#

private-vlan 22 community Create community VLAN 22.

VLAN Introduction

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 16.9

awplus(config-vlan)#

private-vlan 23 isolated Create isolated VLAN 23.

Step 3. Associate the secondary VLANs with the primary VLAN

awplus(config-vlan)#

private-vlan 20 association

add 21

Associate secondary VLAN 21 with the

primary VLAN 20.

awplus(config-vlan)#

private-vlan 20 association

add 22

Associate secondary VLAN 22 with the

primary VLAN 20.

awplus(config-vlan)#

private-vlan 20 association

add 23

Associate secondary VLAN 23 with the

primary VLAN 20.

Step 4. Set port 1.0.1 to be the promiscuous port

awplus(config-if)#

exit Return to Global Configuration mode.

awplus(config)#

interface port1.0.1 Enter Interface Configuration mode for

port1.0.1.

awplus(config-if)#

switchport mode private-

vlan promiscuous

Set the port as a promiscuous ports.

Step 5. Set the other ports to be host ports

awplus(config-if)#

exit Return to Global Configuration mode.

awplus(config)#

interface port1.0.2-1.0.4,

port1.0.6

Enter Interface Configuration mode for the

ports.

awplus(config-if)#

switchport mode private-

vlan host

Set the ports as host ports.

Step 6. On the promiscuous port, map the primary VLAN to each of the

secondary VLANs

awplus(config-if)#

exit Return to Global Configuration mode.

awplus(config)#

interface port1.0.1 Enter Interface Configuration mode for

port1.0.1.

Table 16-3: Configuration procedure for access mode private VLANs (cont.)

Command Description

VLAN Introduction

Software Reference for GS900MX/MPX Series Switches

16.10 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

awplus(config-if)#

switchport private-vlan

mapping 20 add 21-23

Associate primary VLAN 20 and the

secondary VLANs 21 to 23 to the

promiscuous port.

Step 7. Associate the community host ports with the community VLANs

awplus(config-if)#

exit Return to Global Configuration mode.

awplus(config)#

interface port1.0.2-1.0.4 Enter Interface Configuration mode for ports

1.0.2 to 1.0.4.

awplus(config-if)#

switchport private-vlan

host-association 20 add 21

Associate primary VLAN 20 and secondary

VLAN 21 to the host ports.

awplus(config-if)#

exit Return to Global Configuration mode.

awplus(config)#

interface port1.0.10-1.0.12 Enter Interface Configuration mode for ports

1.0.10 to 1.0.12.

awplus(config-if)#

switchport private-vlan

host-association 20 add 22

Associate primary VLAN 20 and secondary

VLAN 22 to the host ports.

Step 8. Associate the isolated host ports with the isolated VLAN 23

awplus(config-if)#

exit Return to Global Configuration mode.

awplus(config)#

interface port1.0.6-1.0.8 Enter Interface Configuration mode for ports

1.0.6 to 1.0.8.

awplus(config-if)#

switchport private-vlan

host-association 20 add 23

Associate primary VLAN 20 and secondary

VLAN 23 to the host ports.

Table 16-3: Configuration procedure for access mode private VLANs (cont.)

Command Description

VLAN Introduction

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 16.11

Private VLANs for Trunked Ports

Private VLAN trunk ports allow you to combine traffic for private isolated VLANs over a

trunk. A port in trunk mode enabled as a promiscuous port with the switchport mode

private-vlan trunk promiscuous command can carry both multiple isolated private

VLANs and non-private VLANs. A promiscuous port in trunk mode allows you to combine

multiple isolated VLANs on a single trunk port. A port in trunk mode enabled as a

secondary port with the switchport mode private-vlan trunk secondary command can

combine traffic for multiple isolated VLANs over a trunk.

A private VLAN group for trunked ports comprises the following components:

■a single promiscuous port

■one or more isolated secondary ports: These can only communicate with the

associated promiscuous port.

■isolated VLANs: In this VLAN type, communication can only take place between each

secondary port and its associated promiscuous port. Membership rules for private

VLANs for trunked ports

The following membership rules apply when creating and operating private VLANs for

trunked ports.

A promiscuous trunk port:

■must be in trunk mode

■can be a member of both isolated VLANs and non-isolated VLANs

■has a group ID that is solely used to associate the promiscuous port with secondary

ports

A secondary trunk port:

■must be in trunk mode

■can only be a member of isolated VLANs

■cannot be a promiscuous port in another VLAN

■has a group ID that is solely used to associate the secondary port with its promiscuous

port

Unlike private VLANs for ports in access mode, private VLANs for trunked ports have no

secondary to primary VLAN mappings.

Note Private VLAN trunk ports are not supported by the current AlliedWare Plus GVRP

implementation. Private VLAN trunk ports and GVRP are mutually exclusive.

VLAN Introduction

Software Reference for GS900MX/MPX Series Switches

16.12 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Trunked Port Private VLAN Configuration Example

A basic trunked port private VLAN operation is shown in the following figure.

Figure 16-2: Trunked port private VLAN

The ports on Switch A have the following configuration:

■Port 1.0.1 is the promiscuous port, and has a group ID of 1

■Port 1.0.2 is a secondary port for isolated private VLANs 10 and 20, and has a group ID

of 1

■Port 1.0.3 is a secondary port for isolated private VLANs 10, 20 and 30, and has a group

ID of 1

The configuration procedure in Table 16-4 show the steps to configure Switch A.

private_VLANs_2_1

secondary port1.0.2

port1.0.2

port1.0.3

port1.0.4

Servers

vlan 10

vlan 20

vlan 30

promiscuous port1.0.1

Switch A

secondary port1.0.3

vlan 10, 20 vlan 10, 20, 30

port1.0.1 port1.0.1

vlan 10, 20, 30

Secondary ports cannot

directly communicate

VLAN Introduction

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 16.13

Table 16-4: Configuration procedure for Switch A

Command Description

Step 1. Create the VLANs

awplus#

configure terminal Enter Global Configuration mode.

awplus(config)#

vlan database Enter VLAN Configuration mode.

awplus(config-vlan)#

vlan 10,20,30 Create the VLANs.

Step 2. Create the private VLANs and set the type

awplus(config-vlan)#

private-vlan 10 isolated Create isolated VLAN 10.

awplus(config-vlan)#

private-vlan 20 isolated Create isolated VLAN 20.

awplus(config-vlan)#

private-vlan 30 isolated Create isolated VLAN 30.

awplus(config-vlan)#

interface port1.0.1 Enter Interface Configuration mode for

port1.0.1.

awplus(config-if)#

switchport mode trunk Set the switching characteristics of the port to

trunk.

awplus(config-if)#

switchport trunk allowed vlan add 10,20,30 Add the VLANs to be trunked over this port.

Step 3. Set port 1.0.2 to trunk mode and add the VLANs to be trunked over the port

awplus(config-if)#

exit Return to Global Configuration mode.

awplus(config)#

interface port1.0.2 Enter Interface Configuration mode for

port1.0.2.

awplus(config-if)#

switchport mode trunk Set the switching characteristics of the port to

trunk.

awplus(config-if)#

switchport trunk allowed vlan add 10,20 Add the VLANs to be trunked over this port.

VLAN Introduction

Software Reference for GS900MX/MPX Series Switches

16.14 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Step 4. Set port 1.0.3 to trunk mode and add the VLANs to be trunked over the port

awplus(config-if)#

exit Return to Global Configuration mode.

awplus(config)#

interface port1.0.3 Enter Interface Configuration mode for port

1.0.3.

awplus(config-if)#

switchport mode trunk Set the switching characteristics of the port to

trunk.

awplus(config-if)#

switchport trunk allowed vlan add 10,20,30 Add the VLANs to be trunked over this port.

Step 5. Set port 1.0.1 to be the promiscuous port

awplus(config-if)#

exit Return to Global Configuration mode.

awplus(config)#

interface port1.0.1 Enter Interface Configuration mode for port

1.0.1.

awplus(config-if)#

switchport mode private-vlan trunk

promiscuous group 1

Enable the port in trunk mode to be

promiscuous port for isolated VLANs 10, 20 and

30 with a group ID of 1.

Step 6. Set port 1.0.2 to be a secondary port

awplus(config-if)#

exit Return to Global Configuration mode.

awplus(config)#

interface port1.0.2 Enter Interface Configuration mode for

port1.0.2.

awplus(config-if)#

switchport mode private-vlan trunk

secondary group 1

Enable the port in trunk mode to be a

secondary port for isolated VLANs 10 and 20

with a group ID of 1.

Step 7. Set port 1.0.3 to be a secondary port

awplus(config-if)#

exit Return to Global Configuration mode.

Table 16-4: Configuration procedure for Switch A(cont.)

Command Description

VLAN Introduction

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 16.15

awplus(config)#

interface port1.0.3 Enter Interface Configuration mode for

port1.0.3.

awplus(config-if)#

switchport mode private-vlan trunk

secondary group 1

Enable the port in trunk mode to be a

secondary port for isolated VLANs 10, 20 and 30

with a group ID of 1.

Table 16-4: Configuration procedure for Switch A(cont.)

Command Description

VLAN Introduction

Software Reference for GS900MX/MPX Series Switches

16.16 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Protocol Based VLAN Configuration Example

A protocol based VLAN topology is shown below in Figure 16-3.

See the configuration procedure to configure Switch A in Table 16-4

Figure 16-3: Protocol based VLAN configuration

Switch A has the following configuration to enable protocol based VLAN classification:

■VLAN 100 and VLAN 101 created and applied to port1.0.2 and port1.0.3 respectively

■IPv4 and IPv6 VLAN classifier rules created and mapped to VLAN 100 and VLAN 101

■VLAN classifier group created and mapped to port1.0.1

■VLAN 100 and VLAN 101 are trunked over port1.0.2 and port1.0.3 respectively

■IPv4 packets received on port1.0.1 go to port1.0.2 VLAN 100

■IPv6 packets received on port1.0.1 go to port1.0.3 VLAN 101

protocol_VLAN_1

IPv6 packets

IPv4 packets

VOIP Server

VLAN 100VLAN101

Switch A

port1.0.1

Internet Server

port1.0.2

port1.0.3

Customer Network

IPv4 packets go to

port1.0.2 VLAN100

IPv6 packets go to

port1.0.3 VLAN101

IPv6 packets IPv4 packets

VLAN Introduction

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 16.17

The configuration procedure in Table 16-4 show the steps to configure Switch A.

Table 16-5: Configuration procedure for Switch A

Command Description

Step 1. Create the VLANs 100 and 101

awplus#

configure terminal Enter Global Configuration mode.

awplus(config)#

vlan database Enter VLAN Configuration mode.

awplus(config-vlan)#

vlan 100,101 Create the VLANs.

awplus(config-vlan)#

exit Exit VLAN Configuration mode.

Step 2. Create two protocol type based VLAN classifier rules for IPv4 and IPv6 mapped to VLAN 100 and

101

awplus(config)#

vlan classifier rule 1 proto ip encap

ethv2 vlan 100

Create a VLAN classifier rule 1 for IPv4 packets

on VLAN 100.

awplus(config)#

vlan classifier rule 2 proto ipv6 encap

ethv2 vlan 101

Create a VLAN classifier rule 2 for IPv6 packets

on VLAN 101.

Step 3. Create a group of VLAN classifier rules and map the defined VLAN classifier rules 1 and 2 to the

group

awplus(config)#

vlan classifier group 1 add rule 1 Add VLAN classifier rule 1 to VLAN classifier

group 1.

awplus(config)#

vlan classifier group 1 add rule 2 Add VLAN classifier rule 2 to VLAN classifier

group 1.

Step 4. Associate the created VLAN classifier group 1 with port1.0.1

awplus(config)#

interface port1.0.1 Enter Interface Configuration mode for

port1.0.1.

awplus(config-if)#

vlan classifier activate 1 Associate VLAN classifier group 1 with

port1.0.1.

awplus(config-if)#

exit Exit Interface Configuration mode.

Step 5. Add VLAN 100 to be trunked over port1.0.2

VLAN Introduction

Software Reference for GS900MX/MPX Series Switches

16.18 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

awplus(config)#

interface port1.0.2 Enter Interface Configuration mode for

port1.0.2.

awplus(config-if)#

switchport mode trunk Enable switchport trunking on port1.0.2.

awplus(config-if)#

switchport trunk allowed vlan add 100 Add VLAN 100 to be trunked over

port1.0.2.

awplus(config-if)#

exit Exit Interface Configuration mode.

Step 6. Add VLAN 101 to be trunked over port1.0.3

awplus(config)#

interface port1.0.3 Enter Interface Configuration mode for

port1.0.3.

awplus(config-if)#

switchport mode trunk Enable switchport trunking on port1.0.3.

awplus(config-if)#

switchport trunk allowed vlan add 101 Add VLAN 101 to be trunked over

port1.0.3.

awplus(config-if)#

exit Exit Interface Configuration mode.

Table 16-5: Configuration procedure for Switch A(cont.)

Command Description

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.1

Chapter 17: VLAN Commands

Command List .................................................................................................................................... 17.2

port-vlan-forwarding-priority....................................................................................................... 17.3

private-vlan ......................................................................................................................................... 17.6

private-vlan association.................................................................................................................. 17.7

show port-vlan-forwarding-priority ........................................................................................... 17.8

show vlan ............................................................................................................................................. 17.9

show vlan classifier group............................................................................................................17.10

show vlan classifier group interface.........................................................................................17.11

show vlan classifier interface group.........................................................................................17.12

show vlan classifier rule ................................................................................................................17.13

switchport access vlan ..................................................................................................................17.14

switchport enable vlan..................................................................................................................17.15

switchport mode access ...............................................................................................................17.16

switchport mode private-vlan....................................................................................................17.17

switchport mode private-vlan trunk promiscuous.............................................................17.18

switchport mode private-vlan trunk secondary ..................................................................17.20

switchport mode trunk .................................................................................................................17.22

switchport private-vlan host-association...............................................................................17.23

switchport private-vlan mapping .............................................................................................17.24

switchport trunk allowed vlan....................................................................................................17.25

switchport trunk native vlan.......................................................................................................17.28

switchport voice dscp....................................................................................................................17.29

switchport voice vlan.....................................................................................................................17.30

switchport voice vlan priority.....................................................................................................17.32

vlan.......................................................................................................................................................17.33

vlan classifier activate....................................................................................................................17.34

vlan classifier group .......................................................................................................................17.35

vlan classifier rule ipv4 ..................................................................................................................17.36

vlan classifier rule proto................................................................................................................17.37

vlan database....................................................................................................................................17.40

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Command List

This chapter provides an alphabetical reference of commands used to configure VLANs.

For more information see Chapter 16, VLAN Introduction.

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.3

port-vlan-forwarding-priority

Use this command to set the highest priority protocol to control transitions from blocking

to forwarding traffic. This command prioritizes switch port forwarding mode control,

when more than one of EPSR, Loop Protection, and MAC thrashing protection protocols

are used on the switch.

EPSR, Loop Protection and MAC Thrashing use the same mechanism to block or forward

traffic. This command sets the highest priority protocol to control transitions from

blocking to forwarding traffic. Setting the priority stops contention between protocols.

For example, If EPSR is set to the highest priority protocol to block traffic on vlan10 on

port1.0.2 then this stops MAC Thrashing from forwarding traffic on vlan10 on port1.0.2.

Use the no variant of this command to restore the default highest priority protocol back to

the default of EPSR.

For more information about EPSR, see the section “EPSR Introduction and

Configuration” on page 57.1.

Syntax port-vlan-forwarding-priority {epsr|loop-protection|none}

no port-vlan-forwarding-priority

Default By default, the highest priority protocol is EPSR

Mode Global Configuration

Caution loop-protection and none parameter options must not be set on an EPSR

master node. Use the epsr parameter option on an EPSR master node instead.

Setting this command incorrectly on an EPSR master node could cause

unexpected broadcast storms.

Parameter Description

epsr Sets EPSR as the highest priority protocol. Use this parameter on

an EPSR master node to avoid unexpected broadcast storms.

loop-

protection

Sets Loop Protection as the highest priority protocol.

Note that this option must not be set on an EPSR master node.

Use the epsr parameter option on an EPSR master node to avoid

unexpected broadcast storms.

none Sets the protocols to have equal priority. This was the previous

behavior before this command was added, and allows protocols

to override each other to set a port to forwarding a VLAN.

Note that this option must not be set on a EPSR master node.

Use the epsr parameter option on an EPSR master node to avoid

unexpected broadcast storms.

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.4 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Usage EPSR, Loop Protection and MAC Thrashing protection do not usually need to be

configured on a switch, because they perform similar functions—each prevents network

loops by blocking a selected port for each (loop containing) VLAN.

However, if more than one of these three features is configured on a switch, you can use

this command to prioritize either EPSR or Loop Protection when their effects on a port

would conflict and override each other. Previously, each protocol could set a port to

forwarding for a VLAN, sometimes overriding the previous setting by another protocol to

block the port. This could sometimes lead to unexpected broadcast storms.

Now, when a protocol is set to have the highest priority over a data VLAN on a port, it will

not allow other protocols to put that port-vlan into a forwarding state if the highest

priority protocol blocked it.

The priority mechanism is only used for blocking-to-forwarding transitions; protocols

remain independent on the forwarding-to-blocking transitions.

For example, with an EPSR master node in a two-node ESPR ring with the below settings:

■The EPSR master node primary port is configured to switchport interface port1.0.1

■The EPSR master node secondary port is configured to switchport interface port1.0.2

■The EPSR master node control VLAN is configured to VLAN interface vlan10

■The EPSR master node has a first data VLAN configured to VLAN interface vlan20

■The EPSR master node has a second data VLAN configured to VLAN interface vlan30.

Initially, the EPSR ring is complete, with port1.0.2 blocking data VLANs vlan20 and

vlan30 and some broadcast traffic flowing through. If the user removes vlan30 from

EPSR, a storm is created on vlan30. MAC thrashing protection detects it and blocks

vlan30.

Then after the storm has stopped, MAC thrashing protection sets it to forwarding again

and it keeps oscillating between forwarding and blocking. In the meantime, the user adds

back vlan30 to EPSR as a data VLAN and EPSR blocks it on port1.0.2.

If the priority is set to none (port-vlan-forwarding-priority none), MAC thrashing

protection notices that the storm has stopped again and decides to put vlan30 on

port1.0.2 into forwarding state. This overrides what EPSR requires for this port-VLAN and

creates a storm. This matches the old behavior before this feature was implemented.

If the priority is set to EPSR or default (port-vlan-forwarding-priority epsr), MAC

thrashing protection notices that the storm has stopped again and attempts to put

vlan30 on port1.0.2 into forwarding state. The higher priority protocol (EPSR) is blocking

the VLAN on this port, so it stays blocking and no storm occurs.

Example To prioritize EPSR over Loop Protection or MAC Thrashing protection settings, so that Loop

Protection or MAC Thrashing protection cannot set a port to the forwarding state a VLAN

if EPSR has set it to the blocking state, use the commands:

awplus# configure terminal

awplus(config)# port-vlan-forwarding-priority epsr

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.5

To prioritize Loop Protection over EPSR or MAC Thrashing protection settings, so that EPSR

or MAC Thrashing protection cannot set a port to the forwarding state a VLAN if Loop

Protection has set it to the blocking state, use the commands:

To set EPSR, Loop Protection, and MAC Thrashing protection protocols to have equal

priority for port forwarding and blocking, which allows the protocols to override each

other to set a port to the forwarding or blocking states, use the commands:

To restore the default highest priority protocol back to the default of EPSR, use the

commands:

Related Commands show port-vlan-forwarding-priority

awplus# configure terminal

awplus(config)# port-vlan-forwarding-priority loop-

protection

awplus# configure terminal

awplus(config)# port-vlan-forwarding-priority none

awplus# configure terminal

awplus(config)# no port-vlan-forwarding-priority

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.6 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

private-vlan

Use this command to a create a private VLAN. Private VLANs can be either primary or

secondary. Secondary VLANs can be ether community or isolated.

Use the no variant of this command to remove the specified private VLAN.

For more information, see the section “Private VLANs” on page 16.5.

Syntax private-vlan <vlan-id> {community|isolated|primary}

no private-vlan <vlan-id> {community|isolated|primary}

Mode VLAN Configuration

Examples

Parameter Description

<vlan-id>VLAN ID in the range <2-4094> for the VLAN which is to be made a

private VLAN.

community Community VLAN.

isolated Isolated VLAN.

primary Primary VLAN.

awplus# configure terminal

awplus(config)# vlan database

awplus(config-vlan)# vlan 2 name vlan2 state enable

awplus(config-vlan)# vlan 3 name vlan3 state enable

awplus(config-vlan)# vlan 4 name vlan4 state enable

awplus(config-vlan)# private-vlan 2 primary

awplus(config-vlan)# private-vlan 3 isolated

awplus(config-vlan)# private-vlan 4 community

awplus# configure terminal

awplus(config)# vlan database

awplus(config-vlan)# no private-vlan 2 primary

awplus(config-vlan)# no private-vlan 3 isolated

awplus(config-vlan)# no private-vlan 4 community

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.7

private-vlan association

Use this command to associate a secondary VLAN to a primary VLAN. Only one isolated

VLAN can be associated to a primary VLAN. Multiple community VLANs can be associated

to a primary VLAN.

Use the no variant of this command to remove association of all the secondary VLANs to a

primary VLAN.

For more information, see the section “Private VLANs” on page 16.5.

Syntax private-vlan <primary-vlan-id> association {add <secondary-vlan-id>|

remove <secondary-vlan-id>}

no private-vlan <primary-vlan-id> association

Mode VLAN Configuration

Examples The following commands associate primary VLAN 2 with secondary VLAN 3:

The following commands remove the association of primary VLAN 2 with secondary

VLAN 3:

The following commands remove all secondary VLAN associations of primary VLAN 2:

Parameter Description

<primary-vlan-id>VLAN ID of the primary VLAN.

<secondary-vlan-id>VLAN ID of the secondary VLAN

(either isolated or community).

awplus# configure terminal

awplus(config)# vlan database

awplus(config-vlan)# private-vlan 2 association add 3

awplus# configure terminal

awplus(config)# vlan database

awplus(config-vlan)# private-vlan 2 association remove 3

awplus# configure terminal

awplus(config)# vlan database

awplus(config-vlan)# no private-vlan 2 association

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.8 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show port-vlan-forwarding-priority

Use this command to display the highest priority protocol that controls port-vlan

forwarding or blocking traffic. This command displays whether EPSR or Loop Protection is

set as the highest priority for determining whether a port forwards a VLAN, as set by the

port-vlan-forwarding-priority command.

For more information about EPSR, see the section “EPSR Introduction and

Configuration” on page 57.1.

Syntax show port-vlan-forwarding-priority

Mode Privileged Exec

Example To display the highest priority protocol, use the command:

Output Figure 17-1: Example output from the show port-vlan-forwarding-priority command

Related Commands port-vlan-forwarding-priority

awplus# show port-vlan-forwarding-priority

Port-vlan Forwarding Priority: EPSR

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.9

show vlan

Use this command to display information about a particular VLAN by specifying the VLAN

ID. It displays information for all the VLANs configured.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show vlan {all|brief|dynamic|static|auto|static-ports<1-4094>}

Mode User Exec and Privileged Exec

Example To display information about VLAN 2, use the command:

Output Figure 17-2: Example output from the show vlan command

Related Commands vlan

Parameter Description

<1-4094> Display information about the VLAN specified by the VLAN ID.

all Display information about all VLANs on the device.

brief Display information about all VLANs on the device.

dynamic Display information about all VLANs learned dynamically.

static Display information about all statically configured VLANs.

auto Display information about all auto-configured VLANs.

static-

ports

Display static egress/forbidden ports.

awplus# show vlan 2

VLAN ID Name Type State Member ports

(u)-Untagged, (t)-Tagged

======= ================ ======= ======= ====================================

2 VLAN0002 STATIC ACTIVE port1.0.3(u) port1.0.4(u) port1.0.5(u)

port1.0.6(u)

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.10 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show vlan classifier group

Use this command to display information about all configured VLAN classifier groups or a

specific group.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show vlan classifier group [<1-16>]

Mode User Exec and Privileged Exec

Usage If a group ID is not specified, all configured VLAN classifier groups are shown. If a group ID

is specified, a specific configured VLAN classifier group is shown.

Example To display information about VLAN classifier group 1, enter the command:

Related Commands vlan classifier group

Parameter Description

<1-16> VLAN classifier group identifier

awplus# show vlan classifier group 1

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.11

show vlan classifier group interface

Use this command to display information about a single switch port interface for all

configured VLAN classifier groups.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show vlan classifier group interface <switch-port>

Mode User Exec and Privileged Exec

Usage All configured VLAN classifier groups are shown for a single interface.

Example To display VLAN classifier group information for switch port interface port1.0.2, enter

the command:

Output Figure 17-3: Example output from the show vlan classifier group interface port1.0.1

command:

Related Commands vlan classifier group

show vlan classifier interface group

Parameter Description

<switch-port> Specify the switch port interface classifier group identifier

awplus# show vlan classifier group interface port1.0.2

vlan classifier group 1 interface port1.0.1

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.12 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show vlan classifier interface group

Use this command to display information about all interfaces configured for a VLAN group

or all the groups.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show vlan classifier interface group [<1-16>]

Mode User Exec and Privileged Exec

Usage If a group ID is not specified, all interfaces configured for all VLAN classifier groups are

shown. If a group ID is specified, the interfaces configured for this VLAN classifier group

are shown.

Example To display information about all interfaces configured for all VLAN groups, enter the

command:

To display information about all interfaces configured for VLAN group 1, enter the

command:

Output Figure 17-4: Example output from the show vlan classifier interface group command

Output Figure 17-5: Example output from the show vlan classifier interface group 1

command

Related Commands vlan classifier group

show vlan classifier group interface

Parameter Description

<1-16> VLAN classifier interface group identifier

awplus# show vlan classifier interface group

awplus# show vlan classifier interface group 1

vlan classifier group 1 interface port1.0.1

vlan classifier group 1 interface port1.0.2

vlan classifier group 2 interface port1.0.3

vlan classifier group 2 interface port1.0.4

vlan classifier group 1 interface port1.0.1

vlan classifier group 1 interface port1.0.2

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.13

show vlan classifier rule

Use this command to display information about all configured VLAN classifier rules or a

specific rule.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show vlan classifier rule [<1-256>]

Mode User Exec and Privileged Exec

Usage If a rule ID is not specified, all configured VLAN classifier rules are shown. If a rule ID is

specified, a specific configured VLAN classifier rule is shown.

Example To display information about VLAN classifier rule 1, enter the command:

Output Figure 17-6: Example output from the show vlan classifier rule 1 command

Related Commands vlan classifier activate

vlan classifier rule ipv4

vlan classifier rule proto

Parameter Description

<1-256> VLAN classifier rule identifier

awplus# show vlan classifier rule 1

vlan classifier group 1 add rule 1

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.14 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

switchport access vlan

Use this command to change the port-based VLAN of the current port.

Use the no variant of this command to change the port-based VLAN of this port to the

default VLAN, vlan1.

Syntax switchport access vlan <vlan-id>

no switchport access vlan

Default Reset the default VLAN 1 to specified switchports using the negated form of this

command.

Mode Interface Configuration

Usage Any untagged frame received on this port will be associated with the specified VLAN.

Examples To change the port-based VLAN to VLAN 3 for port1.0.2, use the commands:

To reset the port-based VLAN to the default VLAN 1 for port1.0.2, use the commands:

Related Commands show vlan

Parameter Description

<vlan-id><1-4094> The port-based VLAN ID for the port.

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# switchport access vlan 3

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# no switchport access vlan

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.15

switchport enable vlan

This command enables the VLAN on the port manually once disabled by certain actions,

such as QSP (QoS Storm Protection) or EPSR (Ethernet Protection Switching Ring). Note

that if the VID is not given, all disabled VLANs are re-enabled.

Syntax switchport enable vlan [<1-4094>]

Mode Interface Configuration

Example To re -enable the port1.0.1 from VLAN 1:

Related Commands show mls qos interface storm-status

storm-window

Parameter Description

vlan Re-enables the VLAN on the port.

<1-4094> VLAN ID.

awplus# configure terminal

awplus(config)# interface port1.0.1

awplus(config-if)# switchport enable vlan 1

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.16 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

switchport mode access

Use this command to set the switching characteristics of the port to access mode.

Received frames are classified based on the VLAN characteristics, then accepted or

discarded based on the specified filtering criteria.

Syntax switchport mode access [ingress-filter {enable|disable}]

Default By default, ports are in access mode with ingress filtering on.

Usage Use access mode to send untagged frames only.

Mode Interface Configuration

Example

Parameter Description

ingress-filter Set the ingress filtering for the received frames.

enable Turn on ingress filtering for received frames. This is the default.

disable Turn off ingress filtering to accept frames that do not meet the

classification criteria.

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# switchport mode access ingress-filter

enable

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.17

switchport mode private-vlan

Use this command to make a Layer 2 port a private VLAN host port or a promiscuous port.

Use the no variant of this command to remove the configuration.

Syntax switchport mode private-vlan {host|promiscuous}

no switchport mode private-vlan {host|promiscuous}

Mode Interface Configuration

Examples

Related Commands switchport private-vlan mapping

Parameter Description

host This port type can communicate with all other host ports assigned to

the same community VLAN, but it cannot communicate with the

ports in the same isolated VLAN. All communications outside of this

VLAN must pass through a promiscuous port in the associated

primary VLAN.

promiscuous A promiscuous port can communicate with all interfaces, including

the community and isolated ports within a private VLAN.

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# switchport mode private-vlan host

awplus(config)# interface port1.0.3

awplus(config-if)# switchport mode private-vlan promiscuous

awplus(config)# interface port1.0.4

awplus(config-if)# no switchport mode private-vlan promiscuous

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.18 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

switchport mode private-vlan trunk promiscuous

Use this command to enable a port in trunk mode to be promiscuous port for isolated

VLANs.

Use the no variant of this command to remove a port in trunk mode as a promiscuous port

for isolated VLANs. You must first remove the secondary port, or ports, in trunk mode

associated with the promiscuous port with the no switchport mode private-vlan trunk

secondary command.

Syntax switchport mode private-vlan trunk promiscuous group <group-id>

no switchport mode private-vlan trunk promiscuous

Default By default, a port in trunk mode is disabled as a promiscuous port.

Mode Interface Configuration

Usage A port must be put in trunk mode with switchport mode trunk command before it can

be enabled as a promiscuous port.

To add VLANs to be trunked over the promiscuous port, use the switchport trunk

allowed vlan command. These VLANs can be isolated VLANs, or non-private VLANs.

To configure the native VLAN for the promiscuous port, use the switchport trunk native

vlan command. The native VLAN can be an isolated VLAN, or a non-private VLAN.

When you enable a promiscuous port, all of the secondary port VLANs associated with the

promiscuous port via the group ID number must be added to the promiscuous port. In

other words, the set of VLANs on the promiscuous port must be a superset of all the VLANs

on the secondary ports within the group.

For further information, see “Private VLANs for Trunked Ports” on page 16.11.

Note Private VLAN trunk ports are not supported by the current AlliedWare Plus GVRP

implementation. Private VLAN trunk ports and GVRP are mutually exclusive.

Parameter Description

<group-id>The group ID is a numeric value in the range 1 to 32 that is

used to associate the promiscuous port with secondary ports.

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.19

Examples To create the isolated VLANs 2, 3 and 4 and then enable port1.0.2 in trunk mode as a

promiscuous port for these VLANs with the group ID of 3, use the following commands:

To remove port1.0.2 in trunk mode as a promiscuous port for a private VLAN, use the

commands:

Note that you must remove the secondary port or ports enabled as trunk ports that are

associated with the promiscuous port before removing the promiscuous port.

Related Commands switchport mode private-vlan trunk secondary

switchport mode trunk

switchport trunk allowed vlan

switchport trunk native vlan

awplus# configure terminal

awplus(config)# vlan database

awplus(config-vlan)# vlan 2-4

awplus(config-vlan)# private-vlan 2 isolated

awplus(config-vlan)# private-vlan 3 isolated

awplus(config-vlan)# private-vlan 4 isolated

awplus(config-vlan)# exit

awplus(config)# interface port1.0.2

awplus(config-if)# switchport mode trunk

awplus(config-if)# switchport trunk allowed vlan add 2-4

awplus(config-if)# switchport mode private-vlan trunk

promiscuous group 3

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# no switchport mode private-vlan trunk

promiscuous

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.20 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

switchport mode private-vlan trunk secondary

Use this command to enable a port in trunk mode to be a secondary port for isolated

VLANs.

Use the no variant of this command to remove a port in trunk mode as a secondary port

for isolated VLANs.

Syntax switchport mode private-vlan trunk secondary group <group-id>

no switchport mode private-vlan trunk secondary

Default By default, a port in trunk mode is disabled as a secondary port.

When a port in trunk mode is enabled to be a secondary port for isolated VLANs, by

default it will have a native VLAN of none (no native VLAN specified).

Mode Interface Configuration

Usage A port must be put in trunk mode with switchport mode trunk command before the port

is enabled as a secondary port in trunk mode.

To add VLANs to be trunked over the secondary port use the switchport trunk allowed

vlan command. These must be isolated VLANs and must exist on the associated

promiscuous port.

To configure the native VLAN for the secondary port, use the switchport trunk native

vlan command. The native VLAN must be an isolated VLAN and must exist on the

associated promiscuous port.

For further information, see “Private VLANs for Trunked Ports” on page 16.11.

Note Private VLAN trunk ports are not supported by the current AlliedWare Plus

GVRP implementation. Private VLAN trunk ports and GVRP are mutually

exclusive.

Parameter Description

<group-id>The group ID is a numeric value in the range 1 to 32 that is

used to associate a secondary port with its promiscuous port.

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.21

Examples To create isolated private VLAN 2 and then enable port1.0.3 in trunk mode as a

secondary port for the this VLAN with the group ID of 3, use the following commands:

To remove port1.0.3 in trunk mode as a secondary port, use the commands:

Related Commands switchport mode private-vlan trunk promiscuous

switchport mode trunk

switchport trunk allowed vlan

switchport trunk native vlan

awplus# configure terminal

awplus(config)# vlan database

awplus(config-vlan)# vlan 2

awplus(config-vlan)# private-vlan 2 isolated

awplus(config-vlan)# exit

awplus(config)# interface port1.0.3

awplus(config-if)# switchport mode trunk

awplus(config-if)# switchport trunk allowed vlan add 2

awplus(config-if)# switchport mode private-vlan trunk

secondary group 3

awplus# configure terminal

awplus(config)# interface port1.0.3

awplus(config-if)# no switchport mode private-vlan trunk

secondary

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.22 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

switchport mode trunk

Use this command to set the switching characteristics of the port to trunk. Received

frames are classified based on the VLAN characteristics, then accepted or discarded based

on the specified filtering criteria.

Syntax switchport mode trunk [ingress-filter {enable|disable}]

Default By default, ports are in access mode, are untagged members of the default VLAN (vlan1),

and have ingress filtering on.

Mode Interface Configuration

Usage A port in trunk mode can be a tagged member of multiple VLANs, and an untagged

member of one native VLAN.

To configure which VLANs this port will trunk for, use the switchport trunk allowed vlan

command.

Example

Parameter Description

ingress-filter Set the ingress filtering for the frames received.

enable Turn on ingress filtering for received frames. This is the default.

disable Turn off ingress filtering to accept frames that do not meet the

classification criteria.

awplus# configure terminal

awplus(config)# interface port1.0.3

awplus(config-if)# switchport mode trunk ingress-filter enable

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.23

switchport private-vlan host-association

Use this command to associate a primary VLAN and a secondary VLAN to a host port. Only

one primary and secondary VLAN can be associated to a host port.

Use the no variant of this command to remove the association.

Syntax switchport private-vlan host-association <primary-vlan-id> add

<secondary-vlan-id>

no switchport private-vlan host-association

Mode Interface Configuration

Examples

Parameter Description

<primary-vlan-id>VLAN ID of the primary VLAN.

<secondary-vlan-id>VLAN ID of the secondary VLAN (either isolated or com-

munity).

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# switchport private-vlan host-association 2

add 3

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# no switchport private-vlan host-association

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.24 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

switchport private-vlan mapping

Use this command to associate a primary VLAN and a set of secondary VLANs to a

promiscuous port.

Use the no variant of this to remove all the association of secondary VLANs to primary

VLANs for a promiscuous port.

Syntax switchport private-vlan mapping <primary-vlan-id> add

<secondary-vid-list>

switchport private-vlan mapping <primary-vlan-id> remove

<secondary-vid-list>

no switchport private-vlan mapping

Mode Interface Configuration

Usage This command can be applied to a switch port or a static channel group, but not a

dynamic (LACP) channel group. LACP channel groups (dynamic/LACP aggregators) cannot

be promiscuous ports in private VLANs.

Examples

Related Commands switchport mode private-vlan

Parameter Description

<primary-vlan-id>VLAN ID of the primary VLAN.

<secondary-vid-list>VLAN ID of the secondary VLAN (either isolated or

community), or a range of VLANs, or a comma-separated

list of VLANs and ranges.

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# switchport private-vlan mapping 2 add 3-4

awplus(config-if)# switchport private-vlan mapping 2 remove 3-4

awplus(config-if)# no switchport private-vlan mapping

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.25

switchport trunk allowed vlan

Use this command to add VLANs to be trunked over this switch port. Traffic for these

VLANs can be sent and received on the port.

Use the no variant of this command to reset switching characteristics of a specified

interface to negate a trunked configuration specified with switchport trunk allowed vlan

command.

Syntax switchport trunk allowed vlan all

switchport trunk allowed vlan none

switchport trunk allowed vlan add <vid-list>

switchport trunk allowed vlan remove <vid-list>

switchport trunk allowed vlan except <vid-list>

no switchport trunk

Default By default, ports are untagged members of the default VLAN (vlan1).

Mode Interface Configuration

Usage The all parameter sets the port to be a tagged member of all the VLANs configured on the

device. The none parameter removes all VLANs from the port’s tagged member set. The

add and remove parameters will add and remove VLANs to and from the port’s member

set. See the note below about restrictions when using the add, remove, except, and all

parameters.

Parameter Description

all Allow all VLANs to transmit and receive through the port.

none Allow no VLANs to transmit and receive through the port.

add Add a VLAN to transmit and receive through the port. Only use this

parameter if a list of VLANs are already configured on a port.

remove Remove a VLAN from transmit and receive through the port. Only use

this parameter if a list of VLANs are already configured on a port.

except All VLANs, except the VLAN for which the VID is specified, are part of

its port member set. Only use this parameter to remove VLANs after

either this parameter or the all parameter have added VLANs to a

port.

<vid-list><2-4094> The ID of the VLAN or VLANs that will be added to, or

removed from, the port. A single VLAN, VLAN range, or comma-

separated VLAN list can be set.

For a VLAN range, specify two VLAN numbers: lowest, then highest

number in the range, separated by a hyphen.

For a VLAN list, specify the VLAN numbers separated by commas.

Do not enter spaces between hyphens or commas when setting

parameters for VLAN ranges or lists.

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.26 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Note: Only use the add or the remove parameters with this command if a list of VLANs are

configured on a port. Only use the except parameter to remove VLANs after either the

except or the all parameters have first been used to add a list of VLANs to a port.

Remove VLAN 3 by re-entering the except parameter with the list of VLANs to remove,

instead of using the remove parameter, as shown in the command example below:

Then the configuration is changed after entering the above commands to remove VLAN 3:

To add a VLAN, where the configuration for port1.0.6 shows the below output:

Add VLAN 4 by re-entering the except parameter with a list of VLANs to exclude, instead

of using the add parameter to include VLAN 4, as shown in the command example below:

The configuration is changed after entering the above commands to add VLAN 4:

awplus# configure terminal

awplus(config)# interface port1.0.6

awplus(config-if)# switchport trunk allowed vlan except 3,4

awplus#show running-config

interface port1.0.6

switchport

switchport mode trunk

switchport trunk allowed vlan except 3-4

awplus#show running-config

interface port1.0.6

switchport

switchport mode trunk

switchport trunk allowed vlan except 3-5

awplus# configure terminal

awplus(config)# interface port1.0.5

awplus(config-if)# switchport trunk allowed vlan except 3,5

awplus#show running-config

interface port1.0.5

switchport

switchport mode trunk

switchport trunk allowed vlan except 3,5

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.27

Examples The following shows adding a single VLAN to the port’s member set.

The following shows adding a range of VLANs to the port’s member set.

The following shows adding a list of VLANs to the port’s member set.

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# switchport trunk allowed vlan add 2

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# switchport trunk allowed vlan add 2-4

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# switchport trunk allowed vlan add 2,3,4

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.28 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

switchport trunk native vlan

Use this command to configure the native VLAN for this port. The native VLAN is used for

classifying the incoming untagged packets. Use the none parameter with this command

to remove the native VLAN from the port and set the acceptable frame types to vlan-

tagged only.

Use the no variant of this command to revert the native VLAN to the default VLAN ID 1.

Command negation removes tagged VLANs, and sets the native VLAN to the default

VLAN.

Syntax switchport trunk native vlan {<vid>|none}

no switchport trunk native vlan

Default VLAN 1 (the default VLAN), which is reverted to using the no form of this command.

Mode Interface Configuration

Examples The following commands show configuration of VLAN 2 as the native VLAN for interface

port1.0.2:

The following commands show the removal of the native VLAN for interface port1.0.2:

The following commands revert the native VLAN to the default VLAN 1 for interface

port1.0.2:

Parameter Description

The ID of the VLAN that will be used to classify the incoming

untagged packets. The VLAN ID must be a part of the VLAN member

set of the port.

none No native VLAN specified. This option removes the native VLAN from

the port and sets the acceptable frame types to vlan-tagged only.

Note: Use the no variant of this command to revert to the default

VLAN 1 as the native VLAN for the specified interface switchport - not

none.

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# switchport trunk native vlan 2

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# switchport trunk native vlan none

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# no switchport trunk native vlan

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.29

switchport voice dscp

Use this command to configure the Layer 3 DSCP value advertised when the transmission

of LLDP-MED Network Policy TLVs for voice devices is enabled. When LLDP-MED capable IP

phones receive this network policy information, they transmit voice data with the

specified DSCP value.

Use the no variant of this command to reset the DSCP value to the default, 0.

Syntax switchport voice dscp <0-63>

no switchport voice dscp

Default A DSCP value of 0 will be advertised.

Mode Interface Configuration

Usage LLDP-MED advertisements including Network Policy TLVs are transmitted via a port if:

■LLDP is enabled (lldp run command on page 70.16)

■Voice VLAN is configured for the port (switchport voice vlan command on page

17.30)

■The port is configured to transmit LLDP advertisements—enabled by default (lldp

transmit receive command on page 70.20)

■The port is configured to transmit Network Policy TLVs—enabled by default (lldp

med-tlv-select command on page 70.9)

■There is an LLDP-MED device connected to the port

Example

Related Commands lldp med-tlv-select

show lldp

switchport voice vlan

Parameter Description

dscp Specify a DSCP value for voice data.

<0-63> DSCP value.

awplus# configure terminal

awplus(config)# interface port1.0.5

awplus(config-if)# switchport voice dscp 27

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.30 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

switchport voice vlan

Use this command to configure the Voice VLAN tagging advertised when the transmission

of LLDP-MED Network Policy TLVs for voice endpoint devices is enabled. When LLDP-MED

capable IP phones receive this network policy information, they transmit voice data with

the specified tagging. This command also sets the ports to be spanning tree edge ports,

that is, it enables spanning tree portfast on the ports.

Use the no variant of this command to remove LLDP-MED network policy configuration

for voice devices connected to these ports. This does not change the spanning tree edge

port status.

Syntax switchport voice vlan [<vid>|dot1p|dynamic|untagged]

no switchport voice vlan

Default By default, no Voice VLAN is configured, and therefore no network policy is advertised for

voice devices.

Mode Interface Configuration

Usage LLDP-MED advertisements including Network Policy TLVs are transmitted via a port if:

■LLDP is enabled (lldp run command on page 70.16)

■Voice VLAN is configured for the port using this command (switchport voice vlan)

■The port is configured to transmit LLDP advertisements—enabled by default (lldp

transmit receive command on page 70.20)

■The port is configured to transmit Network Policy TLVs—enabled by default (lldp

med-tlv-select command on page 70.9)

■There is an LLDP-MED device connected to the port.

To set the priority value to be advertised for tagged frames, use the switchport voice vlan

priority command on page 17.32.

If the Voice VLAN details are to be assigned by RADIUS, then the RADIUS server must be

configured to send the attribute “Egress-VLANID (56)” or “Egress-VLAN-Name (58)” in the

RADIUS Accept message when authenticating a phone attached to this port.

For more information about configuring authentication for Voice VLAN, “Configuring

LLDP” on page 69.11.

If the ports have been set to be edge ports by the switchport voice vlan command, the

no variant of this command will leave them unchanged as edge ports. To set them back to

Parameter Description

<vid> VLAN identifier, in the range 1 to 4094.

dot1p The IP phone should send User Priority tagged packets, that is, packets in

which the tag contains a User Priority value, and a VID of 0. (The User

Priority tag is also known as the 802.1p priority tag, or the Class of Service

(CoS) tag.)

dynamic The VLAN ID with which the IP phone should send tagged packets will be

assigned by RADIUS authentication.

untagged The IP phone should send untagged packets.

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.31

their default non-edge port configuration, use the spanning-tree edgeport (RSTP and

MSTP) command on page 19.39.

Examples To tell IP phones connected to port1.0.5 to send voice data tagged for VLAN 10, use

the commands:

To tell IP phones connected to ports 1.0.2-1.0.6 to send priority tagged packets (802.1p

priority tagged with VID 0, so that they will be assigned to the port VLAN) use the

following commands. The priority value is 5 by default, but can be configured with the

switchport voice vlan priority command.

To dynamically configure the VLAN ID advertised to IP phones connected to port1.0.1

based on the VLAN assigned by RADIUS authentication (with RADIUS attribute “Egress-

VLANID” or “Egress-VLAN-Name” in the RADIUS accept packet), use the commands:

To remove the Voice VLAN, and therefore disable the transmission of LLDP-MED network

policy information for voice devices on port1.0.6, use the following commands:

Related Commands lldp med-tlv-select

spanning-tree edgeport (RSTP and MSTP)

switchport voice dscp

switchport voice vlan priority

show lldp

awplus# configure terminal

awplus(config)# interface port1.0.5

awplus(config-if)# switchport voice vlan 10

awplus# configure terminal

awplus(config)# interface port1.0.2-port1.0.6

awplus(config-if)# switchport voice vlan dot1p

awplus# configure terminal

awplus(config)# interface port1.0.1

awplus(config-if)# switchport voice vlan dynamic

awplus# configure terminal

awplus(config)# interface port1.0.6

awplus(config-if)# no switchport voice vlan

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.32 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

switchport voice vlan priority

Use this command to configure the Layer 2 user priority advertised when the transmission

of LLDP-MED Network Policy TLVs for voice devices is enabled. This is the priority in the

User Priority field of the IEEE 802.1Q VLAN tag, also known as the Class of Service (CoS), or

802.1p priority. When LLDP-MED capable IP phones receive this network policy

information, they transmit voice data with the specified priority.

Syntax switchport voice vlan priority <0-7>

no switchport voice vlan priority

Default By default, the Voice VLAN user priority value is 5.

Mode Interface Configuration

Usage LLDP-MED advertisements including Network Policy TLVs are transmitted via a port if:

■LLDP is enabled (lldp run command on page 70.16)

■Voice VLAN is configured for the port (switchport voice vlan command on page

17.30)

■The port is configured to transmit LLDP advertisements—enabled by default (lldp

transmit receive command on page 70.20)

■The port is configured to transmit Network Policy TLVs—enabled by default (lldp

med-tlv-select command on page 70.9)

■There is an LLDP-MED device connected to the port.

To set the Voice VLAN tagging to be advertised, use the switchport voice vlan command

on page 17.30.

Example To remove the Voice VLAN, and therefore disable the transmission of LLDP-MED network

policy information for voice devices on port1.0.6, use the following commands:

Related Commands lldp med-tlv-select

show lldp

switchport voice vlan

Parameter Description

priority Specify a user priority value for voice data.

<0-7>Priority value.

awplus# configure terminal

awplus(config)# interface port1.0.6

awplus(config-if)# no switchport voice vlan

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.33

vlan

This command creates VLANs, assigns names to them, and enables or disables them.

Specifying the disable state causes all forwarding over the specified VLAN ID to cease.

Specifying the enable state allows forwarding of frames on the specified VLAN.

The no variant of this command destroys the specified VLANs.

Syntax vlan <vid> [name <vlan-name>] [state {enable|disable}]

vlan <vid-range> [state {enable|disable}]

vlan {<vid>|<vlan-name>} [mtu <mtu-value>]

no vlan {<vid>|<vid-range>} [mtu]

Default By default, VLANs are enabled when they are created.

Mode VLAN Configuration

Examples

Related Commands mtu

vlan database

show vlan

Parameter Description

<vid>The VID of the VLAN to enable or disable in the range <1-4094>.

<vlan-name>The ASCII name of the VLAN. Maximum length: 32 characters.

<vid-range>Specifies a range of VLAN identifiers.

<mtu-value>Specifies the Maximum Transmission Unit (MTU) size in bytes, in the

range 68 to1500 bytes, for the VLAN.

enable Sets VLAN into an enable state.

disable Sets VLAN into a disable state.

awplus# configure terminal

awplus(config)# vlan database

awplus(config-vlan)# vlan 45 name accounts state enable

awplus# configure terminal

awplus(config)# vlan database

awplus(config-vlan)# no vlan 45

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.34 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

vlan classifier activate

Use this command in Interface Configuration mode to associate a VLAN classifier group

with the switch port.

Use the no variant of this command to remove the VLAN classifier group from the switch

port.

Syntax vlan classifier activate <vlan-class-group-id>

no vlan classifier activate <vlan-class-group-id>

Mode Interface Configuration mode for a switch port.

Usage See the Protocol Based VLAN Configuration Example section in Chapter 16, VLAN

Introduction for a configuration example and network topology using this command.

Example To associate VLAN classifier group 3 with switch port1.0.3, enter the following

commands:

To remove VLAN classifier group 3 from switch port1.0.3, enter the following

commands:

Related Commands show vlan classifier rule

vlan classifier group

vlan classifier rule ipv4

vlan classifier rule proto

Parameter Description

<vlan-class-group-id>Specify a VLAN classifier group identifier in the range

<1-16>.

awplus# configure terminal

awplus(config)# interface port1.0.3

awplus(config-if)# vlan classifier activate 3

awplus# configure terminal

awplus(config)# interface port1.0.3

awplus(config-if)# no vlan classifier activate 3

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.35

vlan classifier group

Use this command to create a group of VLAN classifier rules. The rules must already have

been created.

Use the no variant of this command to delete a group of VLAN classifier rules.

Syntax vlan classifier group <1-16> {add|delete} rule <vlan-class-rule-id>

no vlan classifier group <1-16>

Mode Global Configuration

Example

Related Commands show vlan classifier rule

vlan classifier activate

vlan classifier rule ipv4

vlan classifier rule proto

Parameter Description

<1-16> VLAN classifier group identifier

add Add the rule to the group.

delete Delete the rule from the group.

<vlan-class-rule-id> The VLAN classifier rule identifier.

awplus# configure terminal

awplus(config)# vlan classifier group 3 add rule 5

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.36 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

vlan classifier rule ipv4

Use this command to create an IPv4 subnet-based VLAN classifier rule and map it to a

specific VLAN. Use the no variant of this command to delete the VLAN classifier rule.

Syntax vlan classifier rule <1-256> ipv4 <ip-addr/prefix-length> vlan

<1-4094>

no vlan classifier rule <1-256>

Mode Global Configuration

Usage If the source IP address matches the IP subnet specified in the VLAN classifier rule, the

received packets are mapped to the specified VLAN.

Example

Related Commands show vlan classifier rule

vlan classifier activate

vlan classifier rule proto

Parameter Description

<1-256>Specify the VLAN Classifier Rule identifier.

<ip-addr/prefix-length> Specify the IP address and prefix length.

<1-4094>Specify a VLAN ID to which an untagged packet is

mapped in the range <1-4094>.

awplus# configure terminal

awplus(config)# vlan classifier rule 3 ipv4 3.3.3.3/8 vlan 5

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.37

vlan classifier rule proto

Use this command to create a protocol type-based VLAN classifier rule, and map it to a

specific VLAN. See the published IANA EtherType IEEE 802 numbers here:

www.iana.org/assignments/ieee-802-numbers/ieee-802-numbers.txt.

Instead of a protocol name the decimal value of the protocol's EtherType can be entered.

The EtherType field is a two-octet field in an Ethernet frame. It is used to show which

protocol is encapsulated in the payload of the Ethernet frame. Note that EtherTypes in the

IANA 802 numbers are given as hexadecimal values.

The no variant of this command removes a previously set rule.

Syntax vlan classifier rule <1-256> proto <protocol> encap {ethv2|nosnapllc|

snapllc} vlan <1-4094>

no vlan classifier rule <1-256>

Parameter Description

<1-256> VLAN Classifier identifier

proto Protocol type

<protocol> Specify a protocol either by its decimal number (0-65535) or by one

of the following protocol names:

[arp|2054] Address Resolution

protocol

[atalkaarp|33011] Appletalk AARP protocol

[atalkddp|32923] Appletalk DDP protocol

[atmmulti|34892] MultiProtocol Over ATM

protocol

[atmtransport|34948] Frame-based ATM

Transport protocol

[dec|24576] DEC Assigned protocol

[deccustom|24582] DEC Customer use

protocol

[decdiagnostics|24581] DEC Systems Comms

Arch protocol

[decdnadumpload|24577] DEC DNA Dump/Load

protocol

[decdnaremoteconsole|24578] DEC DNA Remote

Console protocol

[decdnarouting|24579] DEC DNA Routing

protocol

[declat|24580] DEC LAT protocol

[decsyscomm|24583] DEC Systems Comms

Arch protocol

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.38 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Mode Global Configuration

Usage If the protocol type matches the protocol specified in the VLAN classifier rule, the received

packets are mapped to the specified VLAN. Ethernet Frame Numbers may be entered in

place of the protocol names listed. For a full list please refer to the IANA list online:

www.iana.org/assignments/ieee-802-numbers/ieee-802-numbers.txt

[g8bpqx25|2303] G8BPQ AX.25 protocol

[ieeeaddrtrans|2561] Xerox IEEE802.3 PUP

Address

[ieeepup|2560] Xerox IEEE802.3 PUP

protocol

[ip|2048] IP protocol

[ipv6|34525] IPv6 protocol

[ipx|33079] IPX protocol

[netbeui|61680] IBM NETBIOS/NETBEUI

protocol

[netbeui|61681] IBM NETBIOS/NETBEUI

protocol

[pppdiscovery|34915] PPPoE discovery protocol

[pppsession|34916] PPPoE session protocol

[rarp|32821] Reverse Address

Resolution protocol

[x25|2056] CCITT.25 protocol

[xeroxaddrtrans|513] Xerox PUP Address

Translation protocol

[xeroxpup|512] Xerox PUP protocol

ethv2 Ethernet Version 2 encapsulation

nosnapllc LLC without SNAP encapsulation

snapllc LLC SNAP encapsulation

<1-4094> Specify a VLAN ID to which an untagged packet is mapped in the

range <1-4094>

Parameter (cont.) Description (cont.)

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 17.39

Examples

Validation Output

Related Commands show vlan classifier rule

vlan classifier activate

vlan classifier group

awplus# configure terminal

awplus(config)# vlan classifier rule 1 proto x25 encap ethv2

vlan 2

awplus(config)# vlan classifier rule 2 proto 512 encap ethv2

vlan 2

awplus(config)# vlan classifier rule 3 proto 2056 encap ethv2

vlan 2

awplus(config)# vlan classifier rule 4 proto 2054 encap ethv2

vlan 2

awplus(config)# vlan classifier rule 5 proto 34525 encap ethv2

vlan 2

awplus(config)# vlan classifier rule 6 proto ipv6 encap ethv2

vlan 2

awplus(config)# vlan classifier rule 7 proto 2048 encap ethv2

vlan 2

awplus(config)# vlan classifier rule 8 proto ip encap ethv2

vlan 2

awplus# show vlan classifier rule

vlan classifier rule 16 proto rarp encap ethv2 vlan 2

vlan classifier rule 8 proto encap ethv2 vlan 2

vlan classifier rule 4 proto arp encap ethv2 vlan 2

vlan classifier rule 3 proto xeroxpup encap ethv2 vlan 2

vlan classifier rule 2 proto ip encap ethv2 vlan 2

vlan classifier rule 1 proto ipv6 encap ethv2 vlan 2

VLAN Commands

Software Reference for GS900MX/MPX Series Switches

17.40 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

vlan database

Use this command to enter the VLAN Configuration mode.

Syntax vlan database

Mode Global Configuration

Usage Use this command to enter the VLAN configuration mode. You can then add or delete a

VLAN, or modify its values.

Example In the following example, note the change to VLAN configuration mode from Configure

mode:

Related Commands vlan

awplus# configure terminal

awplus(config)# vlan database

awplus(config-vlan)#

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 18.1

Chapter 18: Spanning Tree Introduction: STP,

RSTP, and MSTP

Introduction ........................................................................................................................................ 18.2

Overview of Spanning Trees ......................................................................................................... 18.2

Spanning Tree Operation........................................................................................................ 18.2

Spanning Tree Modes .............................................................................................................. 18.4

Spanning Tree Protocol (STP) ....................................................................................................... 18.5

Configuring STP................................................................................................................................. 18.6

Rapid Spanning Tree Protocol (RSTP)........................................................................................ 18.8

Configuring RSTP .............................................................................................................................. 18.9

Multiple Spanning Tree Protocol (MSTP) ...............................................................................18.11

Multiple Spanning Tree Instances (MSTI)........................................................................18.12

MSTP Regions............................................................................................................................18.13

Common and Internal Spanning Tree (CIST) .................................................................18.15

MSTP Bridge Protocol Data Units (BPDUs)......................................................................18.17

Configuring MSTP ...........................................................................................................................18.19

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

18.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Introduction

This chapter describes and provides configuration procedures for:

■Spanning Tree Protocol (STP)

■Rapid Spanning Tree Protocol (RSTP)

■Multiple Spanning Tree Protocol (MSTP)

For detailed information about the commands used to configure spanning trees, see

Chapter 19, Spanning Tree Commands.

Overview of Spanning Trees

The concept of the spanning tree protocol was devised to address broadcast storming.

The spanning tree algorithm itself is defined by the IEEE standard 802.1D and its later

revisions.

The IEEE Standard 802.1 uses the term “bridge” to define the spanning tree operation, and

uses terms such as Bridge Protocol Data Units and Root Bridge when defining spanning

tree protocol functions.

When a bridge receives a frame, it reads the source and destination address fields. The

bridge then enters the frame’s source address in its forwarding database. In doing this the

bridge associates the frame’s source address with the network attached to the port on

which the frame was received. The bridge also reads the destination address and if it can

find this address in its forwarding database, it forwards the frame to the appropriate port.

If the bridge does not recognize the destination address, it forwards the frame out from all

its ports except for the one on which the frame was received, and then waits for a reply.

This process is known as “flooding”.

A significant problem arises where bridges connect via multiple paths. A frame that arrives

with an unknown destination address is flooded over all available paths. The arrival of

these frames at another network via different paths and bridges produces major

problems. The bridges can become confused about the location of the send and receive

devices and begin sending frames in the wrong directions. This process is self-

perpetuating and produces a condition known as a broadcast storm, where the increase

of circulating frames can eventually overload the network.

Spanning Tree Operation

Where a LAN’s topology results in more than one path existing between bridges, frames

transmitted onto the extended LAN circulate in increasing numbers around the loop,

decreasing performance and potentially overloading the network. However, multiple

paths through the extended LAN are often required in order to provide redundancy and

backup in the event of a bridge or link failure.

The spanning tree is created through the exchange of Bridge Protocol Data Units (BPDUs)

between the bridges in the LAN. The spanning tree algorithm operates by:

■Automatically computing a loop-free portion of the topology, called a spanning tree.

The topology is dynamically pruned to the spanning tree by declaring certain ports

on a switch to be redundant, and placing them into a ‘blocking’ state.

■Automatically recovering from a switch failure that would partition the extended LAN

by reconfiguring the spanning tree to use redundant paths, if available.

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 18.3

The logical tree computed by the spanning tree algorithm has the following properties:

■A single bridge is selected to become the spanning tree’s unique root bridge. This is

the device that advertises the lowest Bridge ID. Each bridge is uniquely identified by

its Bridge ID, which comprises the bridge’s root priority (a spanning tree parameter)

followed by its MAC address.

■Each bridge or LAN in the tree, except the root bridge, has a unique parent, known as

the designated bridge. Each LAN has a single bridge, called the designated bridge, that

connects it to the next LAN on the path towards the root bridge.

■Each port connecting a bridge to a LAN has an associated cost, called the root path

cost. This is the sum of the costs for each path between the particular bridge port and

the root bridge. The designated bridge for a LAN is the one that advertises the lowest

root path cost. If two bridges on the same LAN have the same lowest root path cost,

then the switch with the lowest bridge ID becomes the designated bridge.

The spanning tree computation is a continuous, distributed process to establish and

maintain a spanning tree (Table 18-1). The basic algorithm is similar for STP, RSTP and

MSTP modes.

1. The whole three part port number (D.M.P) is used to find the lowest port number, where

D is the device number within a stack (1 for a non stacked device), M is the module

number within the device (note that 0 is used for all base-board connected ports), and P is

the number of the port within the base-board.

Table 18-1: Spanning tree process

The spanning tree algorithm ... By ...

Selects a root bridge It selects as the root bridge for the spanning tree the

device with the (numerically) lowest bridge identifier

(that is, the device with lowest root bridge priority

value, or if they have the same priority, the bridge

with the lowest MAC address).

Selects root ports On each device, it selects the root port according to:

■the port with the lowest path cost to the root

bridge

■the port connected to the bridge with the lowest

root identifier

■MSTP and RSTP only: the port with the lowest port

priority value

■the port with the lowest port number1

Blocks alternate ports In order to prevent loops, it blocks alternate ports

(discarding state) that provide higher cost paths to

the root bridge.

Blocks backup ports Where a second port connects one switch back to

itself, it blocks the backup port that has the highest

path cost or port number.

Selects designated ports All other ports that are not disabled are selected as

designated ports and are eventually made active

(Forwarding state).

Maintains the spanning tree If a switch or port fails, the spanning tree configures a

new active topology, changing some port states, to

reestablish connectivity and block loops. Depending

on where the failure occurs, the changes may be

widespread (e.g. if the root bridge fails), or local (e.g. if

a designated port fails).

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

18.4 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

The logical spanning tree, sometimes called the active topology, includes the root bridge

and all designated bridges, meaning all ports that are to be used for communication

within the spanning tree. These ports are in the forwarding state. Ports removed from the

logical spanning tree are not in the forwarding state. To implement the spanning tree

algorithm, devices communicate with one another using the Spanning Tree Protocol.

Spanning Tree Modes

STP can run in one of three modes: STP, RSTP or MSTP. A device running RSTP is compatible

with other devices running STP; a device running MSTP is compatible with other devices

running RSTP or STP. By default, on a device in MSTP mode each port automatically

detects the mode of the device connected to it (MSTP, RSTP or STP), and responds in the

appropriate mode by sending messages (BPDUs) in the corresponding format. Ports on a

device in RSTP mode can automatically detect and respond to connected devices in RSTP

and STP mode. Particular ports can also be forced to only operate in a particular mode

(spanning-tree force-version command on page 19.44).

STP The Spanning Tree Protocol (STP) is the original protocol defined by IEEE standard

802.1D-1988. It creates a single spanning tree over a network.

STP mode may be useful for supporting applications and protocols whose frames may

arrive out of sequence or duplicated, for example NetBeui.

RSTP Rapid Spanning Tree Protocol (RSTP) also creates a single spanning tree over a network.

Compared with STP, RSTP provides for more rapid convergence to an active spanning tree

topology. RSTP is defined in IEEE standard 802.1D-2004.

By default, the device operates in RSTP mode.

MSTP The Multiple Spanning Tree Protocol (MSTP) addresses the limitations in the previous

spanning tree protocols, STP and RSTP, within networks that use multiple VLANs with

topologies that employ alternative physical links. It supports multiple spanning tree

instances on any given link within a network, and supports large networks by grouping

bridges into regions that appear as a single bridge to other devices.

MSTP is defined in IEEE standard 802.1Q-2005. The protocol builds on, and remains

compatible with, the previous IEEE standards defining STP and RSTP.

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 18.5

Spanning Tree Protocol (STP)

STP uses the process described in Table 18-1 to avoid loops.

STP port states In STP mode, each switch port can be in one of five spanning tree states, and one of two

switch states. The state of a switch port is taken into account by STP. The STP port states

(Table 18-2) affect the behavior of ports whose switch state is enabled.

Table 18-2: STP port states

State Meaning

DISABLED STP operations are disabled on the port. The port does not

participate in the operation of the Spanning Tree Algorithm and

Protocol. The port can still switch if its switch state is enabled.

BLOCKING The forwarding process discards received frames and does not

submit forwarded frames for transmission. This is the “standby”

mode.The port does not participate in frame relay.

LISTENING The port is enabled for receiving frames only. The port is preparing to

participate in frame relay. The forwarding process discards received

frames and does not submit forwarded frames for transmission.

LEARNING The port is enabled for receiving frames only, and the Learning

Process can add new source address information to the Forwarding

Database.

FORWARDING The normal state for a switch port. The forwarding process and the

Spanning Tree entity are enabled for transmit and receive operations

on the port.

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

18.6 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Configuring STP

By default, RSTP is enabled on all switch ports. This section provides a procedure for

configuring STP (Table 18-3).

To configure other modes, see “Configuring RSTP” on page 18.9 or “Configuring

MSTP” on page 18.19.

Table 18-3: Configuration procedure for STP

Command Description

Step 1. Configure STP

RSTP is enabled by default with default settings on all switch ports to prevent Layer 2 loops in your network.

awplus#

configure terminal Enter Global Configuration mode.

awplus(config)#

spanning-tree mode stp By default, the device is in RSTP mode. Change to STP

mode.

awplus(config)#

spanning-tree enable By default, spanning tree is enabled on all switch ports. If

it has been disabled, enable it for STP.

awplus(config)#

spanning-tree priority <priority> By default, all devices have the same root bridge priority,

32768 (8000 in hexadecimal), so the device with the

lowest MAC address becomes the root bridge. If you

want the device to be the root bridge, set the root bridge

priority to a value lower than 32768.

Enter a value in the range 0 to 61440. If you enter a

number that is not a multiple of 4096, the switch rounds

the number down.

Step 2. Configure Root Guard

The Root Guard feature makes sure that the port on which it is enabled is a designated port. If the Root Guard

enabled port receives a superior BPDU, it goes to a Listening state (for STP) or discarding state (for RSTP and

MSTP).

awplus(config)#

interface <port-list>Enter Interface Configuration mode for the switch ports

you want to enable Root Guard for.

awplus(config-if)#

spanning-tree guard root Enable the Guard Root feature for these ports.

awplus(config-if)#

exit Return to Global Configuration mode.

awplus(config)#

exit Return to Privileged Exec mode.

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 18.7

Advanced

configuration:

For most networks the default settings for path costs will be suitable, however, you can

configure them if required (spanning-tree path-cost).

Step 3. Check STP configuration

awplus#

show spanning-tree [interface

<port-list>]

Display the spanning tree configuration for the device,

and confirm the new root bridge priority (Bridge Priority).

Note that the Bridge ID is in a form like this:

80000000cd240331, and that other IDs follow the same

pattern. This is made up of:

8000—the devices’ root bridge priority in hexadecimal

0000cd24033

—the devices’ MAC address.

Table 18-3: Configuration procedure for STP(cont.)

Command Description

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

18.8 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Rapid Spanning Tree Protocol (RSTP)

RSTP uses the process described in Table 18-1 to avoid loops.

A spanning tree running in STP mode can take up to one minute to rebuild after a topology

or configuration change. The RSTP algorithm provides for a faster recovery of connectivity

following the failure of a bridge, bridge port, or a LAN.

RSTP provides rapid recovery by

including port roles in the computation of port states, and by allowing neighboring

bridges to explicitly acknowledge signals on a point-to-point link that indicate that a port

wants to enter the forwarding mode.

In rapid mode, the rapid transition of a port to the forwarding state is possible when the

port is considered to be part of a point-to-point link, or when the port is considered to be

an edge port. An edge port is one that attaches to a LAN that has no other bridges

attached.

Table 18-4: RSTP port states

State Meaning

DISABLED STP operations are disabled on the port.

DISCARDING The port does not participate in frame relay. The forwarding process

discards received frames and does not submit forwarded frames for

transmission.

LEARNING The port is enabled for receiving frames only, and the learning

process can add new source address information to the forwarding

database. The port does not forward any frames.

FORWARDING The normal state for a switch port. The forwarding process and the

Spanning Tree entity are enabled for transmit and receive

operations on the port.

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 18.9

Configuring RSTP

RSTP is enabled by default with default settings on all switch ports to prevent Layer 2

loops in your network. No further configuration is required if you want to use RSTP with

these default settings. For further RSTP configuration, see Table 18-5 below.

To configure other modes, see “Configuring MSTP” on page 18.19 or “Configuring

STP” on page 18.6.

For detailed configuration examples, see the How To Note How To Configure Basic

Switching Functionality, available from alliedtelesis.com.

Table 18-5: Configuration procedure for RSTP

Command Description

Step 1. Configure RSTP

RSTP is enabled by default with default settings on all switch ports to prevent Layer 2 loops in your network. No

further configuration is required if you want to use RSTP with these default settings. If you need to restore the

device to RSTP after it has been set to another mode, or modify the default RSTP settings, follow the procedure

below.

awplus#

configure terminal Enter Global Configuration mode.

awplus(config)#

spanning-tree mode rstp By default, the device is in RSTP mode. If it has been

changed to STP or MSTP mode, change it back to RSTP.

awplus(config)#

spanning-tree enable By default, spanning tree is enabled on all switch ports. If

it has been disabled, enable it for RSTP.

awplus(config)#

spanning-tree priority <priority> By default, all devices have the same root bridge priority,

32768 (8000 in hexadecimal), so the device with the

lowest MAC address becomes the root bridge. If you

want the device to be the root bridge, set the root bridge

priority to a value lower than 32768.

Enter a value in the range 0 to 61440. If you enter a

number that is not a multiple of 4096, the switch rounds

the number down.

Step 2. Configure edge ports

If some switch ports are connected to devices that cannot generate BPDUs (such as workstations), you can set

particular switch ports as edge ports, or set them to automatically detect whether they are edge ports.

awplus(config)#

interface <port-list> Enter Interface Configuration mode for these switch

ports.

awplus(config-if)#

spanning-tree edgeport (RSTP and

MSTP)

or awplus(config-if)#

spanning-tree autoedge (RSTP and

MSTP)

Set these ports to be edge ports,

set these ports to automatically detect whether they are

edge ports.

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

18.10 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Advanced

configuration:

For most networks the default settings for path costs will be suitable, however, you can

configure them if required (spanning-tree path-cost).

Step 3. Configure Root Guard

awplus(config-if)#

exit Return to Global Configuration mode.

awplus(config)#

interface <port-list>Enter Interface Configuration mode for the switch ports

you want to enable Root Guard for.

awplus(config-if)#

spanning-tree guard root The Root Guard feature makes sure that the port on

which it is enabled is a designated port. If the Root

Guard enabled port receives a superior BPDU, it goes to

a Listening state (for STP) or discarding state (for RSTP

and MSTP). Enable the Guard Root feature if required.

Step 4. Configure BPDU Guard

awplus(config-if)#

exit Return to Global Configuration mode.

awplus(config)#

spanning-tree portfast bpdu-guard If required, enable the BPDU Guard feature.

awplus(config)#

spanning-tree errdisable-timeout

enable

Set a timeout for ports that are disabled due to the BPDU

guard feature.

awplus(config)#

spanning-tree errdisable-timeout

interval

Specify the time interval after which a port is brought

back up when it has been disabled by the BPDU guard

feature.

Step 5. Check RSTP configuration

awplus(config)#

exit Return to Privileged Exec mode.

awplus#

show spanning-tree [interface

<port-list>]

Display the spanning tree configuration for the device,

and confirm the new root bridge priority (Bridge

Priority).

Note that the Bridge ID is in a form like this:

80000000cd240331, and that other IDs follow the same

pattern. This is made up of:

8000—the devices’ root bridge priority in hexadecimal

0000cd24033

—the devices’ MAC address.

Table 18-5: Configuration procedure for RSTP(cont.)

Command Description

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 18.11

Multiple Spanning Tree Protocol (MSTP)

Conceptually, MSTP views the total bridged network as one that comprises a number of

Multiple Spanning Tree Regions (MSTRs), where each region can contain up to 64 spanning

trees, which operate locally, called Multiple Spanning Tree Instances (MSTIs).

AlliedWare PlusTM supports up to 15 MSTIs. The regions are linked by the Common Internal

Spanning Tree (CIST).

MSTP uses BPDUs to exchange information between spanning-tree compatible devices, to

prevent loops in each MSTI and also in the CIST, by selecting active and blocked paths.

This process is described in Table 18-1.

If multiple ports are aggregated together into a dynamic (LACP) or static channel group,

then the spanning-tree process is aware of the link aggregation and treats the aggregated

ports as a single logical path.

Advantage of

MSTP over RSTP

MSTP is similar to RSTP, in that it provides loop resolution and rapid convergence.

However, RSTP can keep track of only one spanning-tree. MSTP can track many spanning-

trees, referred to as instances. MSTP makes it possible to have different forwarding paths

for different MST instances. This enables load balancing of network traffic across

redundant links, so that all the links in a network can be used by at least one MSTI, and no

link is left completely idle. That is to say that no link is unnecessarily shut down by

spanning-tree.

Essentially, MSTP is VLAN aware and RSTP is not VLAN aware. MSTP BPDUs and RSTP

BPDUs are compatible, so a network can have a mixture of MSTP and RSTP areas.

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

18.12 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Multiple Spanning Tree Instances (MSTI)

MSTP enables the grouping and mapping of VLANs to different spanning tree instances.

So, an MST Instance (MSTI) is a particular set of VLANs that are all using the same spanning

tree.

In a network where all VLANs span all links of the network, judicious choice of bridge

priorities for different MSTIs can result in different switches becoming root bridges for

different MSTIs. That will result in the different MSTIs choosing different active topologies

on the network. An example of how different MSTIs can choose different active topologies

on the same physical set of links is illustrated in Figure 18-1.

MSTP is compatible with RSTP and STP—see “Common and Internal Spanning Tree

(CIST)” on page 18.15.

Figure 18-1: Different spanning trees created by different MSTIs on the same

physical layout

Physical connections

Spanning tree of MSTI= 1 containing vlans 2, 7, 9, 43

Spanning tree of MSTI= 2 containing vlans 16, 18, 24, 40

Spanning tree of MSTI= 3 containing vlans 23, 39, 50, 112

Diff_MSTI_1

Root bridge for

MSTI 1

Root bridge for

MSTI 2

Root bridge for

MSTI 3

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 18.13

MSTP Regions

An MST region is a set of interconnected switches that all have the same values for the

following MST configuration identification elements:

■MST configuration name - the name of the MST region

■Revision level - the revision number of configuration

■Configuration Digest - the mapping of which VLANs are mapped to which MST

instances

Each of the MST instances created are identified by an MSTI number. This number is locally

significant within the MST region. Therefore, an MSTI will not span across MST regions.

Figure 18-2: MSTIs in different regions

MSTI1

MSTI2

MSTI3

MSTI_numbers

MSTI1

MSTI3

MSTI2

MSTI4

Region 1

Region 3

Region 2

The MSTI1 in Region 1 is unrelated to the MSTI1 in Region 3. Similarly, the MSTI2 in Region 1 is quite

unrelated to the MSTI2 in Region 2.

Physical connections

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

18.14 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

The task of assigning each bridge to a particular region is achieved by the member

bridges each comparing their MST Configuration Identifiers. More information on

configuration identifiers is provided in Table 18-6, but for the moment an MST

Configuration Identifier can simply be thought of as an identifier that represents the

mapping of VLANs to MSTIs within each bridge. Therefore, bridges with identical MST

Configuration Identifiers, must have identical MSTI mapping tables.

While each MSTI can have multiple VLANs, each VLAN can be associated with only one

MSTI. Once these associations have been made, the bridges in each region can transmit

their spanning tree BPDUs and advertise their MSTIs. This in turn establishes the active

data paths between the bridges for each group of VLANs (that is, for each MSTI) and block

any duplicate paths within each instance. A particular advantage of this enhancement

applies where a large number of VLANs share a few internetwork paths. In this situation

there need only be as many Multiple Spanning Tree Instances (MSTIs) as there are source

and destination bridge pairs, remembering that a pair of bridges probably has multiple

paths between them.

In order to ensure that each bridge within a region maintains the same configuration

information (particularly their VID to MSTI mappings) and to ensure each bridge’s

membership of a particular region, the bridges exchange configuration information in the

form of MST Configuration Identifiers. Table 18-6 provides a breakdown of an MST

Configuration Identifier. A detailed explanation of bridge configuration identifiers can be

found in Section 13.7 of the IEEE 802.1Q-2003 standard.

Table 18-6: MST Configuration Identifier

Field Name Description

Format Selector A single octet field whose value of 0 indicates MSTP operation

Region Name A name (up to 32 characters long) that identifies a particular

MST region, defined using the region (MSTP) command on

page 19.11

Revision Level A number representing the region’s revision level, defined

using the revision (MSTP) command on page 19.12.

Configuration Digest A 16 octet (HMAC-MD5 based) signature created from the MST

configuration table.

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 18.15

Common and Internal Spanning Tree (CIST)

The CIST is the default spanning tree instance of MSTP, i.e. all VLANs that are not members

of particular MSTIs are members of the CIST. Also, an individual MST region can be

regarded as a single virtual bridge by other MST regions. The spanning tree that runs

between regions is the CIST. The CIST is also the spanning tree that runs between MST

regions and Single Spanning Tree (SST) entities. So, in Figure 18-3, the STP that is running

between the regions, and to the SST bridges, is the CIST.

Figure 18-3: The CIST operates on links between regions and to SST devices

Compatibility with

Previous Spanning

Tree Protocols

MSTP provides for compatibility with older spanning tree protocols in several ways. In

addition to the MST region described in the previous section, the protocol provides for

single spanning tree systems by employing a Common and Internal Spanning Tree (CIST).

The CIST applies a common and internal spanning tree protocol to the whole of the

bridged network and is a direct equivalent to the internal spanning tree (IST) protocol of

earlier versions.

In common with legacy spanning tree systems, the CIST protocol first determines its root

bridge from all the bridges on the network. This is the bridge that contains the lowest

bridge identifier. The protocol then selects a regional root bridge for each MSTR. This is the

bridge that provides the best path to the CIST root. After the MSTR root bridges have been

chosen, they then act on the region’s behalf in such a way that the region appears to the

Common Spanning Tree (CST) as a virtual bridge. So in addition to having multiple MSTIs,

each region operates as a bridge in a CST.

RSTP operates on these links

MSTP

Region 1

MSTP

Region 2

MSTP

Region 3

The three switches shown

are non-MSTP capable

MSTP_vs_RSTP

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

18.16 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

CIST In addition to the individual MSTIs within each MSTP region, the MSTP region is a member

of a network-wide spanning tree called the Common and Internal Spanning Tree (CIST).

Conceptually, each region represents a virtual bridge. Internal and external bridge

connectivity are two independent functions.

Frames with VIDs allocated to the CIST are subject to the rules and path costs of the

complete bridged LAN as determined by the CIST’s vectors. Frames other than these are

subject to the CIST when traveling outside their region, and subject to its particular MSTI

inside the region.

The following operational rules apply:

■Each bridge can be a member of only one region.

■A data frame is associated with a single VID.

■Data frames with a given VID are associated with either the CIST or their particular

MSTI, but not both.

The role of the Common Spanning Tree (CST) in a network, and the Common and Internal

Spanning Tree (CIST) configured on each device, is to prevent loops within a wider

network that may span more than one MSTP region and parts of the network running in

legacy STP or RSTP mode.

CIST first allocates root and designated bridges by selecting the bridge with the lowest

identifier as the root. MSTP then deals with any loops between the regions in the CST. It

does this by considering the CIST “vectors” in the following order:

1. CIST External Root Path Cost

2. CIST Regional Root Identifier

3. CIST Internal Root Path Cost

4. CIST Designated Bridge Identifier

5. CIST Designated Port Identifier

6. CIST Receiving Port Identifier

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 18.17

MSTP Bridge Protocol Data Units (BPDUs)

The main function of bridge protocol data units is to enable MSTP to select its root bridges

for the CIST (“Common and Internal Spanning Tree (CIST)” on page 18.15) and each

MSTI. MSTP is compatible with earlier spanning tree versions; its Bridge Protocol Data Unit

(BPDU) formats build on earlier versions (“Compatibility with Previous Spanning Tree

Protocols” on page 18.15).

Table 18-7 shows the standardized format for MSTP BPDU messages. The general format

of the BPDUs comprise a common generic portion—octets 1 to 36—that are based on

those defined in IEEE Standard 802.1D, 1998, followed by components that are specific to

CIST—octets 37 to 102. Components specific to each MSTI are added to this BPDU data

block.

)

Table 18-7: MSTP Bridge Protocol Data Units (BPDUs)

Field Name Octets Description

Protocol Identifier 1–2 Protocol being used. The value 0000 0000 0000 0000

identifies the spanning tree algorithm and protocol.

Protocol Version

Identifier 3Identifies the protocol version used.

BPDU Type 4Value 0000 0000 specifies a configuration BPDU.

CIST Flags 5Bit 1 is the topology change flag.

Bit 2 conveys the CIST proposal flag in RST and MST

BPDUs - unused in STP.

Bits 3 & 4 convey the CIST port role in RST, and MST

BPDUs - unused in STP.

Bit 5 conveys the CIST learning flag in RST and MST

BPDUs - unused in STP.

Bit 6 conveys the CIST forwarding flag in RST and MST

BPDUs - unused in STP.

Bit 7 conveys the CIST agreement flag in RST and MST

BPDUs - unused in STP.

Bit 8 conveys the topology change acknowledge flag in

STP configuration BPDUs - unused in RSTP and MSTP

BPDUs.

CIST Root Identifier 6–13 The Bridge identifier of the CIST Root

CIST External Path

Cost

14–17 The path cost between MST regions from the

transmitting bridge to the CIST root.

CIST Regional Root

Identifier

18–25 ID of the current CIST regional root bridge.

CIST Port Identifier 26–27 CIST port identifier of the transmitting bridge port.

Message Age 28–29 Message age timer value.

Max Age 30–31 Timeout value to be used by all bridges in the bridged

network. This value is set by the root. Some

implementations of MSTP may choose not to use this

value.

Hello Time 32–33 Time interval between the generation of configuration

BPDUs by the root bridge.

Forward Delay 34–35 A timeout value used to ensure forward delay timer

consistency when transferring a port to the forwarding

state. It is also used for ageing filtering database

dynamic entries following changes in the active

topology.

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

18.18 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Version 1 Length 36 Used to convey the Version 1 length. It is always

transmitted as 0.

Version 3 Length 37–38 Used to convey the Version 3 length. It is the number

of octets taken by the parameters that follow in the

BPDU.

MST Configuration

Identifier

39–89 An identifier comprising elements of the following:

Format Selector

Configuration Name

Revision Level

Configuration Digest.

CIST Internal Root

Path Cost

90–93 Path cost to the CIST regional root.

CIST Bridge

Identifier

94–101 CIST bridge identifier of the transmitting bridge.

CIST Remaining

Hops 102 Remaining hops which limits the propagation and

longevity of received spanning tree information for the

CIST.

MSTI Configuration

Messages

(may be absent)

103–39

plus

Version

Length

See Table 18-8.

Table 18-8: MSTI configuration messages

Field Name Octets Description

MSTI Flags 1Bits 1 through 8, convey the topology change flag,

proposal flag, port role (two bits), Learning flag,

forwarding flag, agreement flag, and master flag for

this MSTI.

MSTI Regional Root

Identifier

2–9 This includes the value of the MSTID for this

configuration message encoded in bits 4 through 1 of

octet 1, and bits 8 through 1 of octet 2.

MSTI Internal Root

Path Cost 10-13 Internal Root Path Cost.

MSTI Bridge Priority 14 Bits 5 through 8 convey the value of the bridge

identifier priority for this MSTI. Bits 1 through 4 of Octet

14 are transmitted as 0, and ignored on receipt.

MSTI Port Priority 15 Bits 5 through 8 are used to convey the value of the

port identifier priority for this MSTI. Bits 1 through 4 are

transmitted as 0, and ignored on receipt.

MSTI Remaining

Hops

16 Value of remaining hops for this MSTI.

Table 18-7: MSTP Bridge Protocol Data Units (BPDUs) (cont.)

Field Name Octets Description

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 18.19

Configuring MSTP

By default, RSTP is enabled with default settings on all switch ports. To configure MSTP, see

the configuration procedure in Table 18-9.

To configure other modes, see “Configuring RSTP” on page 18.9 or “Configuring STP”

on page 18.6.

For detailed configuration examples, see the How To Note How To Configure Basic

Switching Functionality, available from website at alliedtelesis.com.

Configuration

guidelines for

MSTP

■Switches must have the same MST configuration identification elements (region

name, revision level and VLAN to MSTI mapping) to be in the same MST region. When

configuring multiple MST regions for MSTP, MSTIs are locally significant within an MST

region. MSTIs will not span from one region to another region.

■Common and Internal Spanning Tree (CIST) is the default spanning tree instance for

MSTP. This means that all VLANs that are not explicitly configured into another MSTI

are members of the CIST.

■The software supports a single instance of the MSTP Algorithm consisting of the CIST

and up to 15 MSTIs.

■A VLAN can only be mapped to one MSTI or to the CIST. One VLAN mapped to

multiple spanning trees is not allowed. All the VLANs are mapped to the CIST by

default. Once a VLAN is mapped to a specified MSTI, it is removed from the CIST.

■An MSTI is locally significant within an MST region. An MSTI cannot span across

multiple MST regions. The CIST is the spanning tree instance for connecting different

MST regions and single spanning tree entities, such as RSTP and STP switches.

■MSTP is compatible with RSTP and STP. An MST region appears as a virtual bridge

connecting to single spanning tree entities.

■To avoid unnecessary STP processing, a port that attaches to a LAN that is known to

have no other bridges/switches attached can be configured as an edge port.

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

18.20 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Before configuring

MSTP

Before configuring MSTP, configure VLANs and associate them with switch ports

(Chapter 16, VLAN Introduction and Chapter 17, VLAN Commands), and determine for

your network:

■which MSTP regions, revision level and instances are required

■which VLANs and switch ports will belong to which MSTIs,

■which devices you want to be root bridges for each MSTI

Table 18-9: Configuration procedure for MSTP

Command Description

awplus#

configure terminal Enter Global Configuration mode.

awplus(config)#

spanning-tree mode mstp By default, the device is in RSTP mode. Change to MSTP

mode.

awplus(config)#

spanning-tree enable By default, spanning tree is enabled on all switch ports. If

it has been disabled, enable it for MSTP.

Step 1. Configure MSTP region, revision, and instances

All MSTP devices in this region of the network must have the same region name, revision number, and VLAN to

MSTI mappings.

awplus(config)#

spanning-tree mst configuration Enter MST Configuration mode.

awplus(config-mst)#

region <region-name> Specify the MSTP region. The region-name parameter is

an arbitrary string that specifies the name you want to

assign to the MST region for identification.

awplus(config-mst)#

revision <revision-number> The revision-number parameter specifies the revision of

the current MST configuration. The revision is an

arbitrary number that you assign to an MST region. It can

be used to keep track of the number of times that MST

configuration has been updated for the network.

Specify the MST revision number in the range 0 to 255.

awplus(config-mst)#

instance <msti-id> vlan {<vid>|<vid-list>} To allow MSTP to block traffic for different VLANs in

different places in a loop, create multiple MSTP instances

and associate VLANs with them. Each VLAN can only be

in one instance.

Specify the MST instance ID in the range 1 to 15.

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 18.21

Step 2. Advanced configuration

The commands above are the minimum required to configure MSTP. The following commands allow more

advanced configuration.

Step 3. Assign root bridge priorities

MSTP lets you distribute traffic more efficiently across a network by blocking different links for different VLANs.

You do this by making different devices into the root bridge for each MSTP instance, and for the CIST, so that

each instance blocks a different link. By default, all devices have the same root bridge priority, 32768 (8000 in

hexadecimal), so the device with the lowest MAC address becomes the root bridge. If you want the device to be

the root bridge for an instance or for the CIST, set the priority to a lower value (a higher priority) than other

devices for this instance. (If you enter a number that is not a multiple of 4096, the device rounds the number

down.)

awplus(config)#

spanning-tree mst configuration Enter MST Configuration mode.

awplus(config-mst)#

instance <msti-id> priority

Set the priority for the device to become the root bridge

for each instance.

Specify the MST instance ID in the range 1 to 15.

Specify the root bridge priority in the range 0 to 61440. If

you enter a number that is not a multiple of 4096, the

switch rounds the number down.

awplus(config-mst)#

exit Return to Global Configuration mode.

awplus(config)#

spanning-tree priority <priority> Set the priority for the device to become the root bridge

for the CIST.

Specify the bridge priority in the range 0 to 61440. If you

enter a number that is not a multiple of 4096, the switch

rounds the number down.

Step 4. Configure edge ports

If some switch ports are connected to devices that cannot generate BPDUs (such as workstations), you can set

particular switch ports as edge ports, or set them to automatically detect whether they are edge ports.

awplus(config)#

interface <port-list> Enter Interface Configuration mode for these switch

ports.

awplus(config-if)#

spanning-tree edgeport (RSTP and

MSTP)

or awplus(config-if)#

spanning-tree autoedge (RSTP and

MSTP)

Set these ports to be edge ports,

set these ports to automatically detect whether they are

edge ports.

Table 18-9: Configuration procedure for MSTP (cont.)

Command Description

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

18.22 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Step 5. Configure Root Guard

awplus(config-if)#

spanning-tree guard root The Root Guard feature makes sure that the port on

which it is enabled is a designated port. If the Root

Guard enabled port receives a superior BPDU, it goes to

a Listening state (for STP) or discarding state (for RSTP

and MSTP). Enable the Guard Root feature if required.

awplus(config-if)#

exit Return to Global Configuration mode.

Step 6. Configure BPDU Guard

awplus(config)#

spanning-tree portfast bpdu-guard If required, enable the BPDU Guard feature.

awplus(config)#

spanning-tree errdisable-timeout

enable

Set a timeout for ports that are disabled due to the BPDU

guard feature.

awplus(config)#

spanning-tree errdisable-timeout

interval <10-1000000>

Specify the time interval after which a port is brought

back up when it has been disabled by the BPDU guard

feature.

Step 7. Check MSTP configuration

awplus(config)#

exit Return to Privileged Exec mode.

awplus#

show spanning-tree mst config Check that the digest is the same on this device as for all

other devices in the same region.

awplus#

show spanning-tree mst Check the MST to VLAN and port mapping.

awplus#

show spanning-tree mst instance

Check the detailed information for a particular instance,

and all switch ports associated with that instance.

Specify the MST instance ID in the range 1 to 15.

awplus#

show spanning-tree mst interface

<port>

Check general information about MSTP, and the CIST

settings.

Table 18-9: Configuration procedure for MSTP (cont.)

Command Description

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 18.23

Advanced

configuration:

For most networks, the default settings of the following will be suitable. However, you can

also configure them.

■path costs for ports in an MSTI (spanning-tree mst instance path-cost) or for the

CIST (spanning-tree path-cost)

■port priority for ports in an MSTI (spanning-tree mst instance priority) or for the

CIST (spanning-tree priority (port priority))

Spanning Tree Introduction: STP, RSTP, and MSTP

Software Reference for GS900MX/MPX Series Switches

18.24 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.1

Chapter 19: Spanning Tree Commands

Command List .................................................................................................................................... 19.3

clear spanning-tree statistics ........................................................................................................ 19.3

clear spanning-tree detected protocols (RSTP and MSTP) ................................................ 19.4

debug mstp (RSTP and STP) .......................................................................................................... 19.5

instance priority (MSTP).................................................................................................................. 19.8

instance vlan (MSTP)......................................................................................................................19.10

region (MSTP) ...................................................................................................................................19.11

revision (MSTP).................................................................................................................................19.12

show debugging mstp..................................................................................................................19.13

show spanning-tree .......................................................................................................................19.14

show spanning-tree brief.............................................................................................................19.17

show spanning-tree mst...............................................................................................................19.18

show spanning-tree mst config.................................................................................................19.19

show spanning-tree mst detail ..................................................................................................19.20

show spanning-tree mst detail interface................................................................................19.22

show spanning-tree mst instance.............................................................................................19.24

show spanning-tree mst instance interface..........................................................................19.25

show spanning-tree mst interface............................................................................................19.26

show spanning-tree mst detail interface................................................................................19.27

show spanning-tree statistics.....................................................................................................19.29

show spanning-tree statistics instance ...................................................................................19.30

show spanning-tree statistics instance interface ................................................................19.31

show spanning-tree statistics interface ..................................................................................19.32

show spanning-tree vlan range-index ....................................................................................19.34

spanning-tree autoedge (RSTP and MSTP)............................................................................19.35

spanning-tree bpdu .......................................................................................................................19.36

spanning-tree cisco-interoperability (MSTP) ........................................................................19.38

spanning-tree edgeport (RSTP and MSTP) ............................................................................19.39

spanning-tree enable ....................................................................................................................19.40

spanning-tree errdisable-timeout enable..............................................................................19.42

spanning-tree errdisable-timeout interval ............................................................................19.43

spanning-tree force-version........................................................................................................19.44

spanning-tree forward-time........................................................................................................19.45

spanning-tree guard root.............................................................................................................19.46

spanning-tree hello-time .............................................................................................................19.47

spanning-tree link-type ................................................................................................................19.48

spanning-tree max-age.................................................................................................................19.49

spanning-tree max-hops (MSTP)...............................................................................................19.50

spanning-tree mode ......................................................................................................................19.51

spanning-tree mst configuration ..............................................................................................19.52

spanning-tree mst instance.........................................................................................................19.53

spanning-tree mst instance path-cost ....................................................................................19.54

spanning-tree mst instance priority.........................................................................................19.56

spanning-tree mst instance restricted-role ...........................................................................19.57

spanning-tree mst instance restricted-tcn ............................................................................19.58

spanning-tree path-cost...............................................................................................................19.59

spanning-tree portfast (STP) .......................................................................................................19.60

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

spanning-tree portfast bpdu-filter ...........................................................................................19.62

spanning-tree portfast bpdu-guard.........................................................................................19.64

spanning-tree priority (bridge priority) ..................................................................................19.66

spanning-tree priority (port priority) .......................................................................................19.67

spanning-tree restricted-role......................................................................................................19.68

spanning-tree restricted-tcn.......................................................................................................19.68

spanning-tree transmit-holdcount...........................................................................................19.69

undebug mstp .................................................................................................................................19.69

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.3

Command List

This chapter provides an alphabetical reference for commands used to configure RSTP, STP

or MSTP. For information about spanning trees, including configuration procedures, see

Chapter 18, Spanning Tree Introduction: STP, RSTP, and MSTP

clear spanning-tree statistics

Use this command to clear all the STP BPDU (Bridge Protocol Data Unit) statistics.

Syntax clear spanning-tree statistics

clear spanning-tree statistics [instance <mstp-instance>]

clear spanning-tree statistics

[interface <port> [instance <mstp-instance>]]

Mode User Exec and Privileged Exec

Usage Use this command with the instance parameter in MSTP mode. Specifying this command

with the interface parameter only not the instance parameter will work in STP and RSTP

mode.

Examples

Parameter Description

<port>The port to clear STP BPDU statistics for. The port may be a switch

port (e.g. port1.0.4), a static channel group (e.g. sa2), or a

dynamic (LACP) channel group (e.g. po2).

<mstp-

instance>

The MSTP instance (MSTI - Multiple Spanning Tree Instance) to clear

MSTP BPDU statistics.

awplus# clear spanning-tree statistics

awplus# clear spanning-tree statistics instance 1

awplus# clear spanning-tree statistics interface port1.0.2

instance 1

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.4 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

clear spanning-tree detected protocols (RSTP and

MSTP)

Use this command to clear the detected protocols for a specific port, or all ports.

Use this command in RSTP or MSTP mode only.

Syntax clear spanning-tree detected protocols [interface <port>]

Mode Privileged Exec

Example

Parameter Description

<port>The port to clear detected protocols for. The port may be a switch

port (e.g. port1.0.4), a static channel group (e.g. sa2), or a

dynamic (LACP) channel group (e.g. po2).

awplus# clear spanning-tree detected protocols

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.5

debug mstp (RSTP and STP)

Use this command to enable debugging for the configured spanning tree mode, and echo

data to the console, at various levels. Note that although this command uses the keyword

mstp it displays debugging output for RSTP and STP protocols as well the MSTP protocol.

Use the no variant of this command to disable spanning tree debugging.

Syntax debug mstp {all|cli|protocol [detail]|timer [detail]}

debug mstp {packet {rx|tx} [decode] [interface <interface>]}

debug mstp {topology-change [interface <interface>]}

no debug mstp {all|cli|protocol [detail]|timer [detail]}

no debug mstp {packet {rx|tx} [decode] [interface <interface>]}

no debug mstp {topology-change [interface <interface>]}

Mode Privileged Exec and Global Configuration mode

Usage 1 Use the debug mstp topology-change interface command to generate debugging

messages when the switch receives an indication of a topology change in a BPDU from

another device. The debugging can be activated on a per-port basis. Although this

command uses the keyword mstp, it displays debugging output for RSTP and STP

protocols as well as the MSTP protocol.

Due to the likely volume of output, these debug messages are best viewed using the

terminal monitor command on page 8.69 before issuing the relevant debug mstp

command. The default terminal monitor filter will select and display these messages.

Alternatively, the messages can be directed to any of the other log outputs by adding a

filter for the MSTP application using log buffered (filter) command on page 10.8:

Parameter Description

all Echoes all spanning tree debugging levels to the console.

cli Echoes spanning tree commands to the console.

packet Echoes spanning tree packets to the console.

rx Received packets.

tx Transmitted packets.

protocol Echoes protocol changes to the console.

timer Echoes timer information to the console.

detail Detailed output.

decode Interprets packet contents

topology-change Interprets topology change messages

interface Keyword before <interface> placeholder to specify an

interface to debug

<interface>Placeholder used to specify the name of the interface to

debug.

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.6 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Output 1

Usage 2 Use the debug mstp packet rx|tx decode interface command to generate debugging

messages containing the entire contents of a BPDU displayed in readable text for

transmitted and received xSTP BPDUs. The debugging can be activated on a per-port basis

and transmit and receive debugging is controlled independently. Although this command

uses the keyword mstp, it displays debugging output for RSTP and STP protocols as well

as the MSTP protocol.

Due to the likely volume of output, these debug messages are best viewed using the

terminal monitor command on page 8.69 before issuing the relevant debug mstp

command. The default terminal monitor filter will select and display these messages.

Alternatively, the messages can be directed to any of the other log outputs by adding a

filter for the MSTP application using the log buffered (filter) command on page 10.8:

Output 2 In MSTP mode - an MSTP BPDU with 1 MSTI:

awplus# configure terminal

awplus(config)# log buffered program mstp

awplus#terminal monitor

awplus#debug mstp topology-change interface port1.0.4

10:09:09 awplus MSTP[1409]: Topology change rcvd on port1.0.4 (internal)

10:09:09 awplus MSTP[1409]: Topology change rcvd on MSTI 1 port1.0.4

aawplus#debug mstp topology-change interface port1.0.6

10:09:29 awplus MSTP[1409]: Topology change rcvd on port1.0.6 (external)

10:09:29 awplus MSTP[1409]: Topology change rcvd on MSTI 1 port1.0.6

awplus(config)# log buffered program mstp

awplus#terminal monitor

awplus#debug mstp packet rx decode interface port1.0.4

17:23:42 awplus MSTP[1417]: port1.0.4 xSTP BPDU rx - start

17:23:42 awplus MSTP[1417]: Protocol version: MSTP, BPDU type: RST

17:23:42 awplus MSTP[1417]: CIST Flags: Agree Forward Learn role=Desig

17:23:42 awplus MSTP[1417]: CIST root id : 0000:0000cd1000fe

17:23:42 awplus MSTP[1417]: CIST ext pathcost : 0

17:23:42 awplus MSTP[1417]: CIST reg root id : 0000:0000cd1000fe

17:23:42 awplus MSTP[1417]: CIST port id : 8001 (128:1)

17:23:42 awplus MSTP[1417]: msg age: 0 max age: 20 hellotime: 2 fwd delay: 15

17:23:42 awplus MSTP[1417]: Version 3 length : 80

17:23:42 awplus MSTP[1417]: Format id : 0

17:23:42 awplus MSTP[1417]: Config name : test

17:23:42 awplus MSTP[1417]: Revision level : 0

17:23:42 awplus MSTP[1417]: Config digest : 3ab68794d602fdf43b21c0b37ac3bca8

17:23:42 awplus MSTP[1417]: CIST int pathcost : 0

17:23:42 awplus MSTP[1417]: CIST bridge id : 0000:0000cd1000fe

17:23:42 awplus MSTP[1417]: CIST hops remaining : 20

17:23:42 awplus MSTP[1417]: MSTI flags : Agree Forward Learn role=Desig

17:23:42 awplus MSTP[1417]: MSTI reg root id : 8001:0000cd1000fe

17:23:42 awplus MSTP[1417]: MSTI pathcost : 0

17:23:42 awplus MSTP[1417]: MSTI bridge priority : 32768 port priority : 128

17:23:42 awplus MSTP[1417]: MSTI hops remaining : 20

17:23:42 awplus MSTP[1417]: port1.0.4 xSTP BPDU rx - finish

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.7

In STP mode transmitting a TCN BPDU:

In STP mode receiving an STP BPDU:

In RSTP mode receiving an RSTP BPDU:

Examples

Related Commands log buffered (filter)

show debugging mstp

terminal monitor

undebug mstp

awplus#terminal monitor

awplus#debug mstp packet tx decode interface port1.0.4

17:28:09 awplus MSTP[1417]: port1.0.4 xSTP BPDU tx - start

17:28:09 awplus MSTP[1417]: Protocol version: STP, BPDU type: TCN

17:28:09 awplus MSTP[1417]: port1.0.4 xSTP BPDU tx - finish

awplus#terminal monitor

awplus#debug mstp packet rx decode interface port1.0.4

17:31:36 awplus MSTP[1417]: port1.0.4 xSTP BPDU rx - start

17:31:36 awplus MSTP[1417]: Protocol version: STP, BPDU type: Config

17:31:36 awplus MSTP[1417]: Flags: role=none

17:31:36 awplus MSTP[1417]: Root id : 8000:0000cd1000fe

17:31:36 awplus MSTP[1417]: Root pathcost : 0

17:31:36 awplus MSTP[1417]: Bridge id : 8000:0000cd1000fe

17:31:36 awplus MSTP[1417]: Port id : 8001 (128:1)

17:31:36 awplus MSTP[1417]: msg age: 0 max age: 20 hellotime: 2 fwd delay: 15

17:31:36 awplus MSTP[1417]: ort1.0.4 xSTP BPDU rx - finish

awplus#terminal monitor

awplus#debug mstp packet rx decode interface port1.0.4

awplus#17:30:17 awplus MSTP[1417]: port1.0.4 xSTP BPDU rx - start

17:30:17 awplus MSTP[1417]: Protocol version: RSTP, BPDU type: RST

17:30:17 awplus MSTP[1417]: CIST Flags: Forward Learn role=Desig

17:30:17 awplus MSTP[1417]: CIST root id : 8000:0000cd1000fe

17:30:17 awplus MSTP[1417]: CIST ext pathcost : 0

17:30:17 awplus MSTP[1417]: CIST reg root id : 8000:0000cd1000fe

17:30:17 awplus MSTP[1417]: CIST port id : 8001 (128:1)

17:30:17 awplus MSTP[1417]: msg age: 0 max age: 20 hellotime: 2 fwd delay: 15

17:30:17 awplus MSTP[1417]: port1.0.4 xSTP BPDU rx - finish

awplus# debug mstp all

awplus# debug mstp cli

awplus# debug mstp packet rx

awplus# debug mstp protocol detail

awplus# debug mstp timer

awplus# debug mstp packet rx decode interface port1.0.2

awplus# debug mstp packet tx decode interface port1.0.6

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.8 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

instance priority (MSTP)

Use this command to set the priority for this device to become the root bridge for the

specified MSTI (Multiple Spanning Tree Instance).

Use this command for MSTP only.

Use the no variant of this command to restore the root bridge priority of the device for the

instance to the default.

Syntax instance <msti-id> priority <priority>

no instance <msti-id> priority

Default The default priority value for all instances is 32768.

Mode MST Configuration

Usage MSTP lets you distribute traffic more efficiently across a network by blocking different

links for different VLANs. You do this by making different devices into the root bridge for

each MSTP instance, so that each instance blocks a different link.

If all devices have the same root bridge priority for the instance, MSTP selects the device

with the lowest MAC address to be the root bridge. Give the device a higher priority for

becoming the root bridge for a particular instance by assigning it a lower priority number,

or vice versa.

Examples To set the root bridge priority for MSTP instance 2 to be the highest (0), so that it will be

the root bridge for this instance when available, use the commands:

To reset the root bridge priority for instance 2 to the default (32768), use the commands:

Parameter Description

<msti-id> Specify the The MST instance ID in the range <1-15>.

<priority> Specify the root bridge priority for the device for the MSTI in the

range <0-61440>. Note that a lower priority number indicates a

greater likelihood of the device becoming the root bridge. The

priority values can be set only in increments of 4096. If you specify a

number that is not a multiple of 4096, it will be rounded down. The

default priority is 32768.

awplus# configure terminal

awplus(config)# spanning-tree mst configuration

awplus(config-mst)# instance 2 priority 0

awplus# configure terminal

awplus(config)# spanning-tree mst configuration

awplus(config-mst)# no instance 2 priority

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.9

Related Commands region (MSTP)

revision (MSTP)

show spanning-tree mst config

spanning-tree mst instance

spanning-tree mst instance priority

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.10 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

instance vlan (MSTP)

Use this command to create an MST Instance (MSTI), and associate the specified VLANs

with it. An MSTI is a spanning tree instance that exists within an MST region (MSTR). An

MSTR can contain up to 15 MSTIs.

When a VLAN is associated with an MSTI the member ports of the VLAN are automatically

configured to send and receive spanning-tree information for the associated MSTI. You

can disable this automatic configuration of member ports of the VLAN to the associated

MSTI by using a no spanning-tree mst instance command to remove the member port

from the MSTI.

Use the instance vlan command for MSTP only.

Use the no variant of this command to remove the specified VLANs from the MSTI.

Syntax instance <msti-id> vlan {<vid>|<vid-list>}

no instance <msti-id> vlan {<vid>|<vid-list>}

Mode MST Configuration

Usage The VLANs must be created before being associated with an MST instance (MSTI). If the

VLAN range is not specified, the MSTI will not be created.

This command removes the specified VLANs from the CIST and adds them to the specified

MSTI. If you use the no variant of this command to remove the VLAN from the MSTI, it

returns it to the CIST. To move a VLAN from one MSTI to another, you must first use the no

variant of this command to return it to the CIST.

Ports in these VLANs will remain in the control of the CIST until you associate the ports

with the MSTI using the spanning-tree mst instance command.

Example

Related Commands region (MSTP)

revision (MSTP)

show spanning-tree mst config

spanning-tree mst instance

vlan

Parameter Description

<msti-id> Specify the MST instance ID <1-15>.

<vid> Specify a VLAN identifier (VID) in the range <1-4094> to be

associated with the MSTI specified.

<vid-list> A hyphen-separated range or a comma-separated list of VLAN IDs

awplus# configure terminal

awplus(config)# spanning-tree mode mstp

awplus(config)# spanning-tree mst configuration

awplus(config-mst)# instance 2 vlan 30

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.11

region (MSTP)

Use this command to assign a name to the device’s MST Region. MST Instances (MSTI) of a

region form different spanning trees for different VLANs.

Use this command for MSTP only.

Use the no variant of this command to remove this region name and reset it to the default.

Syntax region <region-name>

no region

Default By default, the region name is My Name.

Mode MST Configuration

Usage The region name, the revision number, and the digest of the VLAN to MSTI configuration

table must be the same on all devices that are intended to be in the same MST region.

Example

Related Commands revision (MSTP)

show spanning-tree mst config

Parameter Description

<region-name>Specify the name of the region, up to 32 characters. Valid

characters are upper-case, lower-case, digits, underscore.

awplus# configure terminal

awplus(config)# spanning-tree mst configuration

awplus(config-mst)# region ATL

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.12 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

revision (MSTP)

Use this command to specify the MST revision number to be used in the configuration

identifier.

Use this command for MSTP only.

Syntax revision <revision-number>

Default The default of revision number is 0.

Mode MST Configuration

Usage The region name, the revision number, and the digest of the VLAN to MSTI configuration

table must be the same on all devices that are intended to be in the same MST region.

Example

Related Commands region (MSTP)

show spanning-tree mst config

instance vlan (MSTP)

Parameter Description

<revision-number><0-65535> Revision number.

awplus# configure terminal

awplus(config)# spanning-tree mst configuration

awplus(config-mst)# revision 25

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.13

show debugging mstp

Use this command to show the MSTP debugging options set.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show debugging mstp

Mode User Exec and Privileged Exec mode

Example To display the MSTP debugging options set, enter the command:

Output Figure 19-1: Example output from the show debugging mstp command

Related Commands debug mstp (RSTP and STP)

awplus# show debugging mstp

MSTP debugging status:

MSTP receiving packet debugging is on

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.14 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show spanning-tree

Use this command to display detailed spanning tree information on the specified port or

on all ports. Use this command for RSTP, MSTP or STP.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show spanning-tree [interface <port-list>]

Mode User Exec and Privileged Exec

Usage Note that any list of interfaces specified must not span any interfaces that are not

installed.

A topology change counter has been included for RSTP and MSTP. You can see the

topology change counter for RSTP by using the show spanning-tree command. You can

see the topology change counter for MSTP by using the show spanning-tree mst

instance command.

Example To display spanning tree information about port1.0.3, use the command:

Parameter Description

interface Display information about the following port only.

<port-list>The ports to display information about. A port-list can be:

■a switch port (e.g. port1.0.6) a static channel group (e.g. sa2)

or a dynamic (LACP) channel group (e.g. po2)

■a continuous range of ports separated by a hyphen,

e.g. port1.0.1-1.0.4, or sa1-2, or po1-2

■a comma-separated list of ports and port ranges,

e.g. port1.0.1,port1.0.4-1.0.6. Do not mix switch ports,

static channel groups, and dynamic (LACP) channel groups in the

same list

awplus# show spanning-tree interface port1.0.3

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.15

Output Figure 19-2: Example output from the show spanning-tree command

% 1: Bridge up - Spanning Tree Enabled

% 1: Root Path Cost 0 - Root Port 0 - Bridge Priority 32768

% 1: Forward Delay 15 - Hello Time 2 - Max Age 20

% 1: Root Id 80000000cd20f093

% 1: Bridge Id 80000000cd20f093

% 1: last topology change Sun Nov 20 12:24:24 1977

% 1: portfast bpdu-filter disabled

% 1: portfast bpdu-guard disabled

% 1: portfast errdisable timeout disabled

% 1: portfast errdisable timeout interval 300 sec

% port1.0.3: Port 5023 - Id 839f - Role Designated - State Forwarding

% port1.0.3: Designated Path Cost 0

% port1.0.3: Configured Path Cost 200000 - Add type Explicit ref count 1

% port1.0.3: Designated Port Id 839f - Priority 128 -

% port1.0.3: Root 80000000cd20f093

% port1.0.3: Designated Bridge 80000000cd20f093

% port1.0.3: Message Age 0 - Max Age 20

% port1.0.3: Hello Time 2 - Forward Delay 15

% port1.0.3: Forward Timer 0 - Msg Age Timer 0 - Hello Timer 1 - topo change

timer 0

% port1.0.3: forward-transitions 32

% port1.0.3: Version Rapid Spanning Tree Protocol - Received None - Send RSTP

% port1.0.3: No portfast configured - Current portfast off

% port1.0.3: portfast bpdu-guard default - Current portfast bpdu-guard off

% port1.0.3: portfast bpdu-filter default - Current portfast bpdu-filter off

% port1.0.3: no root guard configured - Current root guard off

% port1.0.3: Configured Link Type point-to-point - Current point-to-point

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.16 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Figure 19-3: Example output from the show spanning-tree command in RSTP mode

awplus#show spanning-tree

% 1: Bridge up - Spanning Tree Enabled

% 1: Root Path Cost 0 - Root Port 0 - Bridge Priority 32768

% 1: Forward Delay 15 - Hello Time 2 - Max Age 20

% 1: Root Id 80000000cd24ff2d

% 1: Bridge Id 80000000cd24ff2d

% 1: last topology change Thu Jul 26 02:06:26 2007

% 1: portfast bpdu-filter disabled

% 1: portfast bpdu-guard disabled

% 1: portfast errdisable timeout disabled

% 1: portfast errdisable timeout interval 300 sec

% port1.0.1: Port 5001 - Id 8389 - Role Disabled - State Discarding

% port1.0.1: Designated Path Cost 0

% port1.0.1: Configured Path Cost 20000000 - Add type Explicit ref count 1

% port1.0.1: Designated Port Id 8389 - Priority 128 -

% port1.0.1: Root 80000000cd24ff2d

% port1.0.1: Designated Bridge 80000000cd24ff2d

% port1.0.1: Message Age 0 - Max Age 20

% port1.0.1: Hello Time 2 - Forward Delay 15

% port1.0.1: Forward Timer 0 - Msg Age Timer 0 - Hello Timer 0 - topo change

timer 0

% port1.0.1: forward-transitions 0

% port1.0.1: Version Rapid Spanning Tree Protocol - Received None - Send STP

% port1.0.1: No portfast configured - Current portfast off

% port1.0.1: portfast bpdu-guard default - Current portfast bpdu-guard off

% port1.0.1: portfast bpdu-filter default - Current portfast bpdu-filter off

% port1.0.1: no root guard configured - Current root guard off

% port1.0.1: Configured Link Type point-to-point - Current shared

% port1.0.2: Port 5002 - Id 838a - Role Disabled - State Discarding

% port1.0.2: Designated Path Cost 0

% port1.0.2: Configured Path Cost 20000000 - Add type Explicit ref count 1

% port1.0.2: Designated Port Id 838a - Priority 128 -

% port1.0.2: Root 80000000cd24ff2d

% port1.0.2: Designated Bridge 80000000cd24ff2d

% port1.0.2: Message Age 0 - Max Age 20

% port1.0.2: Hello Time 2 - Forward Delay 15

% port1.0.2: Forward Timer 0 - Msg Age Timer 0 - Hello Timer 0 - topo change

timer 0

% port1.0.2: forward-transitions 0

% port1.0.2: Version Rapid Spanning Tree Protocol - Received None - Send STP

% port1.0.2: No portfast configured - Current portfast off

% port1.0.2: portfast bpdu-guard default - Current portfast bpdu-guard off

% port1.0.2: portfast bpdu-filter default - Current portfast bpdu-filter off

% port1.0.2: no root guard configured - Current root guard off

% port1.0.2: Configured Link Type point-to-point - Current shared

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.17

show spanning-tree brief

Use this command to display a summary of spanning tree status information on all ports.

Use this command for RSTP, MSTP or STP.

Syntax show spanning-tree brief

Mode User Exec and Privileged Exec

Usage Note that any list of interfaces specified must not span any interfaces that are not

installed.

A topology change counter has been included for RSTP and MSTP. You can see the

topology change counter for RSTP by using the show spanning-tree command. You can

see the topology change counter for MSTP by using the show spanning-tree mst

instance command.

Example To display a summary of spanning tree status information, use the command:

Output Figure 19-4: Example output from the show spanning-tree brief command

Related Commands show spanning-tree

Parameter Description

brief A brief summary of spanning tree information.

awplus# show spanning-tree brief

Default: Bridge up - Spanning Tree Enabled

Default: Root Path Cost 40000 - Root Port 4501 - Bridge Priority 32768

Default: Root Id 8000:0000cd250001

Default: Bridge Id 8000:0000cd296eb1

Port Designated Bridge Port Id Role State

sa1 8000:001577c9744b 8195 Rootport Forwarding

po1 8000:0000cd296eb1 81f9 Designated Forwarding

port1.0.1 8000:0000cd296eb1 8389 Disabled Discarding

port1.0.2 8000:0000cd296eb1 838a Disabled Discarding

port1.0.3 8000:0000cd296eb1 838b Disabled Discarding

port1.0.4 8000:0000cd296eb1 838c Disabled Discarding

port1.0.5 8000:0000cd296eb1 838d Disabled Discarding

port1.0.6 8000:0000cd296eb1 838e Disabled Discarding

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.18 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show spanning-tree mst

This command displays bridge-level information about the CIST and VLAN to MSTI

mappings.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show spanning-tree mst

Mode User Exec, Privileged Exec and Interface Configuration

Example To display bridge-level information about the CIST and VLAN to MSTI mappings, enter the

command:

Output Figure 19-5: Example output from the show spanning-tree mst command

Related Commands show spanning-tree mst interface

awplus# show spanning-tree mst

% 1: Bridge up - Spanning Tree Enabled

% 1: CIST Root Path Cost 0 - CIST Root Port 0 - CIST Bridge

Priority 32768

% 1: Forward Delay 15 - Hello Time 2 - Max Age 20 - Max-hops 20

% 1: CIST Root Id 8000000475e93ffe

% 1: CIST Reg Root Id 8000000475e93ffe

% 1: CST Bridge Id 8000000475e93ffe

% 1: portfast bpdu-filter disabled

% 1: portfast bpdu-guard disabled

% 1: portfast errdisable timeout disabled

% 1: portfast errdisable timeout interval 300 sec

% Instance VLAN

% 0: 1

% 2: 4

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.19

show spanning-tree mst config

Use this command to display MSTP configuration identifier for the device.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show spanning-tree mst config

Mode User Exec, Privileged Exec and Interface Configuration

Usage The region name, the revision number, and the digest of the VLAN to MSTI configuration

table must be the same on all devices that are intended to be in the same MST region.

Example To display MSTP configuration identifier information, enter the command:

Output Figure 19-6: Example output from the show spanning-tree mst config command

Related Commands instance vlan (MSTP)

region (MSTP)

revision (MSTP)

awplus# show spanning-tree mst config

awplus#show spanning-tree mst config

% MSTP Configuration Information:

%------------------------------------------------------

% Format Id : 0

% Name : My Name

% Revision Level : 0

% Digest : 0x80DEE46DA92A98CF21C603291B22880A

%------------------------------------------------------

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.20 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show spanning-tree mst detail

This command displays detailed information about each instance, and all interfaces

associated with that particular instance.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show spanning-tree mst detail

Mode User Exec, Privileged Exec and Interface Configuration

Example To display detailed information about each instance, and all interfaces associated with

them, enter the command:

Output Figure 19-7: Example output from the show spanning-tree mst detail command

awplus# show spanning-tree mst detail

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.21

% 1: Bridge up - Spanning Tree Enabled

% 1: CIST Root Path Cost 0 - CIST Root Port 0 - CIST Bridge Priority 32768

% 1: Forward Delay 15 - Hello Time 2 - Max Age 20 - Max-hops 20

% 1: CIST Root Id 80000000cd24ff2d

% 1: CIST Reg Root Id 80000000cd24ff2d

% 1: CIST Bridge Id 80000000cd24ff2d

% 1: portfast bpdu-filter disabled

% 1: portfast bpdu-guard disabled

% 1: portfast errdisable timeout disabled

% 1: portfast errdisable timeout interval 300 sec

% port1.0.1: Port 5001 - Id 8389 - Role Disabled - State Discarding

% port1.0.1: Designated External Path Cost 0 -Internal Path Cost 0

% port1.0.1: Configured Path Cost 20000000 - Add type Explicit ref count 1

% port1.0.1: Designated Port Id 8389 - CIST Priority 128 -

% port1.0.1: CIST Root 80000000cd24ff2d

% port1.0.1: Regional Root 80000000cd24ff2d

% port1.0.1: Designated Bridge 80000000cd24ff2d

% port1.0.1: Message Age 0 - Max Age 20

% port1.0.1: CIST Hello Time 2 - Forward Delay 15

% port1.0.1: CIST Forward Timer 0 - Msg Age Timer 0 - Hello Timer 0 - topo

change timer 0

% port1.0.2: forward-transitions 0

% port1.0.2: Version Multiple Spanning Tree Protocol - Received None - Send STP

% port1.0.2: No portfast configured - Current portfast off

% port1.0.2: portfast bpdu-guard default - Current portfast bpdu-guard off

% port1.0.2: portfast bpdu-filter default - Current portfast bpdu-filter off

% port1.0.2: no root guard configured - Current root guard off

% port1.0.2: Configured Link Type point-to-point - Current shared

% port1.0.3: Port 5003 - Id 838b - Role Disabled - State Discarding

% port1.0.3: Designated External Path Cost 0 -Internal Path Cost 0

% port1.0.3: Configured Path Cost 20000000 - Add type Explicit ref count 1

% port1.0.3: Designated Port Id 838b - CIST Priority 128 -

% port1.0.3: CIST Root 80000000cd24ff2d

% port1.0.3: Regional Root 80000000cd24ff2d

% port1.0.3: Designated Bridge 80000000cd24ff2d

% port1.0.3: Message Age 0 - Max Age 20

% port1.0.3: CIST Hello Time 2 - Forward Delay 15

% port1.0.3: CIST Forward Timer 0 - Msg Age Timer 0 - Hello Timer 0 - topo

change timer 0

% port1.0.3: forward-transitions 0

% port1.0.3: Version Multiple Spanning Tree Protocol - Received None - Send STP

% port1.0.3: No portfast configured - Current portfast off

% port1.0.3: portfast bpdu-guard default - Current portfast bpdu-guard off

% port1.0.3: portfast bpdu-filter default - Current portfast bpdu-filter off

% port1.0.3: no root guard configured - Current root guard off

% port1.0.3: Configured Link Type point-to-point - Current shared

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.22 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show spanning-tree mst detail interface

This command prints detailed information about the specified switch port, and the MST

instances associated with it.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show spanning-tree mst detail interface <port>

Mode User Exec, Privileged Exec and Interface Configuration

Example To display detailed information about port1.0.3 and the instances associated with it,

enter the command:

Parameter Description

<port>The port to display information about. The port may be a switch port

(e.g. port1.0.4), a static channel group (e.g. sa2), or a dynamic

(LACP) channel group (e.g. po2).

awplus# show spanning-tree mst detail interface port1.0.3

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.23

Output Figure 19-8: Example output from the show spanning-tree mst detail interface

command

% 1: Bridge up - Spanning Tree Enabled

% 1: CIST Root Path Cost 0 - CIST Root Port 0 - CIST Bridge Priority 32768

% 1: Forward Delay 15 - Hello Time 2 - Max Age 20 - Max-hops 20

% 1: CIST Root Id 80000000cd24ff2d

% 1: CIST Reg Root Id 80000000cd24ff2d

% 1: CIST Bridge Id 80000000cd24ff2d

% 1: portfast bpdu-filter disabled

% 1: portfast bpdu-guard disabled

% 1: portfast errdisable timeout disabled

% 1: portfast errdisable timeout interval 300 sec

% port1.0.2: Port 5002 - Id 838a - Role Disabled - State Discarding

% port1.0.2: Designated External Path Cost 0 -Internal Path Cost 0

% port1.0.2: Configured Path Cost 20000000 - Add type Explicit ref count 2

% port1.0.2: Designated Port Id 838a - CIST Priority 128 -

% port1.0.2: CIST Root 80000000cd24ff2d

% port1.0.2: Regional Root 80000000cd24ff2d

% port1.0.2: Designated Bridge 80000000cd24ff2d

% port1.0.2: Message Age 0 - Max Age 20

% port1.0.2: CIST Hello Time 2 - Forward Delay 15

% port1.0.2: CIST Forward Timer 0 - Msg Age Timer 0 - Hello Timer 0 - topo

change timer 0

% port1.0.2: forward-transitions 0

% port1.0.2: Version Multiple Spanning Tree Protocol - Received None - Send STP

% port1.0.2: No portfast configured - Current portfast off

% port1.0.2: portfast bpdu-guard default - Current portfast bpdu-guard off

% port1.0.2: portfast bpdu-filter default - Current portfast bpdu-filter off

% port1.0.2: no root guard configured - Current root guard off

% port1.0.2: Configured Link Type point-to-point - Current shared

% Instance 2: Vlans: 2

% 1: MSTI Root Path Cost 0 -MSTI Root Port 0 - MSTI Bridge Priority 32768

% 1: MSTI Root Id 80020000cd24ff2d

% 1: MSTI Bridge Id 80020000cd24ff2d

% port1.0.2: Port 5002 - Id 838a - Role Disabled - State Discarding

% port1.0.2: Designated Internal Path Cost 0 - Designated Port Id 838a

% port1.0.2: Configured Internal Path Cost 20000000

% port1.0.2: Configured CST External Path cost 20000000

% port1.0.2: CST Priority 128 - MSTI Priority 128

% port1.0.2: Designated Root 80020000cd24ff2d

% port1.0.2: Designated Bridge 80020000cd24ff2d

% port1.0.2: Message Age 0 - Max Age 0

% port1.0.2: Hello Time 2 - Forward Delay 15

% port1.0.2: Forward Timer 0 - Msg Age Timer 0 - Hello Timer 0

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.24 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show spanning-tree mst instance

This command displays detailed information for the specified instance, and all switch

ports associated with that instance.

A topology change counter has been included for RSTP and MSTP. You can see the

topology change counter for RSTP by using the show spanning-tree command. You can

see the topology change counter for MSTP by using the show spanning-tree mst

instance command.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show spanning-tree mst instance <instance>

Mode User Exec, Privileged Exec, and Interface Configuration

Usage To display detailed information for instance 2, and all switch ports associated with that

instance, use the command:

Output Figure 19-9: Example output from the show spanning-tree mst instance command

Parameter Description

<instance>Specify an MSTP instance in the range <1-15>.

awplus# show spanning-tree mst instance 2

% 1: MSTI Root Path Cost 0 - MSTI Root Port 0 - MSTI Bridge Priority 32768

% 1: MSTI Root Id 80020000cd24ff2d

% 1: MSTI Bridge Id 80020000cd24ff2d

% port1.0.2: Port 5002 - Id 838a - Role Disabled - State Discarding

% port1.0.2: Designated Internal Path Cost 0 - Designated Port Id 838a

% port1.0.2: Configured Internal Path Cost 20000000

% port1.0.2: Configured CST External Path cost 20000000

% port1.0.2: CST Priority 128 - MSTI Priority 128

% port1.0.2: Designated Root 80020000cd24ff2d

% port1.0.2: Designated Bridge 80020000cd24ff2d

% port1.0.2: Message Age 0 - Max Age 0

% port1.0.2: Hello Time 2 - Forward Delay 15

% port1.0.2: Forward Timer 0 - Msg Age Timer 0 - Hello Timer 0

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.25

show spanning-tree mst instance interface

This command displays detailed information for the specified MST (Multiple Spanning

Tree) instance, and the specified switch port associated with that MST instance.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show spanning-tree mst instance <instance> interface <port>

Mode User Exec, Privileged Exec, and Interface Configuration

Example To display detailed information for instance 2, interface port1.0.2, use the

command:

Output Figure 19-10: Example output from the show spanning-tree mst instance command

Parameter Description

<instance>Specify an MSTP instance in the range <1-15>.

<port>The port to display information about. The port may be a switch port

(e.g. port1.0.4), a static channel group (e.g. sa2), or a dynamic

(LACP) channel group (e.g. po2).

awplus# show spanning-tree mst instance 2 interface port1.0.2

% 1: MSTI Root Path Cost 0 - MSTI Root Port 0 - MSTI Bridge Priority 32768

% 1: MSTI Root Id 80020000cd24ff2d

% 1: MSTI Bridge Id 80020000cd24ff2d

% port1.0.2: Port 5002 - Id 838a - Role Disabled - State Discarding

% port1.0.2: Designated Internal Path Cost 0 - Designated Port Id 838a

% port1.0.2: Configured Internal Path Cost 20000000

% port1.0.2: Configured CST External Path cost 20000000

% port1.0.2: CST Priority 128 - MSTI Priority 128

% port1.0.2: Designated Root 80020000cd24ff2d

% port1.0.2: Designated Bridge 80020000cd24ff2d

% port1.0.2: Message Age 0 - Max Age 0

% port1.0.2: Hello Time 2 - Forward Delay 15

% port1.0.2: Forward Timer 0 - Msg Age Timer 0 - Hello Timer 0

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.26 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show spanning-tree mst interface

This command displays the number of instances created, and VLANs associated with it for

the specified switch port.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show spanning-tree mst interface <port>

Mode User Exec, Privileged Exec, and Interface Configuration

Example To display detailed information about each instance, and all interfaces associated with

them, for port1.0.4, use the command:

Output Figure 19-11: Example output from the show spanning-tree mst interface command

Parameter Description

<port>The port to display information about. The port may be a switch port

(e.g. port1.0.4), a static channel group (e.g. sa2), or a dynamic

(LACP) channel group (e.g. po2).

awplus# show spanning-tree mst interface port1.0.4

% 1: Bridge up - Spanning Tree Enabled

% 1: CIST Root Path Cost 0 - CIST Root Port 0 - CIST Bridge Priority 32768

% 1: Forward Delay 15 - Hello Time 2 - Max Age 20 - Max-hops 20

% 1: CIST Root Id 80000008c73a2b22

% 1: CIST Reg Root Id 80000008c73a2b22

% 1: CST Bridge Id 80000008c73a2b22

% 1: portfast bpdu-filter disabled

% 1: portfast bpdu-guard disabled

% 1: portfast errdisable timeout disabled

% 1: portfast errdisable timeout interval 1 sec

% Instance VLAN

% 0: 1

% 1: 2-3

% 2: 4-5

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.27

show spanning-tree mst detail interface

This command displays detailed information about the specified switch port, and the MST

instances associated with it.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show spanning-tree mst detail interface <port>

Mode User Exec, Privileged Exec and Interface Configuration

Example To display detailed information about port1.0.3 and the instances associated with it,

enter the command:

Parameter Description

<port>The port to display information about. The port may be a switch port

(e.g. port1.0.4), a static channel group (e.g. sa2), or a dynamic

(LACP) channel group (e.g. po2).

awplus# show spanning-tree mst detail interface port1.0.3

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.28 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Output Figure 19-12: Example output from the show spanning-tree mst detail interface

command

% 1: Bridge up - Spanning Tree Enabled

% 1: CIST Root Path Cost 0 - CIST Root Port 0 - CIST Bridge Priority 32768

% 1: Forward Delay 15 - Hello Time 2 - Max Age 20 - Max-hops 20

% 1: CIST Root Id 80000000cd24ff2d

% 1: CIST Reg Root Id 80000000cd24ff2d

% 1: CIST Bridge Id 80000000cd24ff2d

% 1: portfast bpdu-filter disabled

% 1: portfast bpdu-guard disabled

% 1: portfast errdisable timeout disabled

% 1: portfast errdisable timeout interval 300 sec

% port1.0.2: Port 5002 - Id 838a - Role Disabled - State Discarding

% port1.0.2: Designated External Path Cost 0 -Internal Path Cost 0

% port1.0.2: Configured Path Cost 20000000 - Add type Explicit ref count 2

% port1.0.2: Designated Port Id 838a - CIST Priority 128 -

% port1.0.2: CIST Root 80000000cd24ff2d

% port1.0.2: Regional Root 80000000cd24ff2d

% port1.0.2: Designated Bridge 80000000cd24ff2d

% port1.0.2: Message Age 0 - Max Age 20

% port1.0.2: CIST Hello Time 2 - Forward Delay 15

% port1.0.2: CIST Forward Timer 0 - Msg Age Timer 0 - Hello Timer 0 - topo

change timer 0

% port1.0.2: forward-transitions 0

% port1.0.2: Version Multiple Spanning Tree Protocol - Received None - Send STP

% port1.0.2: No portfast configured - Current portfast off

% port1.0.2: portfast bpdu-guard default - Current portfast bpdu-guard off

% port1.0.2: portfast bpdu-filter default - Current portfast bpdu-filter off

% port1.0.2: no root guard configured - Current root guard off

% port1.0.2: Configured Link Type point-to-point - Current shared

% Instance 2: Vlans: 2

% 1: MSTI Root Path Cost 0 -MSTI Root Port 0 - MSTI Bridge Priority 32768

% 1: MSTI Root Id 80020000cd24ff2d

% 1: MSTI Bridge Id 80020000cd24ff2d

% port1.0.2: Port 5002 - Id 838a - Role Disabled - State Discarding

% port1.0.2: Designated Internal Path Cost 0 - Designated Port Id 838a

% port1.0.2: Configured Internal Path Cost 20000000

% port1.0.2: Configured CST External Path cost 20000000

% port1.0.2: CST Priority 128 - MSTI Priority 128

% port1.0.2: Designated Root 80020000cd24ff2d

% port1.0.2: Designated Bridge 80020000cd24ff2d

% port1.0.2: Message Age 0 - Max Age 0

% port1.0.2: Hello Time 2 - Forward Delay 15

% port1.0.2: Forward Timer 0 - Msg Age Timer 0 - Hello Timer 0

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.29

show spanning-tree statistics

This command displays BPDU (Bridge Protocol Data Unit) statistics for all spanning-tree

instances, and all switch ports associated with all spanning-tree instances. For information

on output options, see “Controlling “show” Command Output” on page 1.35.

Syntax show spanning-tree statistics

Mode Privileged Exec

Usage To display BPDU statistics for all spanning-tree instances, and all switch ports associated

with all spanning-tree instances, use the command:

Output Figure 19-13: Example output from the show spanning-tree statistics command

awplus# show spanning-tree statistics

Port number = 915 Interface = port1.0.6

================================

% BPDU Related Parameters

% -----------------------

% Port Spanning Tree : Disable

% Spanning Tree Type : Rapid Spanning Tree Protocol

% Current Port State : Discarding

% Port ID : 8393

% Port Number : 393

% Path Cost : 20000000

% Message Age : 0

% Designated Root : ec:cd:6d:20:c0:ed

% Designated Cost : 0

% Designated Bridge : ec:cd:6d:20:c0:ed

% Designated Port Id : 8393

% Top Change Ack : FALSE

% Config Pending : FALSE

% PORT Based Information & Statistics

% -----------------------------------

% Config Bpdu's xmitted : 0

% Config Bpdu's received : 0

% TCN Bpdu's xmitted : 0

% TCN Bpdu's received : 0

% Forward Trans Count : 0

% STATUS of Port Timers

% ---------------------

% Hello Time Configured : 2

% Hello timer : INACTIVE

% Hello Time Value : 0

% Forward Delay Timer : INACTIVE

% Forward Delay Timer Value : 0

% Message Age Timer : INACTIVE

% Message Age Timer Value : 0

% Topology Change Timer : INACTIVE

% Topology Change Timer Value : 0

% Hold Timer : INACTIVE

% Hold Timer Value : 0

% Other Port-Specific Info

------------------------

% Max Age Transitions : 1

% Msg Age Expiry : 0

% Similar BPDUS Rcvd : 0

% Src Mac Count : 0

% Total Src Mac Rcvd : 0

% Next State : Learning

% Topology Change Time : 0

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.30 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show spanning-tree statistics instance

This command displays BPDU (Bridge Protocol Data Unit) statistics for the specified MST

(Multiple Spanning Tree) instance, and all switch ports associated with that MST instance.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show spanning-tree statistics instance <instance>

Mode Privileged Exec

Usage To display BPDU statistics information for MST instance 2, and all switch ports associated

with that MST instance, use the command:

Output Figure 19-14: Example output from the show spanning-tree statistics instance

command:

Related Commands show spanning-tree statistics

Parameter Description

<instance>Specify an MSTP instance in the range <1-15>.

awplus# show spanning-tree statistics instance 2

% % INST_PORT port1.0.3 Information & Statistics

% ----------------------------------------

% Config Bpdu's xmitted (port/inst) : (0/0)

% Config Bpdu's received (port/inst) : (0/0)

% TCN Bpdu's xmitted (port/inst) : (0/0)

% TCN Bpdu's received (port/inst) : (0/0)

% Message Age(port/Inst) : (0/0)

% port1.0.3: Forward Transitions : 0

% Next State : Learning

% Topology Change Time : 0

% INST_PORT port1.0.4 Information & Statistics

% ----------------------------------------

% Config Bpdu's xmitted (port/inst) : (0/0)

% Config Bpdu's received (port/inst) : (0/0)

% TCN Bpdu's xmitted (port/inst) : (0/0)

% TCN Bpdu's received (port/inst) : (0/0)

% Message Age(port/Inst) : (0/0)

% port1.0.4: Forward Transitions : 0

% Next State : Learning

% Topology Change Time : 0

% INST_PORT port1.0.5 Information & Statistics

% ----------------------------------------

% Config Bpdu's xmitted (port/inst) : (0/0)

% Config Bpdu's received (port/inst) : (0/0)

% TCN Bpdu's xmitted (port/inst) : (0/0)

% TCN Bpdu's received (port/inst) : (0/0)

% Message Age(port/Inst) : (0/0)

% port1.0.5: Forward Transitions : 0

% Next State : Learning

% Topology Change Time : 0%

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.31

show spanning-tree statistics instance interface

This command displays BPDU (Bridge Protocol Data Unit) statistics for the specified MST

(Multiple Spanning Tree) instance and the specified switch port associated with that MST

instance.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show spanning-tree statistics instance <instance> interface <port>

Mode Privileged Exec

Example To display BPDU statistics for MST instance 2, interface port1.0.2, use the

command:

Output Figure 19-15: Example output from the show spanning-tree statistics instance

interface command

Related Commands show spanning-tree statistics

Parameter Description

<instance>Specify an MSTP instance in the range <1-15>.

<port>The port to display information about. The port may be a switch port

(e.g. port1.0.4), a static channel group (e.g. sa2), or a dynamic

(LACP) channel group (e.g. po2).

awplus# show spanning-tree statistics instance 2 interface

port1.0.2

awplus#sh spanning-tree statistics interface port1.0.2 instance 1

Spanning Tree Enabled for Instance : 1

==================================

% INST_PORT port1.0.2 Information & Statistics

% ----------------------------------------

% Config Bpdu's xmitted (port/inst) : (0/0)

% Config Bpdu's received (port/inst) : (0/0)

% TCN Bpdu's xmitted (port/inst) : (0/0)

% TCN Bpdu's received (port/inst) : (0/0)

% Message Age(port/Inst) : (0/0)

% port1.0.2: Forward Transitions : 0

% Next State : Learning

% Topology Change Time : 0

% Other Inst/Vlan Information & Statistics

% ----------------------------------------

% Bridge Priority : 0

% Bridge Mac Address : ec:cd:6d:20:c0:ed

% Topology Change Initiator : 5023

% Last Topology Change Occured : Mon Aug 22 05:42:06 2011

% Topology Change : FALSE

% Topology Change Detected : FALSE

% Topology Change Count : 1

% Topology Change Last Recvd from : 00:00:00:00:00:00

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.32 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show spanning-tree statistics interface

This command displays BPDU (Bridge Protocol Data Unit) statistics for the specified switch

port, and all MST instances associated with that switch port.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show spanning-tree statistics interface <port>

Mode Privileged Exec

Example To display BPDU statistics about each MST instance for port1.0.4, use the command:

Parameter Description

<port>The port to display information about. The port may be a switch port

(e.g. port1.0.4), a static channel group (e.g. sa2), or a dynamic

(LACP) channel group (e.g. po2).

awplus# show spanning-tree statistics interface port1.0.4

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.33

Output Figure 19-16: Example output from the show spanning-tree statistics interface

command

Related Commands show spanning-tree statistics

awplus#show spanning-tree statistics interface port1.0.2

Port number = 906 Interface = port1.0.2

================================

% BPDU Related Parameters

% -----------------------

% Port Spanning Tree : Disable

% Spanning Tree Type : Multiple Spanning Tree Protocol

% Current Port State : Discarding

% Port ID : 838a

% Port Number : 38a

% Path Cost : 20000000

% Message Age : 0

% Designated Root : ec:cd:6d:20:c0:ed

% Designated Cost : 0

% Designated Bridge : ec:cd:6d:20:c0:ed

% Designated Port Id : 838a

% Top Change Ack : FALSE

% Config Pending : FALSE

% PORT Based Information & Statistics

% -----------------------------------

% Config Bpdu's xmitted : 0

% Config Bpdu's received : 0

% TCN Bpdu's xmitted : 0

% TCN Bpdu's received : 0

% Forward Trans Count : 0

% STATUS of Port Timers

% ---------------------

% Hello Time Configured : 2

% Hello timer : INACTIVE

% Hello Time Value : 0

% Forward Delay Timer : INACTIVE

% Forward Delay Timer Value : 0

% Message Age Timer : INACTIVE

% Message Age Timer Value : 0

% Topology Change Timer : INACTIVE

% Topology Change Timer Value : 0

% Hold Timer : INACTIVE

% Hold Timer Value : 0

% Other Port-Specific Info

------------------------

% Max Age Transitions : 1

% Msg Age Expiry : 0

% Similar BPDUS Rcvd : 0

% Src Mac Count : 0

% Total Src Mac Rcvd : 0

% Next State : Learning

% Topology Change Time : 0

% Other Bridge information & Statistics

--------------------------------------

% STP Multicast Address : 01:80:c2:00:00:00

% Bridge Priority : 32768

% Bridge Mac Address : ec:cd:6d:20:c0:ed

% Bridge Hello Time : 2

% Bridge Forward Delay : 15

% Topology Change Initiator : 5023

% Last Topology Change Occured : Mon Aug 22 05:41:20 2011

% Topology Change : FALSE

% Topology Change Detected : TRUE

% Topology Change Count : 1

% Topology Change Last Recvd from : 00:00:00:00:00:00

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.34 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

show spanning-tree vlan range-index

Use this command to display information about MST (Multiple Spanning Tree) instances

and the VLANs associated with them including the VLAN range-index value for the switch.

For information on output options, see “Controlling “show” Command Output” on

page 1.35.

Syntax show spanning-tree vlan range-index

Mode Privileged Exec

Example To display information about MST instances and the VLANs associated with them for the

switch, including the VLAN range-index value, use the following command:

Output Figure 19-17: Example output from the show spanning-tree vlan range-index

command

Related Commands show spanning-tree statistics

awplus# show spanning-tree vlan range-index

awplus#show spanning-tree vlan range-index

% MST Instance VLAN RangeIdx

% 1 1 1

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.35

spanning-tree autoedge (RSTP and MSTP)

Use this command to enable the autoedge feature on the port.

The autoedge feature allows the port to automatically detect that it is an edge port. If it

does not receive any BPDUs in the first three seconds after linkup, enabling, or entering

RSTP or MSTP mode, it sets itself to be an edgeport and enters the forwarding state.

Use this command for RSTP or MSTP.

Use the no variant of this command to disable this feature.

Syntax spanning-tree autoedge

no spanning-tree autoedge

Default Disabled

Mode Interface Configuration

Example

Related Commands spanning-tree edgeport (RSTP and MSTP)

awplus# configure terminal

awplus(config)# interface port1.0.3

awplus(config-if)# spanning-tree autoedge

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.36 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

spanning-tree bpdu

Use this command in Global Configuration mode to configure BPDU (Bridge Protocol Data

Unit) discarding or forwarding, with STP (Spanning Tree Protocol) disabled on the switch.

See the Usage note about disabling Spanning Tree before using this command, and using

this command to forward unsupported BPDUs unchanged for unsupported STP Protocols.

There is not a no variant for this command. Instead, apply the discard parameter to

reset it back to the default then re-enable STP with spanning-tree enable command.

Syntax spanning-tree bpdu {discard|forward|forward-untagged-vlan|

forward-vlan}

Default The discard parameter is enabled by default.

Mode Global Configuration

Usage You must first disable Spanning Tree with the no spanning-tree {mstp|rstp|stp} enable

command before you can use this command to then configure BPDU discarding or

forwarding.

This command enables the switch to forward unsupported BPDUs with an unsupported

Spanning Tree Protocol, such as proprietary STP protocols with unsupported BPDUs, by

forwarding BDPU (Bridge Protocol Data Unit) frames unchanged through the switch.

When you want to revert to default behavior on the switch, issue a spanning-tree bdpu

discard command and re-enable Spanning Tree with a spanning-tree enable command.

Examples To enable STP BPDU discard in Global Configuration mode with STP disabled, which

discards all ingress STP BPDU frames, enter the commands:

To enable STP BPDU forward in Global Configuration mode with STP disabled, which

Parameter Description

bpdu A port that has BPDU filtering enabled will not transmit any BPDUs

and will ignore any BPDUs received. This port type has one of the

following parameters (in Global Configuration mode):

discard Discards all ingress STP BPDU frames.

forward Forwards any ingress STP BPDU packets to all ports,

regardless of any VLAN membership.

forward-

untagged-

vlan

Forwards any ingress STP BPDU frames to all ports

that are untagged members of the ingress port’s

native VLAN.

forward-

vlan

Forwards any ingress STP BPDU frames to all ports

that are tagged members of the ingress port’s native

VLAN.

awplus# configure terminal

awplus(config)# no spanning-tree stp enable

awplus(config)# spanning-tree bpdu discard

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.37

forwards any ingress STP BPDU frames to all ports regardless of any VLAN membership,

enter the commands:

To enable STP BPDU forwarding for untagged frames in Global Configuration mode with

STP disabled, which forwards any ingress STP BPDU frames to all ports that are untagged

members of the ingress port’s native VLAN, enter the commands:

To enable STP BPDU forwarding for tagged frames in Global Configuration mode with STP

disabled, which forwards any ingress STP BPDU frames to all ports that are tagged

members of the ingress port’s native VLAN, enter the commands:

To reset STP BPDU back to the default discard parameter and re-enable STP on the

switch, enter the commands:

Related Commands show spanning-tree

spanning-tree enable

awplus# configure terminal

awplus(config)# no spanning-tree stp enable

awplus(config)# spanning-tree bpdu forward

awplus# configure terminal

awplus(config)# no spanning-tree stp enable

awplus(config)# spanning-tree bpdu forward-untagged-vlan

awplus# configure terminal

awplus(config)# no spanning-tree stp enable

awplus(config)# spanning-tree bpdu forward-vlan

awplus# configure terminal

awplus(config)# spanning-tree bpdu discard

awplus(config)# spanning-tree stp enable

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.38 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

spanning-tree cisco-interoperability (MSTP)

Use this command to enable/disable Cisco-interoperability for MSTP.

Use this command for MSTP only.

Syntax spanning-tree cisco-interoperability {enable|disable}

Default If this command is not used, Cisco interoperability is disabled.

Mode Global Configuration

Usage For compatibility with certain Cisco devices, all devices in the switched LAN running the

AlliedWare PlusTM Operating System must have Cisco-interoperability enabled. When the

AlliedWare PlusTM Operating System is interoperating with Cisco, the only criteria used to

classify a region are the region name and revision level. VLAN to instance mapping is not

used to classify regions when interoperating with Cisco.

Examples To enable Cisco interoperability on a Layer 2 switch:

To disable Cisco interoperability on a Layer 2 switch:

Parameter Description

enable Enable Cisco interoperability for MSTP.

disable Disable Cisco interoperability for MSTP.

awplus# configure terminal

awplus(config)# spanning-tree cisco-interoperability enable

awplus# configure terminal

awplus(config)# spanning-tree cisco-interoperability disable

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.39

spanning-tree edgeport (RSTP and MSTP)

Use this command to set a port as an edge-port.

Use this command for RSTP or MSTP.

This command has the same effect as the spanning-tree portfast (STP) command, but

the configuration displays differently in the output of some show commands.

Use the no variant of this command to set a port to its default state (not an edge-port).

Syntax spanning-tree edgeport

no spanning-tree edgeport

Default Not an edge port.

Mode Interface Configuration

Usage Use this command on a switch port connected to a LAN that has no other bridges

attached. If a BPDU is received on the port that indicates that another bridge is connected

to the LAN, then the port is no longer treated as an edge port.

Example

Related Commands spanning-tree autoedge (RSTP and MSTP)

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# spanning-tree edgeport

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.40 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

spanning-tree enable

Use this command in Global Configuration mode to enable the specified spanning tree

protocol for all switch ports. Note that this must be the spanning tree protocol that is

configured on the switch by the spanning-tree mode command.

Use the no variant of this command to disable the configured spanning tree protocol. This

places all switch ports in the forwarding state.

Syntax spanning-tree {mstp|rstp|stp} enable

no spanning-tree {mstp|rstp|stp} enable

Default RSTP is enabled by default for all switch ports.

Mode Global Configuration

Usage With no configuration, spanning tree is enabled, and the spanning tree mode is set to

RSTP. To change the mode, see spanning-tree mode command on page 19.51.

Examples To enable STP in Global Configuration mode, enter the below commands:

To disable STP in Global Configuration mode, enter the below commands:

To enable MSTP in Global Configuration mode, enter the below commands:

To disable MSTP in Global Configuration mode, enter the below commands:

To enable RSTP in Global Configuration mode, enter the below commands:

Parameter Description

mstp Enables or disables MSTP (Multiple Spanning Tree Protocol).

rstp Enables or disables RSTP (Rapid Spanning Tree Protocol).

stp Enables or disables STP (Spanning Tree Protocol).

awplus# configure terminal

awplus(config)# spanning-tree stp enable

awplus# configure terminal

awplus(config)# no spanning-tree stp enable

awplus# configure terminal

awplus(config)# spanning-tree mstp enable

awplus# configure terminal

awplus(config)# no spanning-tree mstp enable

awplus# configure terminal

awplus(config)# spanning-tree rstp enable

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.41

To disable RSTP in Global Configuration mode, enter the below commands:

Related Commands spanning-tree bpdu

spanning-tree mode

awplus# configure terminal

awplus(config)# no spanning-tree rstp enable

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.42 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

spanning-tree errdisable-timeout enable

Use this command to enable the errdisable-timeout facility, which sets a timeout for ports

that are disabled due to the BPDU guard feature.

Use this command for RSTP or MSTP.

Use the no variant of this command to disable the errdisable-timeout facility.

Syntax spanning-tree errdisable-timeout enable

no spanning-tree errdisable-timeout enable

Default By default, the errdisable-timeout is disabled.

Mode Global Configuration

Usage The BPDU guard feature shuts down the port on receiving a BPDU on a BPDU-guard

enabled port. This command associates a timer with the feature such that the port is re-

enabled without manual intervention after a set interval. This interval can be configured

by the user using the spanning-tree errdisable-timeout interval command.

Example

Related Commands show spanning-tree

spanning-tree errdisable-timeout interval

spanning-tree portfast bpdu-guard

awplus# configure terminal

awplus(config)# spanning-tree errdisable-timeout enable

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.43

spanning-tree errdisable-timeout interval

Use this command to specify the time interval after which a port is brought back up when

it has been disabled by the BPDU guard feature.

Use this command for RSTP or MSTP.

Syntax spanning-tree errdisable-timeout interval <10-1000000>

no spanning-tree errdisable-timeout interval

Default By default, the port is re-enabled after 300 seconds.

Mode Global Configuration

Example

Related Commands show spanning-tree

spanning-tree errdisable-timeout enable

spanning-tree portfast bpdu-guard

Parameter Description

<10-1000000> Specify the errdisable-timeout interval in seconds.

awplus# configure terminal

awplus(config)# spanning-tree errdisable-timeout interval 34

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.44 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

spanning-tree force-version

Use this command in Interface Configuration mode for a switch port interface only to

force the protocol version for the switch port. Use this command for RSTP or MSTP only.

Syntax spanning-tree force-version <version>

no spanning-tree force-version

Default By default, no version is forced for the port. The port is in the spanning tree mode

configured for the device, or a lower version if it automatically detects one.

Mode Interface Configuration mode for a switch port interface only.

Examples Set the value to enforce the spanning tree protocol (STP):

Set the default protocol version:

Related Commands show spanning-tree

Parameter Description

<version> <0-3> Version identifier.

0Forces the port to operate in STP mode.

1Not supported.

2Forces the port to operate in RSTP mode. If it receives STP

BPDUs, it can automatically revert to STP mode.

3Forces the port to operate in MSTP mode (this option is only

available if MSTP mode is configured). If it receives RSTP or

STP BPDUs, it can automatically revert to RSTP or STP mode.

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# spanning-tree force-version 0

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# no spanning-tree force-version

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.45

spanning-tree forward-time

Use this command to set the forward delay value. Use the no variant of this command to

reset the forward delay value to the default setting of 15 seconds.

The forward delay sets the time (in seconds) to control how fast a port changes its

spanning tree state when moving towards the forwarding state. If the mode is set to STP,

the value determines how long the port stays in each of the listening and learning states

which precede the forwarding state. If the mode is set to RSTP or MSTP, this value

determines the maximum time taken to transition from discarding to learning and from

learning to forwarding.

This value is used only when the switch is acting as the root bridge. Switches not acting as

the Root Bridge use a dynamic value for the forward delay set by the root bridge. The

forward delay, max-age, and hello time parameters are interrelated.

Syntax spanning-tree forward-time <forward-delay>

no spanning-tree forward-time

Default The default is 15 seconds.

Mode Global Configuration

Usage The allowable range for forward-time is 4-30 seconds.

The forward delay, max-age, and hello time parameters should be set according to the

following formula, as specified in IEEE Standard 802.1d:

2 x (forward delay - 1.0 seconds) >= max-age

max-age >= 2 x (hello time + 1.0 seconds)

Example

Related Commands show spanning-tree

spanning-tree forward-time <forward-delay>

spanning-tree hello-time <hello-time>

spanning-tree mode

Parameter Description

<forward-delay <4-30> The forwarding time delay in seconds.

awplus# configure terminal

awplus(config)# spanning-tree forward-time 6

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.46 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

spanning-tree guard root

Use this command in Interface Configuration mode for a switch port only to enable the

Root Guard feature for the switch port. The root guard feature disables reception of

superior BPDUs. You can use this command for RSTP, STP or MSTP.

Use the no variant of this command to disable the root guard feature for the port.

Syntax spanning-tree guard root

no spanning-tree guard root

Mode Interface Configuration mode for a switch port interface only.

Usage The Root Guard feature makes sure that the port on which it is enabled is a designated

port. If the Root Guard enabled port receives a superior BPDU, it goes to a Listening state

(for STP) or discarding state (for RSTP and MSTP).

Example

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# spanning-tree guard root

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.47

spanning-tree hello-time

Use this command to set the hello-time. This sets the time in seconds between the

transmission of switch spanning tree configuration information when the switch is the

Root Bridge of the spanning tree or is trying to become the Root Bridge.

Use this command for RSTP, STP or MSTP.

Use the no variant of this command to restore the default of the hello time.

Syntax spanning-tree hello-time <hello-time>

no spanning-tree hello-time

Default Default is 2 seconds.

Mode Global Configuration and Interface Configuration for switch ports.

Usage The allowable range of values is 1-10 seconds.

The forward delay, max-age, and hello time parameters should be set according to the

following formula, as specified in IEEE Standard 802.1d:

2 x (forward delay - 1.0 seconds) >= max-age

max-age >= 2 x (hello time + 1.0 seconds)

Example

Related Commands spanning-tree forward-time <forward-delay>

spanning-tree max-age <max-age>

show spanning-tree

Parameter Description

<hello-time><1-10> The hello BPDU interval in seconds.

awplus# configure terminal

awplus(config)# spanning-tree hello-time 3

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.48 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

spanning-tree link-type

Use this command in Interface Configuration mode for a switch port interface only to

enable or disable point-to-point or shared link types on the switch port.

Use this command for RSTP or MSTP only.

Use the no variant of this command to return the port to the default link type.

Syntax spanning-tree link-type {point-to-point|shared}

no spanning-tree link-type

Default The default link type is point-to-point.

Mode Interface Configuration mode for a switch port interface only.

Usage You may want to set link type to shared if the port is connected to a hub with multiple

switches connected to it.

Examples

Parameter Description

shared Disable rapid transition.

point-to-point Enable rapid transition.

awplus# configure terminal

awplus(config)# interface port1.0.3

awplus(config-if)# spanning-tree link-type point-to-point

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.49

spanning-tree max-age

Use this command to set the max-age. This sets the maximum age, in seconds, that

dynamic spanning tree configuration information is stored in the switch before it is

discarded.

Use this command for RSTP, STP or MSTP.

Use the no variant of this command to restore the default of max-age.

Syntax spanning-tree max-age <max-age>

no spanning-tree max-age

Default The default of spanning-tree max-age is 20 seconds.

Mode Global Configuration

Usage Max-age is the maximum time in seconds for which a message is considered valid.

Configure this value sufficiently high, so that a frame generated by the root bridge can be

propagated to the leaf nodes without exceeding the max-age.

The forward delay, max-age, and hello time parameters should be set according to the

following formula, as specified in IEEE Standard 802.1d:

2 x (forward delay - 1.0 seconds) >= max-age

max-age >= 2 x (hello time + 1.0 seconds)

Example

Related Commands show spanning-tree

spanning-tree forward-time <forward-delay>

spanning-tree hello-time <hello-time>

Parameter Description

<max-age><6-40> The maximum time, in seconds.

awplus# configure terminal

awplus(config)# spanning-tree max-age 12

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.50 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

spanning-tree max-hops (MSTP)

Use this command to specify the maximum allowed hops for a BPDU in an MST region.

This parameter is used by all the instances of the MST region.

Use the no variant of this command to restore the default.

Use this command for MSTP only.

Syntax spanning-tree max-hops <hop-count>

no spanning-tree max-hops <hop-count>

Default The default max-hops in a MST region is 20.

Mode Global Configuration

Usage Specifying the max hops for a BPDU prevents the messages from looping indefinitely in

the network. The hop count is decremented by each receiving port. When a switch

receives an MST BPDU that has a hop count of zero, it discards the BPDU.

Examples

Parameter Description

<hop-count> Specify the maximum hops the BPDU will be valid for in the range

<1-40>.

awplus# configure terminal

awplus(config)# spanning-tree max-hops 25

awplus# configure terminal

awplus(config)# no spanning-tree max-hops

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.51

spanning-tree mode

Use this command to change the spanning tree protocol mode on the switch. The

spanning tree protocol mode on the switch can be configured to either STP, RSTP or MSTP.

Syntax spanning-tree mode {stp|rstp|mstp}

Default The default spanning tree protocol mode on the switch is RSTP.

Mode Global Configuration

Usage With no configuration, the switch will have spanning tree enabled, and the spanning tree

mode will be set to RSTP. Use this command to change the spanning tree protocol mode

on the device. MSTP is VLAN aware, but RSTP and STP are not VLAN aware. To enable or

disable spanning tree operation, see the spanning-tree enable command on page 19.40.

Examples To change the spanning tree mode from the default of RSTP to MSTP, use the following

commands:

Related Commands spanning-tree enable

awplus# configure terminal

awplus(config)# spanning-tree mode mstp

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.52 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

spanning-tree mst configuration

Use this command to enter the MST Configuration mode to configure the Multiple

Spanning-Tree Protocol.

Syntax spanning-tree mst configuration

Mode Global Configuration

Examples The following example uses this command to enter MST Configuration mode. Note the

change in the command prompt.

awplus# configure terminal

awplus(config)# spanning-tree mst configuration

awplus(config-mst)#

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.53

spanning-tree mst instance

Use this command in Interface Configuration mode to assign a Multiple Spanning Tree

instance (MSTI) to a switch port or channel group.

Note that ports are automatically configured to send and receive spanning-tree

information for the associated MSTI when VLANs are assigned to MSTIs using the instance

vlan (MSTP) command.

Use the no variant of this command in Interface Configuration mode to remove the MSTI

from the specified switch port or channel group.

Syntax spanning-tree mst instance <instance-id>

no spanning-tree mst instance <instance-id>

Default A port automatically becomes a member of an MSTI when it is assigned to a VLAN.

Mode Interface Configuration mode for a switch port or channel group.

Usage You can disable automatic configuration of member ports of a VLAN to an associated MSTI

by using a no spanning-tree mst instance command to remove the member port from

the MSTI. Use the spanning-tree mst instance command to add a VLAN member port

back to the MSTI.

Examples

Related Commands instance vlan (MSTP)

spanning-tree mst instance path-cost

spanning-tree mst instance priority

spanning-tree mst instance restricted-role

spanning-tree mst instance restricted-tcn

Parameter Description

<instance-id><1-15> Specify the MST instance ID. The MST instance must have

already been created using the instance vlan (MSTP) command.

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# spanning-tree mst instance 3

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# no spanning-tree mst instance 3

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.54 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

spanning-tree mst instance path-cost

Use this command in Interface Configuration mode for a switch port interface only to set

the cost of a path associated with a switch port, for the specified MSTI (Multiple Spanning

Tree Instance) identifier.

This specifies the switch port’s contribution to the cost of a path to the MSTI regional root

via that port. This applies when the port is the root port for the MSTI.

Use the no variant of this command to restore the default cost value of the path.

Syntax spanning-tree mst instance <instance-id> path-cost <path-cost>

no spanning-tree mst instance <instance-id> path-cost

Default The default path cost values and the range of recommended path cost values depend on

the port speed, as shown in the following table from the IEEE 802.1q-2003 standard.

Mode Interface Configuration mode for a switch port interface only.

Usage Before you can use this command to set a path-cost in a VLAN configuration, you must

explicitly add an MST instance to a port using the spanning-tree instance

command.

Examples

Parameter Description

<instance-id> Specify the MSTI identifier in the range <1-15>.

<path-cost> Specify the cost of path in the range of <1-200000000>, where

a lower path-cost indicates a greater likelihood of the specific

interface becoming a root.

Port speed Default path cost Recommended path cost range

Less than 100 Kb/s

1Mbps

10Mbps

100 Mbps

1 Gbps

10 Gbps

100 Gbps

1Tbps

10 Tbps

200,000,000

20,000,000

2,000,000

200,000

20,000

2,000

200

20,000,000-200,000,000

2,000,000-20,000,000

200,000-2,000,000

20,000-200,000

2,000-20,000

200-2, 000

20-200

2-200

2-20

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# spanning-tree mst instance 3 path-cost 1000

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.55

Related Commands instance vlan (MSTP)

spanning-tree mst instance

spanning-tree mst instance priority

spanning-tree mst instance restricted-role

spanning-tree mst instance restricted-tcn

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# no spanning-tree mst instance 3 path-cost

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.56 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

spanning-tree mst instance priority

Use this command in Interface Configuration mode for a switch port interface only to set

the port priority for an MST instance (MSTI).

Use the no variant of this command to restore the default priority value (128).

Syntax spanning-tree mst instance <instance-id> priority <priority>

no spanning-tree mst instance <instance-id> [priority]

Default The default is 128.

Mode Interface Configuration mode for a switch port interface.

Usage This command sets the value of the priority field contained in the port identifier. The MST

algorithm uses the port priority when determining the root port for the switch in the MSTI.

The port with the lowest value is considered to have the highest priority and will be

chosen as root port over a port - equivalent in all other aspects - but with a higher priority

value.

Examples

Related Commands instance vlan (MSTP)

spanning-tree priority (port priority)

spanning-tree mst instance

spanning-tree mst instance path-cost

spanning-tree mst instance restricted-role

spanning-tree mst instance restricted-tcn

Parameter Description

<instance-id> Specify the MSTI identifier in the range <1-15>.

<priority>This must be a multiple of 16 and within the range <0-240>. A

lower priority indicates greater likelihood of the port becoming

the root port.

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# spanning-tree mst instance 3 priority 112

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# no spanning-tree mst instance 3 priority

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.57

spanning-tree mst instance restricted-role

Use this command in Interface Configuration mode for a switch port interface only to

enable the restricted role for an MSTI (Multiple Spanning Tree Instance) on a switch port.

Configuring the restricted role for an MSTI on a switch port prevents the switch port from

becoming the root port in a spanning tree topology.

Use the no variant of this command to disable the restricted role for an MSTI on a switch

port. Removing the restricted role for an MSTI on a switch port allows the switch port to

become the root port in a spanning tree topology.

Syntax spanning-tree mst instance <instance-id> restricted-role

no spanning-tree mst instance <instance-id> restricted-role

Default The restricted role for an MSTI instance on a switch port is disabled by default.

Mode Interface Configuration mode for a switch port interface only.

Usage The root port is the port providing the best path from the bridge to the root bridge. Use

this command to disable a port from becoming a root port. Use the no variant of this

command to enable a port to become a root port. See Spanning Tree Operation for root

port information.

Examples

Related Commands instance vlan (MSTP)

spanning-tree priority (port priority)

spanning-tree mst instance

spanning-tree mst instance path-cost

spanning-tree mst instance restricted-tcn

Parameter Description

<instance-id><1-15> Specify the MST instance ID. The MST instance must have

already been created using the instance vlan (MSTP) command.

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# spanning-tree mst instance 3

restricted-role

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# no spanning-tree mst instance 3

restricted-role

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.58 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

spanning-tree mst instance restricted-tcn

Use this command in Interface Configuration mode for a switch port interface only to set

the restricted TCN (Topology Change Notification) value to TRUE for the specified MSTI

(Multiple Spanning Tree Instance).

Use the no variant of this command in Interface Configuration mode to reset the restricted

TCN for the specified MSTI to the default value of FALSE.

Syntax spanning-tree mst instance <instance-id> restricted-tcn

no spanning-tree mst instance <instance-id> restricted-tcn

Default The default value for restricted TCNs is FALSE, as reset with the no variant of this

command.

Mode Interface Configuration mode for a switch port interface only.

Usage A Topology Change Notification (TCN) is a simple Bridge Protocol Data Unit (BPDU) that a

bridge sends out to its root port to signal a topology change. You can configure restricted

TCN between TRUE and FALSE values with this command and the no variant of this

command.

If you configure restricted TCN to TRUE with this command then this stops the switch port

from propagating received topology change notifications and topology changes to other

switch ports.

If you configure restricted TCN to FALSE with the no variant of this command then this

enables the switch port to propagate received topology change notifications and

topology changes to other switch ports.

Examples

Related Commands instance vlan (MSTP)

spanning-tree priority (port priority)

spanning-tree mst instance

spanning-tree mst instance path-cost

spanning-tree mst instance restricted-role

Parameter Description

<instance-id><1-15> Specify the MST instance ID. The MST instance must have

already been created using the instance vlan (MSTP) command.

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# spanning-tree mst instance 3 restricted-tcn

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# no spanning-tree mst instance 3

restricted-tcn

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.59

spanning-tree path-cost

Use this command in Interface Configuration mode for a switch port interface only to set

the cost of a path for the specified port. This value then combines with others along the

path to the root bridge in order to determine the total cost path value from the particular

port, to the root bridge. The lower the numeric value, the higher the priority of the path.

This applies when the port is the root port.

Use this command for RSTP, STP or MSTP. When MSTP mode is configured, this will apply

to the port’s path cost for the CIST.

Syntax spanning-tree path-cost <pathcost>

no spanning-tree path-cost

Default The default path cost values and the range of recommended path cost values depend on

the port speed, as shown in the following table from the IEEE 802.1q-2003 and IEEE

802.1d-2004 standards.

Mode Interface Configuration mode for switch port interface only.

Example

Parameter Description

<pathcost><1-200000000> The cost to be assigned to the port.

Port speed Default path cost Recommended path cost range

Less than 100 Kb/s

1Mbps

10Mbps

100 Mbps

1 Gbps

10 Gbps

100 Gbps

1Tbps

10 Tbps

200,000,000

20,000,000

2,000,000

200,000

20,000

2,000

200

20,000,000-200,000,000

2,000,000-20,000,000

200,000-2,000,000

20,000-200,000

2,000-20,000

200-2, 000

20-200

2-200

2-20

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# spanning-tree path-cost 123

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.60 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

spanning-tree portfast (STP)

Use this command in Interface Configuration mode for a switch port interface only to set a

port as an edge-port. The portfast feature enables a port to rapidly move to the

forwarding state, without having first to pass through the intermediate spanning tree

states. This command has the same effect as the spanning-tree edgeport (RSTP and

MSTP) command, but the configuration displays differently in the output of some show

commands.

You can obtain the same effect by running the spanning-tree edgeport (RSTP and

MSTP) command. However, the configuration output may display differently in some

show commands.

Use the no variant of this command to set a port to its default state (not an edge-port).

Syntax spanning-tree portfast

no spanning-tree portfast

Default Not an edge port.

Mode Interface Configuration mode for a switch port interface only.

Usage Portfast makes a port move from a blocking state to a forwarding state, bypassing both

listening and learning states. The portfast feature is meant to be used for ports connected

to end-user devices not switches. Enabling portfast on ports that are connected to a

workstation or server allows devices to connect to the network without waiting for

spanning-tree to converge.

For example, you may need hosts to receive a DHCP address quickly and waiting for STP to

converge would cause the DHCP request to time out. Ensure you do not use portfast on

any ports connected to another switch to avoid creating a spanning-tree loop on the

network.

Use this command on a switch port that connects to a LAN with no other bridges

attached. An edge port should never receive BPDUs. Therefore if an edge port receives a

BPDU, the portfast feature takes one of three actions.

■Cease to act as an edge port and pass BPDUs as a member of a spanning tree network

(spanning-tree portfast (STP) command disabled).

■Filter out the BPDUs and pass only the data and continue to act as a edge port

(spanning-tree portfast bpdu-filter command enabled).

■Block the port to all BPDUs and data (spanning-tree portfast bpdu-guard

command enabled).

Note You can run either of two additional parameters with this command. To

simplify the syntax these are documented as separate commands. See the

following additional portfast commands:

■spanning-tree portfast bpdu-filter command on page 19.62

■spanning-tree portfast bpdu-guard command on page 19.64.

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.61

Example

Related Commands spanning-tree edgeport (RSTP and MSTP)

show spanning-tree

spanning-tree portfast bpdu-filter

spanning-tree portfast bpdu-guard

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# spanning-tree portfast

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.62 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

spanning-tree portfast bpdu-filter

This command sets the bpdu-filter feature and applies a filter to any BPDUs (Bridge

Protocol Data Units) received. Enabling this feature ensures that configured ports will not

transmit any BPDUs and will ignore (filter out) any BPDUs received. BPDU Filter is not

enabled on a port by default.

Using the no variant of this command to turn off the bpdu-filter, but retain the port’s

status as an enabled port. If the port then receives a BPDU it will change its role from an

edge-port to a non edge-port.

Syntax (Global

Configuration)

spanning-tree portfast bpdu-filter

no spanning-tree portfast bpdu-filter

Syntax (Interface

Configuration)

spanning-tree portfast bpdu-filter {default|disable|enable}

no spanning-tree portfast bpdu-filter

Default BPDU Filter is not enabled on any ports by default.

Mode Global Configuration and Interface Configuration

Usage This command filters the BPDUs and passes only data to continue to act as an edge port.

Using this command in Global Configuration mode applies the portfast bpdu-filter feature

to all ports on the switch. Using it in Interface mode applies the feature to a specific port,

or range of ports.The command will operate in both RSTP and MSTP networks.

Use the show spanning-tree command to display status of the bpdu-filter parameter for

the switch ports.

Parameter Description

bpdu-filter A port that has bpdu-filter enabled will not transmit any BPDUs and

will ignore any BPDUs received. This port type has one of the

following parameters (in Interface Configuration mode):

default Takes the setting that has been configured for the whole

switch, i.e. the setting made from the Global

configuration mode.

disable Turns off BPDU filter.

enable Turns on BPDU filter.

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.63

Example To enable STP BPDU filtering in Global Configuration mode, enter the commands:

To enable STP BPDU filtering in Interface Configuration mode, enter the commands:

Related Commands spanning-tree edgeport (RSTP and MSTP)

show spanning-tree

spanning-tree portfast (STP)

spanning-tree portfast bpdu-guard

awplus# configure terminal

awplus(config)# spanning-tree portfast bpdu-filter

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# spanning-tree portfast bpdu-filter enable

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.64 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

spanning-tree portfast bpdu-guard

This command applies a BPDU (Bridge Protocol Data Unit) guard to the port. A port with

the bpdu-guard feature enabled will block all traffic (BPDUs and user data), if it starts

receiving BPDUs.

Use this command in Global Configuration mode to apply BPDU guard to all ports on the

switch. Use this command in Interface mode for an individual interface or a range of

interfaces specified. BPDU Guard is not enabled on a port by default.

Use the no variant of this command to disable the BPDU Guard feature on a switch in

Global Configuration mode or to disable the BPDU Guard feature on a port in Interface

mode.

Syntax (Global

Configuration)

spanning-tree portfast bpdu-guard

no spanning-tree portfast bpdu-guard

Syntax (Interface

Configuration)

spanning-tree portfast bpdu-guard {default|disable|enable}

no spanning-tree portfast bpdu-guard

Default BPDU Guard is not enabled on any ports by default.

Mode Global Configuration or Interface Configuration

Usage This command blocks the port(s) to all BPDUs and data when enabled. BPDU Guard is a

port-security feature that changes how a portfast-enabled port behaves if it receives a

BPDU. When bpdu-guard is set, then the port shuts down if it receives a BPDU. It does not

process the BPDU as it is considered suspicious. When bpdu-guard is not set, then the

port will negotiate spanning-tree with the device sending the BPDUs. By default, bpdu-

guard is not enabled on a port.

You can configure a port disabled by the bpdu-guard to re-enable itself after a specific

time interval. This interval is set with the spanning-tree errdisable-timeout interval

command on page 19.43. If you do not use the errdisable-timeout feature, then you will

need to manually re-enable the port by using the no shutdown command.

Parameter Description

bpdu-guard A port that has bpdu-guard turned on will enter the STP blocking state

if it receives a BPDU. This port type has one of the following

parameters (in Interface Configuration mode):

default Takes the setting that has been configured for the whole

switch, i.e. the setting made from the Global configuration

mode.

disable Turns off BPDU guard.

enable Turns on BPDU guard and will also set the port as an edge

port.

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.65

Use the show spanning-tree command on page 19.14 to display the switch and port

configurations for the BPDU Guard feature. It shows both the administratively configured

and currently running values of bpdu-guard.

Example To enable STP BPDU guard in Global Configuration mode, enter the below commands:

To enable STP BPDU guard in Interface Configuration mode, enter the below commands:

Related Commands spanning-tree edgeport (RSTP and MSTP)

show spanning-tree

spanning-tree portfast (STP)

spanning-tree portfast bpdu-filter

awplus# configure terminal

awplus(config)# spanning-tree portfast bpdu-guard

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# spanning-tree portfast bpdu-guard enable

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.66 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

spanning-tree priority (bridge priority)

Use this command to set the bridge priority for the switch. A lower priority value indicates

a greater likelihood of the switch becoming the root bridge.

Use this command for RSTP, STP or MSTP. When MSTP mode is configured, this will apply

to the CIST.

Use the no variant of this command to reset it to the default.

Syntax spanning-tree priority <priority>

no spanning-tree priority

Default The default priority is 32678.

Mode Global Configuration

Usage To force a particular switch to become the root bridge use a lower value than other

switches in the spanning tree.

Example

Related Commands spanning-tree mst instance priority

show spanning-tree

Parameter Description

<priority><0-61440> The bridge priority, which will be rounded to a multiple of

4096.

awplus# configure terminal

awplus(config)# spanning-tree priority 4096

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.67

spanning-tree priority (port priority)

Use this command in Interface Configuration mode for a switch port interface only to set

the port priority for port. A lower priority value indicates a greater likelihood of the port

becoming part of the active topology.

Use this command for RSTP, STP, or MSTP. When the device is in MSTP mode, this will apply

to the CIST.

Use the no variant of this command to reset it to the default.

Syntax spanning-tree priority <priority>

no spanning-tree priority

Default The default priority is 128.

Mode Interface Configuration mode for a switch port interface only.

Usage To force a port to be part of the active topology (for instance, become the root port or a

designated port) use a lower value than other ports on the device. (This behavior is

subject to network topology, and more significant factors, such as bridge ID.)

Example

Related Commands spanning-tree mst instance priority

spanning-tree priority (bridge priority)

show spanning-tree

Parameter Description

<priority><0-240>, in increments of 16. The port priority, which will be rounded

down to a multiple of 16.

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# spanning-tree priority 16

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.68 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

spanning-tree restricted-role

Use this command in Interface Configuration mode for a switch port interface only to

restrict the port from becoming a root port.

Use the no variant of this command to disable the restricted role functionality.

Syntax spanning-tree restricted-role

no spanning-tree restricted-role

Default The restricted role is disabled.

Mode Interface Configuration mode for a switch port interface only.

Example

spanning-tree restricted-tcn

Use this command in Interface Configuration mode for a switch port interface only to

prevent TCN (Topology Change Notification) BPDUs (Bridge Protocol Data Units) from

being sent on a port. If this command is enabled, after a topology change a bridge is

prevented from sending a TCN to its designated bridge.

Use the no variant of this command to disable the restricted TCN functionality.

Syntax spanning-tree restricted-tcn

no spanning-tree restricted-tcn

Default The restricted TCN is disabled.

Mode Interface Configuration mode for a switch port interface only.

Example

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# spanning-tree restricted-role

awplus# configure terminal

awplus(config)# interface port1.0.2

awplus(config-if)# spanning-tree restricted-tcn

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 19.69

spanning-tree transmit-holdcount

Use this command to set the maximum number of BPDU transmissions that are held back.

Use the no variant of this command to restore the default transmit hold-count value.

Syntax spanning-tree transmit-holdcount

no spanning-tree transmit-holdcount

Default Transmit hold-count default is 3.

Mode Global Configuration

Example

undebug mstp

This command applies the functionality of the no debug mstp (RSTP and STP)

command.

awplus# configure terminal

awplus(config)# spanning-tree transmit-holdcount

Spanning Tree Commands

Software Reference for GS900MX/MPX Series Switches

19.70 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 20.1

Chapter 20: Link Aggregation Introduction

and Configuration

Introduction and Overview ........................................................................................................... 20.2

Static and Dynamic (LACP) Link Aggregation ........................................................................ 20.3

Static Channel Groups.............................................................................................................. 20.3

Dynamic (LACP) Channel Groups......................................................................................... 20.3

Link Aggregation Control Protocol (LACP)....................................................................... 20.3

Configuring an LACP Channel Group ........................................................................................ 20.5

Minimal LACP Group Configuration ................................................................................... 20.8

Configuring a Static Channel Group .......................................................................................... 20.9

Link Aggregation Introduction and Configuration

Software Reference for GS900MX/MPX Series Switches

20.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Introduction and Overview

This chapter contains two sample Link Aggregation Control Protocol (LACP), or dynamic

channel group, configurations and a sample static channel group configuration.

Link aggregation is the process where two or more ports in an Ethernet switch are

combined together to operate as a single virtual port.

Link aggregation is a key component in resilient network design, since it increases the

available bandwidth between network devices and it provides continuity of connectivity if

one link is broken between network devices.

By aggregating two or more links together, you can increase the bandwidth between

neighboring devices since this is effectively additive, where two links give up to twice the

bandwidth of one link. Having more than one link to a neighboring device provides

connectivity if one of the links break, where a feature of this resiliency is the speed at

which link aggregation reacts to the change of link status in a matter of millisecond.

A link aggregation can only exist between a pair of neighboring switches, where the

switch ports that are aggregated on one switch cannot be connected to switch ports that

are not aggregated on the other switch. A switch can have multiple link aggregations to

different neighbors, even to the same neighbor if the network is loop protected.

To see details about the commands used to configure dynamic (LACP) and static Link

aggregation, see Chapter 21, Link Aggregation Commands.

For a brief overview of static and dynamic link aggregation (LACP), see Static and

Dynamic (LACP) Link Aggregation.

Link Aggregation Introduction and Configuration

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 20.3

Static and Dynamic (LACP) Link

Aggregation

Channels, either static or dynamic LACP, increase reliability by distributing the data path

over more than one physical link. Channels must be configured on both ends of a link or

network loops may result. Ports in a channel group need not be contiguous. A mirror port

cannot be a member of either a static or a dynamic channel group.

Aggregation

criteria

For individual links to be aggregated into a channel group they must:

■originate on the same device or stack

■terminate on the same device or stack

■be members of the same VLANs (vlan command on page 17.33)

■have the same data rate (speed command on page 15.43)

■share the same admin port key (assigned by using the channel-group command on

page 21.3 command)

■be operating in full duplex mode (duplex command on page 15.8)

The hardware must also be capable and have the capacity to handle the number of links

to be aggregated.

Static Channel Groups

A static channel group, also known as a static aggregator, enables a number of ports to be

manually configured to form a single logical connection of higher bandwidth. By using

static channel groups you increase channel reliability by distributing the data path over

more than one physical link. Static channel groups are best used in simpler environments,

usually where neighbor switches are close together, situated within the same rack, so that

you can easily ensure that the correct statically aggregated ports are connected together.

For a static channel group configuration example see the Configuring a Static Channel

Group section in this chapter. For details of static channel group commands, such as the

static-channel-group command, see Chapter 21, Link Aggregation Commands.

Dynamic (LACP) Channel Groups

A LACP channel group, also known as an etherchannel, a LACP aggregator, or a dynamic

channel group, enables a number of ports to be dynamically combined to form a single

higher bandwidth logical connection. LACP channel groups are best used for complex

environments, typically long-distance links, to detect failure between neighbor switches.

For LACP configuration examples see Configuring an LACP Channel Group and Minimal

LACP Group Configuration sections in this chapter. For details of LACP channel group

commands, such as the channel-group command, see Chapter 21, Link Aggregation

Commands.

Link Aggregation Control Protocol (LACP)

LACP is based on the IEEE Standard 802.3ad. It allows bundling of several physical ports to

form a single logical channel providing enhanced performance and resiliency. The

aggregated channel is viewed as a single link by each switch. Spanning tree also views the

channel as one interface and not as multiple interfaces. When there is a failure in one

physical port, the other ports stay up and there is no disruption.

Link Aggregation Introduction and Configuration

Software Reference for GS900MX/MPX Series Switches

20.4 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

LACP operates where systems are connected over multiple communications links. Once

LACP has been initially configured and enabled, it automatically aggregates the ports that

have been assigned to a channel group, if possible. LACP continues to monitor these

groups and dynamically adds or removes links to them as network changes occur.

LACP achieves this by determining:

■which ports are under LACP control (channel-group command on page 21.3)

■whether each port is in LACP active or LACP passive mode (channel-group command

on page 21.3)

■which system has the highest LACP priority (lacp system-priority command on page

21.8)

■the LACP priority of ports (lacp port-priority command on page 21.7)

■whether the LACP timeout is short or long (lacp timeout command on page 21.9)

Channel group

identification

In order to identify particular channel groups, each group is assigned a link aggregation

identifier called a lag ID. The lag ID comprises the following components for both the local

system (called the Actor) followed by their equivalent components for the remote system

(called the Partner):

■system identifier - the MAC address of the system

■port key - An identifier - created by the LACP software

■port priority - set by the lacp port-priority command on page 21.7

■port number - determined by the device connection

The lag ID can be displayed for each aggregated link by entering the show etherchannel

command on page 21.13.

Note AlliedWare PlusTM supports IEEE 802.3ad link aggregation and uses the Link

Aggregation Control Protocol (LACP). LACP does not interoperate with devices

that use Port Aggregation Protocol (PAgP).

Note Link aggregation does not necessarily achieve exact load balancing across the

links. The load sharing algorithm is designed to ensure that any given data flow

always goes down the same link. It also aims to spread data flows across the

links as evenly as possible.

Link aggregation hashes one or more of the source and destination MAC

address, IP address and UDP/TCP ports to select a link on which to send a

packet. So packet flow between a pair of hosts always takes the same link inside

the Link Aggregation Group (LAG). The net effect is that the bandwidth for a

given packet stream is restricted to the speed of one link in the LAG.

For example, for a 2 Gbps LAG that is a combination of two 1 Gbps ports, any

one flow of traffic can only ever reach a maximum throughput of 1 Gbps.

However, the hashing algorithm should spread the flows across the links so

that when many flows are operating, the full 2 Gbps can be utilized.

Link Aggregation Introduction and Configuration

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 20.5

Configuring an LACP Channel Group

The following example shows how to configure three links between two Allied Telesis

managed Layer 3 Switches. The three links are assigned the same administrative key (1),

so that they aggregate to form a single channel (1). They are viewed by the STP as one

interface.

Table 20-1: Switch 1 configuration

awplus#

configure terminal Enter the Global Configuration mode.

awplus(config)#

lacp system-priority 20000 Set the system priority of this switch. This

priority is used to determine which switch in

the system is responsible for resolving

conflicts in the choice of aggregation groups.

A lower numerical value has a higher priority.

Switch 1 has a higher priority than Switch 2 in

this configuration.

awplus(config)#

interface port1.0.1 Enter the Interface Configuration mode to

configure port 1.0.1.

awplus(config-if)#

channel-group 1 mode active Add this interface to a channel group 1 and

enable link aggregation so that it may be

selected for aggregation by the local system.

awplus(config-if)#

exit Exit the Interface Configuration mode and

return to the Global Configure mode.

awplus(config)#

interface port1.0.2 Enter the Interface Configuration mode to

configure port 1.0.2.

awplus(config-if)#

channel-group 1 mode active Add this interface to a channel group 1 and

enable link aggregation so that it may be

selected for aggregation by the local system.

lacp_1

port1.0.1

Switch 2

Switch 1

port1.0.2

port1.0.3

port1.0.4

port1.0.2

Aggregated

Link

Link Aggregation Introduction and Configuration

Software Reference for GS900MX/MPX Series Switches

20.6 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

awplus(config-if)#

exit Exit the Interface Configuration mode and

return to the Global Configure mode.

awplus(config)#

interface port1.0.3 Enter the Interface Configuration mode to

configure port 1.0.3.

awplus(config-if)#

channel-group 1 mode active Add this interface to a channel group 1 and

enable link aggregation so that it may be

selected for aggregation by the local system.

awplus(config-if)#

interface po1 Select the dynamic aggregator logical

interface created for channel-group 1 named

po1.

Table 20-2: Switch 2 configuration

awplus#

configure terminal Enter the Global Configuration mode.

awplus(config)#

lacp system-priority 3000 Set the system priority of this switch. This

priority is used to determine which switch in

the system is responsible for resolving

conflicts in the choice of aggregation groups.

A lower numerical value has a higher priority.

Switch 2 has a lower priority than Switch 1 in

this configuration.

awplus(config)#

interface port1.0.2 Enter the Interface Configuration mode to

configure port 1.0.2.

awplus(config-if)#

channel-group 1 mode active Add this interface to a channel group 1 and

enable link aggregation so that it may be

selected for aggregation by the local system.

awplus(config-if)#

exit Exit the Interface mode and return to the

Configure mode.

awplus(config)#

interface port1.0.3 Enter the Interface mode to configure port

1.0.3.

awplus(config-if)#

channel-group 1 mode active Add this interface to a channel group 1 and

enable link aggregation so that it may be

selected for aggregation by the local system.

Table 20-1: Switch 1 configuration (cont.)

Link Aggregation Introduction and Configuration

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 20.7

Commands used

lacp system-priority

channel-group

Validation commands

show lacp sys-id

show port etherchannel

show etherchannel

show etherchannel detail

awplus(config-if)#

exit Exit the Interface Configuration mode and

return to the Global Configuration mode.

awplus(config)#

interface port1.0.4 Enter the Interface Configuration mode to

configure port 1.0.4.

awplus(config-if)#

channel-group 1 mode active Add this interface to a channel group 1 and

enable link aggregation so that it may be

selected for aggregation by the local system.

awplus(config-if)#

interface po1 Select the dynamic aggregator logical

interface created for channel-group 1 named

po1.

Table 20-2: Switch 2 configuration

Link Aggregation Introduction and Configuration

Software Reference for GS900MX/MPX Series Switches

20.8 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Minimal LACP Group Configuration

For details of LACP channel group commands, see Chapter 21, Link Aggregation

Commands.

The following minimal LACP group configuration example creates LACP channel group 2

and enables link aggregation on switch ports 1.0.1 and 1.0.2 within this channel

group. Note that all aggregated ports must belong to the same VLAN.

Commands used

channel-group

Validation commands

show static-channel-group

awplus#

configure terminal Enter Global Configuration mode.

awplus(config)#

interface port1.0.1-port1.0.2 Enter the Interface Configuration mode for

the switch ports to aggregate into the

channel group.

awplus(config-if)#

channel-group 2 mode active Assign the switch ports to channel group 2

in active mode. This creates the channel

group.

awplus(config-if)#

interface po2 Select the dynamic aggregator logical

interface created for channel-group 2

named po2.

Link Aggregation Introduction and Configuration

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 20.9

Configuring a Static Channel Group

For details of LACP channel group commands, see Chapter 21, Link Aggregation

Commands.

The following example creates a static channel group and adds switch ports 1.0.1 and

1.0.2.

Commands used

static-channel-group

Validation commands

show static-channel-group

awplus#

configure terminal Enter the Global Configuration mode.

awplus(config)#

interface port1.0.1 Enter the Interface Configuration mode to configure

port 1.0.1.

awplus(config-if)#

static-channel-group 2 Add port 1.0.1 to static-channel-group 2.

awplus(config-if)#

exit Exit the Interface Configuration mode and return to

the Global Configuration mode.

awplus(config)#

interface port1.0.2 Enter the Interface Configuration mode to configure

port 1.0.2.

awplus(config-if)#

static-channel-group 2 Add port 1.0.2 to static-channel-group 2.

awplus(config-if)#

interface sa2 Select the static aggregator logical interface created

for static-channel-group 2 named sa2.

Link Aggregation Introduction and Configuration

Software Reference for GS900MX/MPX Series Switches

20.10 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Software Reference for GS900MX/MPX Series Switches

C613-50065-01 REV B AlliedWare PlusTM Operating System - Version 5.4.4E-1.x 21.1

Chapter 21: Link Aggregation Commands

Introduction ........................................................................................................................................ 21.2

Command List .................................................................................................................................... 21.3

channel-group.................................................................................................................................... 21.3

clear lacp counters............................................................................................................................ 21.5

debug lacp........................................................................................................................................... 21.6

lacp port-priority ............................................................................................................................... 21.7

lacp system-priority.......................................................................................................................... 21.8

lacp timeout........................................................................................................................................ 21.9

show debugging lacp....................................................................................................................21.11

show diagnostic channel-group................................................................................................21.12

show etherchannel.........................................................................................................................21.13

show etherchannel detail ............................................................................................................21.14

show etherchannel summary .....................................................................................................21.15

show lacp sys-id...............................................................................................................................21.16

show lacp-counter..........................................................................................................................21.17

show port etherchannel ...............................................................................................................21.18

show static-channel-group .........................................................................................................21.19

static-channel-group .....................................................................................................................21.20

undebug lacp ...................................................................................................................................21.22

Link Aggregation Commands

Software Reference for GS900MX/MPX Series Switches

21.2 AlliedWare PlusTM Operating System - Version 5.4.4E-1.x C613-50065-01 REV B

Introduction

This chapter provides an alphabetical reference of commands used to configure a static

channel group (static aggregator) and dynamic channel group (LACP channel group,

etherchannel or LACP aggregator). Link aggregation is also sometimes referred to as

channeling.

For a description of static and dynamic link aggregation (LACP), see “Configuring an

LACP Channel Group” on page 20.5. For an LACP configuration example, see

Chapter 20, Link Aggregation Introduction and Configuration.