Installation and Configuration Guide
for
ADLink Technology
ATCA-31xx
AdvancedTCA Hub Board
Revision 1.2
May 10, 2006
Revision History
Revision Description Date 1.0 Initial Draft February 1, 2006 1.1 Added Linux information May 5, 2006 1.2 Updated CLI commands May 10, 2006
Contents
Linux Startup and configuration (7)
Serial Console Port (7)
Serial Cable Connection (7)
Power Up Sequence (7)
Default Linux LOGIN (8)
Configuration Directory (8)
RAM Disk Storage (8)
User Flash Storage (8)
Slot Address (8)
Flash Update Procedure (9)
Current Flash (9)
Alternate Flash (9)
Configuration Option Switch (10)
Ethernet Maintenance Port Configuration (10)
DHCP Server (10)
Command Line Interface (11)
General (11)
Command Hierarchy (11)
Help Utility (12)
Example (12)
Entering Commands (13)
Scripting and Non-Interactive Mode (13)
Terminology (13)
Base Switch Port Mapping for CLI (14)
Fabric Switch Port Mapping for CLI (15)
Command Overview (16)
Command Description (17)
Configuration Files (18)
System Commands (18)
System Configuration (18)
System Restore Default (18)
System/IP Commands (18)
System IP Configuration (19)
System IP Setup (19)
System IP Mode (19)
IP Commands (19)
IP Configuration (19)
IP Address Add (20)
IP Address Delete (20)
IP Address Lookup (20)
IP Route Add (21)
IP Route Delete (21)
IP Route Lookup (21)
IP Statistics (22)
Port Commands (22)
Port Configuration (22)
Port Map (22)
Port Mode (23)
Port Flow Control (23)
Port State (23)
Port Statistics (24)
Port MaxFrame (24)
Port VeriPHY (24)
MAC Table Commands (25)
MAC Configuration (25)
MAC Add (25)
MAC Delete (25)
MAC Lookup (26)
MAC Dump (26)
MAC Port (26)
MAC Flush (27)
MAC Age Time (27)
VLAN Commands (28)
VLAN Configuration (28)
VLAN State (29)
VLAN Add (29)
VLAN Delete (29)
VLAN Lookup (29)
VLAN Aware (30)
VLAN PVID (30)
VLAN Frame Type (30)
VLAN IngressFilter (31)
PVLAN Commands (31)
PVLAN Configuration (31)
PVLAN Add (31)
PVLAN Delete (32)
PVLAN Lookup (32)
Aggregation/Trunking Commands (32)
Aggregation Configuration (32)
Aggregation Add (32)
Aggregation Delete (33)
Aggregation Lookup (33)
Aggregation Mode (33)
LACP Commands (34)
LACP Configuration (34)
LACP System Priority (34)
LACP System ID (34)
LACP Mode (34)
LACP Key (35)
LACP Port Priority (35)
LACP Transmit Mode (35)
LACP Role (35)
LACP Status (36)
LACP Statistics (36)
RSTP Commands (36)
RSTP Configuration (36)
RSTP Sysprio (36)
RSTP Maxage (37)
RSTP Hello (37)
RSTP Fwd (37)
RSTP Version (37)
RSTP Mode (38)
RSTP Pathcost (38)
RSTP Portprio (38)
RSTP P2P (39)
RSTP Edge (39)
RSTP Mcheck (39)
RSTP Status (39)
RSTP Statistics (40)
DOT1X Commands (40)
DOT1X Configuration (40)
DOT1X State (40)
DOT1X Server (40)
DOT1X UDP (41)
DOT1X Secret (41)
DOT1X Statistics (41)
DOT1X Reauthenticate (41)
DOT1X Parameters (42)
QoS Commands (42)
QoS Configuration (42)
QoS Classes (42)
QoS Mode (42)
QoS Default (43)
QoS Tag Priority (43)
QoS ToS Precedence (43)
QoS DiffServ (44)
QoS L4 Match (44)
QoS L4 Add (44)
QoS L4 Delete (44)
QoS L4 List (45)
QoS L4 User Priority (45)
QoS Shaper (45)
QoS Shaper Queue (46)
QoS Policer (46)
QoS Storm Control (46)
Mirror Commands (47)
Mirror Configuration (47)
Mirror Port (47)
Mirror Source (47)
Mirror Destination (47)
Debug Commands (48)
Debug Register Read (48)
Debug Register Write (48)
Debug PHY Read (48)
Debug PHY Write (49)
Debug MMD Read (49)
Debug MMD Write (49)
Debug Option (50)
Debug Suspend (50)
Debug Resume (50)
Debug Terminate (50)
Debug CPU Statistics (51)
Debug CPU Tx (51)
Debug STP (51)
Debug MSTP Instance (51)
Debug MSTP State (52)
Debug IPMC Add (52)
Debug IPMC Delete (52)
Debug VRRP Base (52)
Debug VRRP Add (53)
Debug VRRP Delete (53)
Examples (53)
VLAN configuration (53)
Default Configuration (54)
Linux Startup and configuration
Serial Console Port
The front panel serial maintenance port is used for Console access and board configuration.
Serial Cable Connection
A serial cable is connected from a terminal or computers serial port (COM 1 or COM 2)
Before powering up the board, run a terminal emulation program such as HyperTerminal for Microsoft* Windows systems or minicom for Linux systems, and configure it for VT100 emulation with the following communications settings.
1.No Flow Control
2.No Parity
3.8 Data Bits
4. 1 Sop Bit
5.115200 Baud
Power Up Sequence
Default Linux LOGIN
After the card has successfully booted Linux and the ACTV and HLTY LEDs are on solid the following is displayed on the Console.
ATCA-3100 (Linux armv5tel 2.6.13-iop1)
atca3100-sw2 login:
Login as “root” with no password and the following prompt will be displayed.
[root@atca3100-sw2 ~]#
Linux is now fully booted and running.
Configuration Directory
All configuration information is stored in the /etc directory. This area is non-volatile and stored in the system Flash.
RAM Disk Storage
Most of the directories after boot-up reside in RAM. The /tmp directory is provided for the user for volatile temporary storage of files and data. This directory will allow up to 80 MB of storage.
User Flash Storage
The user has the option of creating a Flash disk for storage of programs, utilities and data. The Flash disk must first be created and initialized using the following command.
flash_eraseall -j /dev/mtd5
After the partition is created the disk must be mounted using the following command.
mount -t jffs2 -o rw,noatime /dev/mtdblock5 /mnt
This can be done after every boot, or it can be put into the start-up script.
The Flash directory is now available in the /mnt directory and is about 28 MB is size.
Slot Address
The current Slot Address is available in a file in the /etc directory.
/etc/ipmb-address
The file contains the current the current IPMB address in hex. The actual slot address can be calculated by subtracting 40h from the IPMB address value.
Flash Update Procedure
This section describes how to update the flash with a new image. Both the currently booted flash image as well as the Alternate Boot Flash image must be updated.
Current Flash
Using FTP or TFTP upload the Flash image file to the /tmp directory. Note that the /tmp directory must have at least 64 MB of free space.
Example:
cd /tmp
tftp -g -r atca3100_flash_vxxx.bin
Program the image into flash using the following command:
flashcp -v atca3110_flash_vxxx.bin /dev/mtd7
Note: This will take some time so avoid resetting or powering down the system during the operation or the flash will be corrupted.
After the flash is programmed it is a good idea to reboot the system to ensure that the flash image is good.
Alternate Flash
The procedure to update the alternate Flash is identical except for the partition being programmed (mtd15).
Using FTP or TFTP upload the Flash image file to the /tmp directory. Note that the /tmp directory must have at least 64 MB of free space.
Example:
cd /tmp
tftp -g -r atca3100_flash_vxxx.bin
Program the image into flash using the following command.
flashcp -v atca3110_flash_vxxx.bin /dev/mtd15
Note: This will take some time so avoid resetting or powering down the system during the operation or the flash will be corrupted.
Configuration Option Switch
The Configuration Option Switch allows the user to store up to 16 different Switch configurations.
When Linux boots, the Option Switch (SW3) is read and the corresponding configuration file is loaded. If the configuration file is not present it is created and the Base and Fabric Switch configuration is set to default values.
The configuration files contain only Base and Fabric configuration parameters. Maintenance port configurations are not affected.
Configuration files are stored in Flash in the /etc/switch/base and /etc/switch/fabric directories.
Switch Selections 4 3 2 1 Options Base Configuration
Files
Fabric Configuration
Files
0 0 0 0 Option 1 (Default) sw-base-01.conf sw-fabric-01.conf
0 0 0 1 Option 2 sw-base-02.conf sw-fabric-02.conf
0 0 1 0 Option 3 sw-base-03.conf sw-fabric-03.conf
0 0 1 1 Option 4 sw-base-04.conf sw-fabric-04.conf
0 1 0 0 Option 5 sw-base-05.conf sw-fabric-05.conf
0 1 0 1 Option 6 sw-base-06.conf sw-fabric-06.conf
0 1 1 0 Option 7 sw-base-07.conf sw-fabric-07.conf
0 1 1 1 Option 8 sw-base-08.conf sw-fabric-08.conf
1 0 0 0 Option 9 sw-base-09.conf sw-fabric-09.conf
1 0 0 1 Option 10 sw-base-10.conf sw-fabric-10.conf
1 0 1 0 Option 11 sw-base-11.conf sw-fabric -11.conf
1 0 1 1 Option 1
2 sw-base-12.conf sw-fabric-12.conf
1 1 0 0 Option 13 sw-base-13.conf sw-fabric-13.conf
1 1 0 1 Option 14 sw-base-14.conf sw-fabric-14.conf
1 1 1 0 Option 15 sw-base-15.conf sw-fabric-15.conf
1 1 1 1 Option 16 sw-base-16.conf sw-fabric-16.conf Note: Configuration files are binary data files, not text files. They cannot be edited. Ethernet Maintenance Port Configuration
By default the external Ethernet maintenance port (eth0)and the CPU interface port (eth1) are configured as DHCP clients. The “ifconfig” utility can be used to re-configure these ports.
DHCP Server
A DHCP server can be set up to service both the External Ethernet and the CPU interface ports.
Command Line Interface
General
The CLI application may be started by running the”cli-base“ utility for the Base interface and “cli-fabric” for the Fabric interface. All examples shown, that utilize the “cli-base” program, may be used for the Fabric interface by substituting “cli-fabric” Command Hierarchy
The CLI is hierarchical with two levels: a top level and a group level. The group level consists of the following groups:
?System
?IP
?Port
?MAC
?VLAN
?PVLAN
?Aggregation
?LACP
?Rstp
?Dot1x
?QoS
?Mirror
?Debug
At the top level you may enter a command by giving the full command string, including group, or you may change context into a group by entering the name of the group. At the group level you may enter commands for the particular group you have chosen without specifying the group name or you may return to the top level by entering the “up” command.
The current level and group is indicated by the prompt. If you are at the top level, the prompt will be:
>
If you are at a group level, the prompt will display the actual group, e.g.
System>
At the group level you also have the option of using a leading slash (/) key to refer to a context relative to the top level. e.g. you may be in the system group and enter a
/port configuration command or change context into the port group by entering
/port.
Help Utility
You may display help from any level by entering ‘?’ or typing “help”. The help info depends on the context:
?At the top level, a list of command groups is displayed.
?At the group level, a list of the command syntaxes for the current group is displayed.
?If the help command is issued for a specific command, the command syntax and a description of the command are shown.
Example
The command hierarchy and the help utility are demonstrated in the following example: > ?
Commands at top level:
------
System - System commands
IP - IP commands
Port - Port commands
MAC - MAC table commands
VLAN - VLAN commands
PVLAN - PVLAN commands
Aggr - Aggregation/Trunking commands
Lacp - 802.3ad LACP Link Aggregation commands
Rstp - 802.1w RSTP Rapid Spanning Tree commands
Dot1x - 802.1X Port Based Access-Control commands
QoS - QoS commands
Mirror - Mirror commands
Debug - Debug commands
> system
system> ?
Commands at System level:
------
Configuration [all | check] - List configuration details
Restore Default [keepIP] - Revert all settings to default
IP - IP settings
system> restore default ?
Syntax:
System Restore Default [keepIP]
Description:
Restore factory default configuration.
[keepIP]: Preserve IP configuration (default: Not preserved).
system>
Entering Commands
?Commands are not case-sensitive.
?You may use the horizontal arrow-keys ←and →to move the cursor within the command you are entering.
?You may use the backspace key (provided you are using a terminal that sends the BS (8) character when the backspace key is pressed) to delete chars from the
command you are entering.
?You may use the vertical arrow-keys ↑ and ↓ to scroll through a command history buffer of the latest 20 commands issued.
?If you are using a terminal (e.g. HyperTerminal) that supports
command line and the end of the command line.
Scripting and Non-Interactive Mode
The CLI may be called non-interactively by using a “-c” parameter:
cli-base –c
This may be used to create shell scripts that call a series of commands, such as:
cli-base –c vlan add 1 1-8
cli-base –c vlan add 2 9-16
cli-base –c vlan pvid 1-8 1
cli-base –c vlan pvid 9-16 2
cli-base –c vlan aware all enable
The “cli-fabric” utility may also be used as shown above.
Terminology
The following table shows general parameter types used in command syntaxes and descriptions.
ports on the switch.
individual ports or a range of ports. The keyword ‘none’ can be used to specify an
empty port list. The keyword ‘all’ can be used to specify all ports.
Example: 1,3,8-12
“hhhhhhhhhhhh”. The hh is Hexadecimal number in the range 0x00 to 0xFF.
Example: 00-00-24-F1-02-03
specify an empty VLAN ID list.
Example: 1,2,4-6
2 queues: low|high
4 queues: low|normal|medium|high
The
vlan add 1 1-8
vlan add 2 9-16
vlan pvid 1-8 1
vlan pvid 9-16 2
vlan aware all enable
Base Switch Port Mapping for CLI
The following table shows the relationship between the external connections for each channel of the Base switch and the port numbering used by its command line interface.
External Connection
CLI Port Number Logical Slot
Connection
Port 1 ShMC 1 Base Channel 1
Port 2 Slot 1 / 2 Base Channel 2
Port 3 Slot 3 Base Channel 3
Port 4 Slot 4 Base Channel 4
Port 5 Slot 5 Base Channel 5
Port 6 Slot 6 Base Channel 6
Port 7 Slot 7 Base Channel 7
Port 8 Slot 8 Base Channel 8
Port 9 Slot 9 Base Channel 9
Port 10 Slot 10 Base Channel 10
Port 11 Slot 11 Base Channel 11
Port 12 Slot 12 Base Channel 12
Port 13 Slot 13 Base Channel 13
Port 14 Slot 14 Base Channel 14
Port 15 Slot 15 / ShMC 2 Base Channel 15
Port 16 CPU Payload CPU
Port 17 Front Panel Base 1 External Port 1
Port 18 Front Panel Base 2 External Port 2
Port 19 Front Panel Base 3 External Port 3
Port 20 Front Panel Base 4 External Port 4
Port 21 Front Panel Base 5 External Port 5
Port 22 Front Panel Base 6 External Port 6
Port 23 Front Panel Base 7 External Port 7
Port 24 Front Panel Base 8 External Port 8
Fabric Switch Port Mapping for CLI
The following table shows the relationship between the external connections for each channel of the Base switch and the port numbering used by its command line interface. CLI Port Number Logical Slot
External Connection
Connection
Port 1 Front Panel Base 1 External Port 1
Port 2 Front Panel Base 2 External Port 2
Port 3 Slot 3 Fabric Channel 3
Port 4 Slot 4 Fabric Channel 4
Port 5 Slot 5 Fabric Channel 5
Port 6 Slot 6 Fabric Channel 6
Port 7 Slot 7 Fabric Channel 7
Port 8 Slot 8 Fabric Channel 8
Port 9 Slot 9 Fabric Channel 9
Port 10 Slot 10 Fabric Channel 10
Port 11 Slot 11 Fabric Channel 11
Port 12 Slot 12 Fabric Channel 12
Port 13 Slot 13 Fabric Channel 13
Port 14 Slot 14 Fabric Channel 14
Port 15 Slot 15 Fabric Channel 15
Port 16 Slot 1 or 2 Fabric Channel 1
Command Overview
?
Help
Up
Exit
System Configuration [all|check]
System Restore Default [keepIP]
System IP Configuration
System IP Setup [
IP Configuration
IP Address Add
IP Address Delete
IP Address Lookup [
IP Route Add
IP Route Delete
IP Route Lookup [
IP Statistics [
Port Configuration [
Port Mode [
Port Flow Control [
Port State [
Port Statistics [
MAC Configuration [
MAC Add
MAC Delete
MAC Lookup
MAC Dump [
MAC Port [
MAC Flush
MAC Agetime [
VLAN Configuration [
VLAN State [enable|disable]
VLAN Add
VLAN Delete
VLAN Lookup
VLAN Aware [
VLAN PVID [
VLAN Frame Type [
VLAN IngressFilter [
PVLAN Configuration [check]
PVLAN Add
PVLAN Delete
PVLAN Lookup
Aggr Configuration [check]
Aggr Add
Aggr Delete
Aggr Lookup
Aggr Mode [
Lacp Configuration
Lacp Sysprio
Lacp Sysid
Lacp Mode [
Lacp Key [
Lacp Portprio [
Lacp Xmitmode [
Lacp Role [
Lacp Status
QoS Configuration [
QoS Classes [
QoS Mode
QoS Default [
QoS Tagprio [
QoS Tosprecedence
QoS DiffServ [
QoS L4 Match [
QoS L4 Add
QoS L4 Delete
QoS L4 List
QoS Userprio
QoS Shaper [
QoS Policer [
QoS Storm Control [
Mirror Configuration [check]
Mirror Port [
Mirror Source [
Mirror Destination [
Debug Register Read
Debug Register Write
Debug PHY Read
Debug PHY Write
Debug MMD Read
Debug MMD Write
Debug Option
Debug Suspend
Debug Resume
Debug Terminate
Debug CPU Statistics [clear]
Debug CPU Tx
Debug STP [
Debug MSTP Instance [
Debug MSTP State [
Debug IPMC Add
Debug IPMC Delete
Debug VRRP Base
Debug VRRP Add
Debug VRRP Delete
Command Description
Some of the commands have optional parameters. If the optional parameter is omitted, a default value may be used or the command may display the current setting (i.e. function as a get command).
Example 1, omitted parameters interpreted as a display command for all ports: Syntax:
Port flow control [
>port flow control
Example 2, omitted parameter interpreted as default value (VLAN ID 1):
Syntax:
MAC Add
>mac add 010203ABCDEF 16
Configuration Files
The switch configurations for the base and fabric are preserved in switch.conf files under /etc/switch. Settings modified with the CLI are saved and restored from these files when the OS reboots or when the switch software is restarted.
The following sections list the individual commands by showing the syntax and a description of each command.
System Commands
System Configuration
Syntax:
System Configuration [all|check]
Description:
Show system name, software version, hardware version and management MAC address. [all] : Show the full switch configuration (default: System configuration only) [check]: Inspect system configuration settings and report if inconsistency is found
System Restore Default
Syntax:
System Restore Default [keepIP]
Description:
Restore factory default configuration. [keepIP] preserves System/IP settings for the Ethernet TAP interface (default: Not preserved).
System/IP Commands
Display and configure IP address, mask, gateway, VLAN, and mode of the Ethernet TAP interface.
System IP Configuration
Syntax:
System IP Configuration [check]
Description:
Show configured IP address, mask, gateway, VLAN ID, and mode. Optionally [check] settings and report if inconsistency is found.
System IP Setup
Syntax:
System IP Setup [
Set or show IP configuration.
[
[
[
[
System IP Mode
Syntax:
System IP Mode [enable|disable]
Description:
Activate or deactivate the Ethernet TAP interface with the configured system IP settings. Note:
Linux services for the switch such as DHCP require the Ethernet TAP interface be configured and enabled.
IP Commands
IP Configuration
Syntax:
IP Configuration
Description:
Show IP configuration.
IP Address Add
Syntax:
IP Address Add
Description:
Defines a router leg IP address. Maps the IP subnet to a VLAN. The VLAN represents a group of ports.
(IP v.4 address in the ddd.ddd.ddd.ddd format, e.g 192.168.1.1)
(subnet mask in the ddd.ddd.ddd.ddd format, e.g. 255.255.255.0)
IP Address Delete
Syntax:
IP Address Delete
Description:
Removes the IP address from the router instance data base. Also clear the IP subnet to VLAN mapping. The VLAN is not affected.
(IP v.4 address in the ddd.ddd.ddd.ddd format, e.g 192.168.1.1)
all : Remove all IP addresses
IP Address Lookup
Syntax:
IP Address Lookup [
Description:
Searches the IP address in the router instance data base.
The corresponding subnet and VLAN ID are returned.
[
(IP v.4 address in the ddd.ddd.ddd.ddd format, e.g 192.168.1.1)